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
|
# 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
"""
Parameter system for command plugins.
"""
from plugable import ReadOnly, lock, check_name
from constants import NULLS
def parse_param_spec(spec):
"""
Parse a param spec into to (name, kw).
The ``spec`` string determines the param name, whether the param is
required, and whether the param is multivalue according the following
syntax:
====== ===== ======== ==========
Spec Name Required Multivalue
====== ===== ======== ==========
'var' 'var' True False
'var?' 'var' False False
'var*' 'var' False True
'var+' 'var' True True
====== ===== ======== ==========
For example,
>>> parse_param_spec('login')
('login', {'required': True, 'multivalue': False})
>>> parse_param_spec('gecos?')
('gecos', {'required': False, 'multivalue': False})
>>> parse_param_spec('telephone_numbers*')
('telephone_numbers', {'required': False, 'multivalue': True})
>>> parse_param_spec('group+')
('group', {'required': True, 'multivalue': True})
:param spec: A spec string.
"""
if type(spec) is not str:
raise_TypeError(spec, str, 'spec')
if len(spec) < 2:
raise ValueError(
'param spec must be at least 2 characters; got %r' % spec
)
_map = {
'?': dict(required=False, multivalue=False),
'*': dict(required=False, multivalue=True),
'+': dict(required=True, multivalue=True),
}
end = spec[-1]
if end in _map:
return (spec[:-1], _map[end])
return (spec, dict(required=True, multivalue=False))
class Param(ReadOnly):
"""
Base class for all IPA types.
"""
__kwargs = dict(
cli_name=(str, None),
doc=(str, ''),
required=(bool, True),
multivalue=(bool, False),
primary_key=(bool, False),
normalize=(callable, None),
default=(None, None),
default_from=(callable, None),
flags=(frozenset, frozenset()),
)
def __init__(self, name, **overrides):
self.param_spec = name
self.name = check_name(name)
lock(self)
def normalize(self, value):
"""
"""
if self.__normalize is None:
return value
if self.multivalue:
if type(value) in (tuple, list):
return tuple(
self.__normalize_scalar(v) for v in value
)
return (self.__normalize_scalar(value),) # Return a tuple
return self.__normalize_scalar(value)
def __normalize_scalar(self, value):
"""
Normalize a scalar value.
This method is called once for each value in multivalue.
"""
if type(value) is not unicode:
return value
try:
return self.__normalize(value)
except StandardError:
return value
def convert(self, value):
if value in NULLS:
return
if self.multivalue:
if type(value) in (tuple, list):
values = filter(
lambda val: val not in NULLS,
(self._convert_scalar(v, i) for (i, v) in enumerate(value))
)
if len(values) == 0:
return
return tuple(values)
return (scalar(value, 0),) # Return a tuple
return scalar(value)
def _convert_scalar(self, value, index=None):
"""
Implement in subclass.
"""
raise NotImplementedError(
'%s.%s()' % (self.__class__.__name__, '_convert_scalar')
)
class Bool(Param):
"""
"""
class Int(Param):
"""
"""
class Float(Param):
"""
"""
class Bytes(Param):
"""
"""
class Str(Param):
"""
"""
def __init__(self, name, **overrides):
self.type = unicode
super(Str, self).__init__(name, **overrides)
def _convert_scalar(self, value, index=None):
if type(value) in (self.type, int, float, bool):
return self.type(value)
raise TypeError(
'Can only implicitly convert int, float, or bool; got %r' % value
)
|
