author | Sylvain Thénault <sylvain.thenault@logilab.fr> |
Thu, 23 Sep 2010 23:24:42 +0200 | |
branch | stable |
changeset 6331 | e4dba8ae9637 |
parent 6246 | 62e25fac41cd |
child 6899 | e592fb8ee27b |
permissions | -rw-r--r-- |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
1 |
# copyright 2003-2010 LOGILAB S.A. (Paris, FRANCE), all rights reserved. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
2 |
# contact http://www.logilab.fr/ -- mailto:contact@logilab.fr |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
3 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
4 |
# This file is part of CubicWeb. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
5 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
6 |
# CubicWeb is free software: you can redistribute it and/or modify it under the |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
7 |
# terms of the GNU Lesser General Public License as published by the Free |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
8 |
# Software Foundation, either version 2.1 of the License, or (at your option) |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
9 |
# any later version. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
10 |
# |
5424
8ecbcbff9777
replace logilab-common by CubicWeb in disclaimer
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5421
diff
changeset
|
11 |
# CubicWeb is distributed in the hope that it will be useful, but WITHOUT |
5421
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
12 |
# ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
13 |
# FOR A PARTICULAR PURPOSE. See the GNU Lesser General Public License for more |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
14 |
# details. |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
15 |
# |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
16 |
# You should have received a copy of the GNU Lesser General Public License along |
8167de96c523
proper licensing information (LGPL-2.1). Hope I get it right this time.
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
5314
diff
changeset
|
17 |
# with CubicWeb. If not, see <http://www.gnu.org/licenses/>. |
4931
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
18 |
""" |
5314
86e5abbebfaf
[doc/book] refresh the autoform section with uicfg content (moved there)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4931
diff
changeset
|
19 |
A RelationTag object is an object which allows to link a configuration |
86e5abbebfaf
[doc/book] refresh the autoform section with uicfg content (moved there)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4931
diff
changeset
|
20 |
information to a relation definition. For instance, the standard |
86e5abbebfaf
[doc/book] refresh the autoform section with uicfg content (moved there)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4931
diff
changeset
|
21 |
primary view uses a RelationTag object (uicfg.primaryview_section) to |
86e5abbebfaf
[doc/book] refresh the autoform section with uicfg content (moved there)
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
4931
diff
changeset
|
22 |
get the section to display relations. |
4931
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
23 |
|
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
24 |
.. sourcecode:: python |
1152 | 25 |
|
4931
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
26 |
# display ``entry_of`` relations in the ``relations`` section in the ``BlogEntry`` primary view |
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
27 |
uicfg.primaryview_section.tag_subject_of(('BlogEntry', 'entry_of', '*'), |
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
28 |
'relations') |
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
29 |
|
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
30 |
# hide every relation ``entry_of`` in the ``Blog`` primary view |
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
31 |
uicfg.primaryview_section.tag_object_of(('*', 'entry_of', 'Blog'), 'hidden') |
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
32 |
|
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
33 |
Three primitives are defined: |
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
34 |
* ``tag_subject_of`` tag a relation in the subject's context |
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
35 |
* ``tag_object_of`` tag a relation in the object's context |
92c9d0a5dc11
improve documentation for uicfg and rtags
Stephanie Marcu <stephanie.marcu@logilab.fr>
parents:
4391
diff
changeset
|
36 |
* ``tag_attribute`` shortcut for tag_subject_of |
1152 | 37 |
""" |
38 |
__docformat__ = "restructuredtext en" |
|
1148
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
39 |
|
1740
2292ae32c98f
warn and drop rtags not in schema, this may be intentional; drop possibility to not specify value for bool rtags
sylvain.thenault@logilab.fr
parents:
1739
diff
changeset
|
40 |
import logging |
2292ae32c98f
warn and drop rtags not in schema, this may be intentional; drop possibility to not specify value for bool rtags
sylvain.thenault@logilab.fr
parents:
1739
diff
changeset
|
41 |
|
2292ae32c98f
warn and drop rtags not in schema, this may be intentional; drop possibility to not specify value for bool rtags
sylvain.thenault@logilab.fr
parents:
1739
diff
changeset
|
42 |
from logilab.common.logging_ext import set_log_methods |
2292ae32c98f
warn and drop rtags not in schema, this may be intentional; drop possibility to not specify value for bool rtags
sylvain.thenault@logilab.fr
parents:
1739
diff
changeset
|
43 |
|
1752
4b0b912ff5b7
fix rtags initialization: do it at the registry level to avoid multiple initialization of the same rtag
sylvain.thenault@logilab.fr
parents:
1748
diff
changeset
|
44 |
RTAGS = [] |
4b0b912ff5b7
fix rtags initialization: do it at the registry level to avoid multiple initialization of the same rtag
sylvain.thenault@logilab.fr
parents:
1748
diff
changeset
|
45 |
def register_rtag(rtag): |
4b0b912ff5b7
fix rtags initialization: do it at the registry level to avoid multiple initialization of the same rtag
sylvain.thenault@logilab.fr
parents:
1748
diff
changeset
|
46 |
RTAGS.append(rtag) |
1533 | 47 |
|
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
48 |
def _ensure_str_key(key): |
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
49 |
return tuple(str(k) for k in key) |
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
50 |
|
1148
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
51 |
class RelationTags(object): |
1533 | 52 |
"""a tag store for full relation definitions : |
1148
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
53 |
|
1533 | 54 |
(subject type, relation type, object type, tagged) |
1152 | 55 |
|
56 |
allowing to set tags using wildcard (eg '*') as subject type / object type |
|
57 |
||
1533 | 58 |
This class associates a single tag to each key. |
1152 | 59 |
""" |
1739 | 60 |
_allowed_values = None |
3473
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
61 |
_initfunc = None |
1849
1901fa97f521
give a name to rtags instance to ease debugging
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1769
diff
changeset
|
62 |
def __init__(self, name=None, initfunc=None, allowed_values=None): |
1901fa97f521
give a name to rtags instance to ease debugging
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1769
diff
changeset
|
63 |
self._name = name or '<unknown>' |
1148
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
64 |
self._tagdefs = {} |
1739 | 65 |
if allowed_values is not None: |
66 |
self._allowed_values = allowed_values |
|
3473
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
67 |
if initfunc is not None: |
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
68 |
self._initfunc = initfunc |
1752
4b0b912ff5b7
fix rtags initialization: do it at the registry level to avoid multiple initialization of the same rtag
sylvain.thenault@logilab.fr
parents:
1748
diff
changeset
|
69 |
register_rtag(self) |
1769
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
70 |
|
1528
864ae7c15ef5
other fixlets
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1451
diff
changeset
|
71 |
def __repr__(self): |
1849
1901fa97f521
give a name to rtags instance to ease debugging
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1769
diff
changeset
|
72 |
return '%s: %s' % (self._name, repr(self._tagdefs)) |
1528
864ae7c15ef5
other fixlets
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
1451
diff
changeset
|
73 |
|
1533 | 74 |
# dict compat |
75 |
def __getitem__(self, key): |
|
76 |
return self.get(*key) |
|
77 |
__contains__ = __getitem__ |
|
1451 | 78 |
|
2689
44f041222d0f
[autoreload] handle uicfg reloading properly with the new event / callback mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2369
diff
changeset
|
79 |
def clear(self): |
44f041222d0f
[autoreload] handle uicfg reloading properly with the new event / callback mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2369
diff
changeset
|
80 |
self._tagdefs.clear() |
44f041222d0f
[autoreload] handle uicfg reloading properly with the new event / callback mechanism
Adrien Di Mascio <Adrien.DiMascio@logilab.fr>
parents:
2369
diff
changeset
|
81 |
|
1739 | 82 |
def _get_keys(self, stype, rtype, otype, tagged): |
5843
85c4d5334f2c
[refactor] refactor rtag keys generations.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
5424
diff
changeset
|
83 |
keys = [] |
85c4d5334f2c
[refactor] refactor rtag keys generations.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
5424
diff
changeset
|
84 |
if '*' not in (stype, otype): |
85c4d5334f2c
[refactor] refactor rtag keys generations.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
5424
diff
changeset
|
85 |
keys.append(('*', rtype, '*', tagged)) |
85c4d5334f2c
[refactor] refactor rtag keys generations.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
5424
diff
changeset
|
86 |
if '*' != stype: |
85c4d5334f2c
[refactor] refactor rtag keys generations.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
5424
diff
changeset
|
87 |
keys.append(('*', rtype, otype, tagged)) |
85c4d5334f2c
[refactor] refactor rtag keys generations.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
5424
diff
changeset
|
88 |
if '*' != otype: |
85c4d5334f2c
[refactor] refactor rtag keys generations.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
5424
diff
changeset
|
89 |
keys.append((stype, rtype, '*', tagged)) |
85c4d5334f2c
[refactor] refactor rtag keys generations.
Pierre-Yves David <pierre-yves.david@logilab.fr>
parents:
5424
diff
changeset
|
90 |
keys.append((stype, rtype, otype, tagged)) |
1533 | 91 |
return keys |
1451 | 92 |
|
1769
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
93 |
def init(self, schema, check=True): |
1739 | 94 |
# XXX check existing keys against schema |
1769
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
95 |
if check: |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
96 |
for (stype, rtype, otype, tagged), value in self._tagdefs.items(): |
1769
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
97 |
for ertype in (stype, rtype, otype): |
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
98 |
if ertype != '*' and not ertype in schema: |
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
99 |
self.warning('removing rtag %s: %s, %s undefined in schema', |
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
100 |
(stype, rtype, otype, tagged), value, ertype) |
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
101 |
self.del_rtag(stype, rtype, otype, tagged) |
fb91d2b8a441
fix some rtags pb on i18n catalog generation
sylvain.thenault@logilab.fr
parents:
1752
diff
changeset
|
102 |
break |
1739 | 103 |
if self._initfunc is not None: |
4364
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
104 |
self.apply(schema, self._initfunc) |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
105 |
|
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
106 |
def apply(self, schema, func): |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
107 |
for eschema in schema.entities(): |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
108 |
for rschema, tschemas, role in eschema.relation_definitions(True): |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
109 |
for tschema in tschemas: |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
110 |
if role == 'subject': |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
111 |
sschema, oschema = eschema, tschema |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
112 |
else: |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
113 |
sschema, oschema = tschema, eschema |
766359c69f2f
[uicfg] fix autoform_section rtags initialization
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4339
diff
changeset
|
114 |
func(self, sschema, rschema, oschema, role) |
1739 | 115 |
|
116 |
# rtag declaration api #################################################### |
|
117 |
||
3473
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
118 |
def tag_attribute(self, key, *args, **kwargs): |
1739 | 119 |
key = list(key) |
120 |
key.append('*') |
|
4339
fe93b670343d
some fixes so that deprecation warning are properly localized
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
121 |
key.append('subject') |
fe93b670343d
some fixes so that deprecation warning are properly localized
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4252
diff
changeset
|
122 |
self.tag_relation(key, *args, **kwargs) |
1548
bd225e776739
new tag_attribute convenience method
sylvain.thenault@logilab.fr
parents:
1533
diff
changeset
|
123 |
|
3473
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
124 |
def tag_subject_of(self, key, *args, **kwargs): |
1739 | 125 |
key = list(key) |
126 |
key.append('subject') |
|
3473
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
127 |
self.tag_relation(key, *args, **kwargs) |
1739 | 128 |
|
3473
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
129 |
def tag_object_of(self, key, *args, **kwargs): |
1739 | 130 |
key = list(key) |
131 |
key.append('object') |
|
3473
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
132 |
self.tag_relation(key, *args, **kwargs) |
1533 | 133 |
|
1739 | 134 |
def tag_relation(self, key, tag): |
4391
bd8480824e0b
ensure we get a correct key
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
4364
diff
changeset
|
135 |
assert len(key) == 4, 'bad key: %s' % list(key) |
1739 | 136 |
if self._allowed_values is not None: |
1859
b068abd45a1c
nicer error message
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1849
diff
changeset
|
137 |
assert tag in self._allowed_values, \ |
b068abd45a1c
nicer error message
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1849
diff
changeset
|
138 |
'%r is not an allowed tag (should be in %s)' % ( |
b068abd45a1c
nicer error message
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1849
diff
changeset
|
139 |
tag, self._allowed_values) |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
140 |
self._tagdefs[_ensure_str_key(key)] = tag |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
141 |
return tag |
1533 | 142 |
|
1739 | 143 |
# rtag runtime api ######################################################## |
144 |
||
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
145 |
def del_rtag(self, *key): |
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
146 |
del self._tagdefs[key] |
1739 | 147 |
|
3473
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
148 |
def get(self, *key): |
d8bc02158efc
[rtags] ease overriding
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
3472
diff
changeset
|
149 |
for key in reversed(self._get_keys(*key)): |
1148
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
150 |
try: |
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
151 |
return self._tagdefs[key] |
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
152 |
except KeyError: |
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
153 |
continue |
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
154 |
return None |
1451 | 155 |
|
1721
694f6a50e138
final rtags api (eventually :$)
sylvain.thenault@logilab.fr
parents:
1548
diff
changeset
|
156 |
def etype_get(self, etype, rtype, role, ttype='*'): |
694f6a50e138
final rtags api (eventually :$)
sylvain.thenault@logilab.fr
parents:
1548
diff
changeset
|
157 |
if role == 'subject': |
694f6a50e138
final rtags api (eventually :$)
sylvain.thenault@logilab.fr
parents:
1548
diff
changeset
|
158 |
return self.get(etype, rtype, ttype, role) |
694f6a50e138
final rtags api (eventually :$)
sylvain.thenault@logilab.fr
parents:
1548
diff
changeset
|
159 |
return self.get(ttype, rtype, etype, role) |
1533 | 160 |
|
161 |
||
1451 | 162 |
|
1533 | 163 |
class RelationTagsSet(RelationTags): |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
164 |
"""This class associates a set of tags to each key. |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
165 |
""" |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
166 |
tag_container_cls = set |
1533 | 167 |
|
1739 | 168 |
def tag_relation(self, key, tag): |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
169 |
rtags = self._tagdefs.setdefault(_ensure_str_key(key), |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
170 |
self.tag_container_cls()) |
1148
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
171 |
rtags.add(tag) |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
172 |
return rtags |
1451 | 173 |
|
1739 | 174 |
def get(self, stype, rtype, otype, tagged): |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
175 |
rtags = self.tag_container_cls() |
1721
694f6a50e138
final rtags api (eventually :$)
sylvain.thenault@logilab.fr
parents:
1548
diff
changeset
|
176 |
for key in self._get_keys(stype, rtype, otype, tagged): |
1148
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
177 |
try: |
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
178 |
rtags.update(self._tagdefs[key]) |
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
179 |
except KeyError: |
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
180 |
continue |
55a8238f8f7c
keep notion of relation tags, tough with simplier implementation and usage
sylvain.thenault@logilab.fr
parents:
diff
changeset
|
181 |
return rtags |
1739 | 182 |
|
183 |
||
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
184 |
class RelationTagsDict(RelationTagsSet): |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
185 |
"""This class associates a set of tags to each key.""" |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
186 |
tag_container_cls = dict |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
187 |
|
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
188 |
def tag_relation(self, key, tag): |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
189 |
key = _ensure_str_key(key) |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
190 |
try: |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
191 |
rtags = self._tagdefs[key] |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
192 |
rtags.update(tag) |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
193 |
return rtags |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
194 |
except KeyError: |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
195 |
self._tagdefs[key] = tag |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
196 |
return tag |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
197 |
|
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
198 |
def setdefault(self, key, tagkey, tagvalue): |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
199 |
key = _ensure_str_key(key) |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
200 |
try: |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
201 |
rtags = self._tagdefs[key] |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
202 |
rtags.setdefault(tagkey, tagvalue) |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
203 |
return rtags |
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
204 |
except KeyError: |
3472
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
205 |
self._tagdefs[key] = {tagkey: tagvalue} |
5345570eefc6
[rtags] make internal key order consistent with api
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
2689
diff
changeset
|
206 |
return self._tagdefs[key] |
2369
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
207 |
|
5a2b8ed266ca
new RelationTagsDict class, use it in uicfg where necessary
Sylvain Thénault <sylvain.thenault@logilab.fr>
parents:
1977
diff
changeset
|
208 |
|
1739 | 209 |
class RelationTagsBool(RelationTags): |
210 |
_allowed_values = frozenset((True, False)) |
|
211 |
||
212 |
||
6246
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
213 |
class NoTargetRelationTagsDict(RelationTagsDict): |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
214 |
|
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
215 |
@property |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
216 |
def name(self): |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
217 |
return self.__class__.name |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
218 |
|
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
219 |
def tag_subject_of(self, key, tag): |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
220 |
subj, rtype, obj = key |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
221 |
if obj != '*': |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
222 |
self.warning('using explict target type in %s.tag_subject_of() ' |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
223 |
'has no effect, use (%s, %s, "*") instead of (%s, %s, %s)', |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
224 |
self.name, subj, rtype, subj, rtype, obj) |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
225 |
super(NoTargetRelationTagsDict, self).tag_subject_of((subj, rtype, '*'), tag) |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
226 |
|
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
227 |
def tag_object_of(self, key, tag): |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
228 |
subj, rtype, obj = key |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
229 |
if subj != '*': |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
230 |
self.warning('using explict subject type in %s.tag_object_of() ' |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
231 |
'has no effect, use ("*", %s, %s) instead of (%s, %s, %s)', |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
232 |
self.name, rtype, obj, subj, rtype, obj) |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
233 |
super(NoTargetRelationTagsDict, self).tag_object_of(('*', rtype, obj), tag) |
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
234 |
|
62e25fac41cd
[views/reledit] refactor composite handling
Aurelien Campeas <aurelien.campeas@logilab.fr>
parents:
6240
diff
changeset
|
235 |
|
1740
2292ae32c98f
warn and drop rtags not in schema, this may be intentional; drop possibility to not specify value for bool rtags
sylvain.thenault@logilab.fr
parents:
1739
diff
changeset
|
236 |
set_log_methods(RelationTags, logging.getLogger('cubicweb.rtags')) |