1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
|
# Authors:
# Jason Gerard DeRose <jderose@redhat.com>
#
# Copyright (C) 2008 Red Hat
# see file 'COPYING' for use and warranty information
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License as
# published by the Free Software Foundation; version 2 only
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 59 Temple Place, Suite 330, Boston, MA 02111-1307 USA
"""
Base classes for the public plugable.API instance, which the XML-RPC, CLI,
and UI all use.
"""
import re
import plugable
import errors
RULE_FLAG = 'validation_rule'
def rule(obj):
assert not hasattr(obj, RULE_FLAG)
setattr(obj, RULE_FLAG, True)
return obj
def is_rule(obj):
return callable(obj) and getattr(obj, RULE_FLAG, False) is True
class opt(plugable.ReadOnly):
__public__ = frozenset((
'normalize',
'validate',
'default',
'required',
'type',
))
__rules = None
def normalize(self, value):
try:
return self.type(value)
except (TypeError, ValueError):
raise errors.NormalizationError(
self.__class__.__name__, value, self.type
)
def __get_rules(self):
if self.__rules is None:
rules = sorted(
self.__rules_iter(),
key=lambda f: getattr(f, '__name__'),
)
object.__setattr__(self, '_opt__rules', tuple(rules))
return self.__rules
rules = property(__get_rules)
def __rules_iter(self):
for name in dir(self.__class__):
if name.startswith('_'):
continue
base_attr = getattr(self.__class__, name)
if is_rule(base_attr):
attr = getattr(self, name)
if is_rule(attr):
yield attr
def validate(self, value):
for rule in self.rules:
msg = rule(value)
if msg is None:
continue
raise errors.RuleError(
self.__class__.__name__,
value,
rule,
msg,
)
class cmd(plugable.Plugin):
__public__ = frozenset((
'normalize',
'autofill',
'__call__',
'get_doc',
'opt',
))
__opt = None
def get_doc(self, _):
"""
Returns the gettext translated doc-string for this command.
For example:
>>> def get_doc(self, _):
>>> return _('add new user')
"""
raise NotImplementedError('%s.get_doc()' % self.name)
def get_options(self):
"""
Returns iterable with opt_proxy objects used to create the opt
NameSpace when __get_opt() is called.
"""
raise NotImplementedError('%s.get_options()' % self.name)
def __get_opt(self):
"""
Returns the NameSpace containing opt_proxy objects.
"""
if self.__opt is None:
self.__opt = plugable.NameSpace(self.get_options())
return self.__opt
opt = property(__get_opt)
def __call__(self, *args, **kw):
(args, kw) = self.normalize(*args, **kw)
(args, kw) = self.autofill(*args, **kw)
self.validate(*args, **kw)
class obj(plugable.Plugin):
__public__ = frozenset((
'mthd',
'prop',
))
__mthd = None
__prop = None
def __get_mthd(self):
return self.__mthd
mthd = property(__get_mthd)
def __get_prop(self):
return self.__prop
prop = property(__get_prop)
def finalize(self, api):
super(obj, self).finalize(api)
self.__mthd = self.__create_ns('mthd')
self.__prop = self.__create_ns('prop')
def __create_ns(self, name):
return plugable.NameSpace(self.__filter(name))
def __filter(self, name):
for i in getattr(self.api, name):
if i.obj_name == self.name:
yield i._clone('attr_name')
class attr(plugable.Plugin):
__obj = None
def __init__(self):
m = re.match('^([a-z]+)_([a-z]+)$', self.__class__.__name__)
assert m
self.__obj_name = m.group(1)
self.__attr_name = m.group(2)
def __get_obj_name(self):
return self.__obj_name
obj_name = property(__get_obj_name)
def __get_attr_name(self):
return self.__attr_name
attr_name = property(__get_attr_name)
def __get_obj(self):
"""
Returns the obj instance this attribute is associated with, or None
if no association has been set.
"""
return self.__obj
obj = property(__get_obj)
def finalize(self, api):
super(attr, self).finalize(api)
self.__obj = api.obj[self.obj_name]
class mthd(attr, cmd):
__public__ = frozenset((
'obj',
'obj_name',
))
class prop(attr):
__public__ = frozenset((
'obj',
'obj_name',
))
def get_doc(self, _):
return _('prop doc')
class PublicAPI(plugable.API):
__max_cmd_len = None
def __init__(self):
super(PublicAPI, self).__init__(cmd, obj, mthd, prop)
def __get_max_cmd_len(self):
if self.__max_cmd_len is None:
if not hasattr(self, 'cmd'):
return None
max_cmd_len = max(len(str(cmd)) for cmd in self.cmd)
object.__setattr__(self, '_PublicAPI__max_cmd_len', max_cmd_len)
return self.__max_cmd_len
max_cmd_len = property(__get_max_cmd_len)
|
