Xc @ s d Z d d k Z d d k Z d d k Z d d k Z d d k l Z l Z d d k l Z d d k
l Z d d k
l Z l Z l Z d d k l Z l Z l Z d d k l Z l Z d d k l Z l Z l Z d d
k
l Z l Z d d k l Z d d k l Z d
e f d YZ! d Z" e# Z$ d Z d e f d YZ% d e% f d YZ& d e& f d YZ' d e% f d YZ( d e( f d YZ) d e( f d YZ* d e% f d YZ+ d e+ f d YZ, d! e+ f d" YZ- d# e- f d$ YZ. d% e- f d& YZ/ d' e% f d( YZ0 d) e0 f d* YZ1 d+ e0 f d, YZ2 d- e% f d. YZ3 d/ e- f d0 YZ4 d1 e- f d2 YZ5 d3 e% f d4 YZ6 d5 e3 f d6 YZ7 d7 Z8 d S(8 s7
Parameter system for command plugins.
A `Param` instance can be used to describe an argument or option that a command
takes, or an attribute that a command returns. The `Param` base class is not
used directly, but there are many subclasses for specific Python data types
(like `Str` or `Int`) and specific properties (like `Password`).
To create a `Param` instance, you must always provide the parameter *name*,
which should be the LDAP attribute name if the parameter describes the attribute
of an LDAP entry. For example, we could create an `Str` instance describing the user's last-name attribute like this:
>>> from ipalib import Str
>>> sn = Str('sn')
>>> sn.name
'sn'
When creating a `Param`, there are also a number of optional kwargs which
which can provide additional meta-data and functionality. For example, every
parameter has a *cli_name*, the name used on the command-line-interface. By
default the *cli_name* is the same as the *name*:
>>> sn.cli_name
'sn'
But often the LDAP attribute name isn't user friendly for the command-line, so
you can override this with the *cli_name* kwarg:
>>> sn = Str('sn', cli_name='last')
>>> sn.name
'sn'
>>> sn.cli_name
'last'
Note that the RPC interfaces (and the internal processing pipeline) always use
the parameter *name*, regardless of what the *cli_name* might be.
A `Param` also has two translatable kwargs: *label* and *doc*. These must both
be `Gettext` instances. They both default to a place-holder `FixMe` instance,
a subclass of `Gettext` used to mark a missing translatable string:
>>> sn.label
FixMe('sn')
>>> sn.doc
FixMe('sn')
The *label* is a short phrase describing the parameter. It's used on the CLI
when interactively prompting for values, and as a label for form inputs in the
web-UI. The *label* should start with an initial capital. For example:
>>> from ipalib import _
>>> sn = Str('sn',
... cli_name='last',
... label=_('Last name'),
... )
>>> sn.label
Gettext('Last name', domain='ipa', localedir=None)
The *doc* is a longer description of the parameter. It's used on the CLI when
displaying the help information for a command, and as extra instruction for a
form input on the web-UI. By default the *doc* is the same as the *label*:
>>> sn.doc
Gettext('Last name', domain='ipa', localedir=None)
But you can override this with the *doc* kwarg. Like the *label*, the *doc*
should also start with an initial capital and should not end with any
punctuation. For example:
>>> sn = Str('sn',
... cli_name='last',
... label=_('Last name'),
... doc=_("The user's last name"),
... )
>>> sn.doc
Gettext("The user's last name", domain='ipa', localedir=None)
Demonstration aside, you should always provide at least the *label* so the
various UIs are translatable. Only provide the *doc* if the parameter needs
a more detailed description for clarity.
iN( t MAXINTt MININT( t NoneType( t _( t ReadOnlyt lockt
check_name( t ConversionErrort RequirementErrort ValidationError( t PasswordMismatcht Base64DecodeError( t NULLSt
TYPE_ERRORt CALLABLE_ERROR( t Gettextt FixMe( t json_serialize( t DNt DefaultFromc B s) e Z d Z d Z d Z d Z RS( s
Derive a default value from other supplied values.
For example, say you wanted to create a default for the user's login from
the user's first and last names. It could be implemented like this:
>>> login = DefaultFrom(lambda first, last: first[0] + last)
>>> login(first='John', last='Doe')
'JDoe'
If you do not explicitly provide keys when you create a `DefaultFrom`
instance, the keys are implicitly derived from your callback by
inspecting ``callback.func_code.co_varnames``. The keys are available
through the ``DefaultFrom.keys`` instance attribute, like this:
>>> login.keys
('first', 'last')
The callback is available through the ``DefaultFrom.callback`` instance
attribute, like this:
>>> login.callback # doctest:+ELLIPSIS
at 0x...>
>>> login.callback.func_code.co_varnames # The keys
('first', 'last')
The keys can be explicitly provided as optional positional arguments after
the callback. For example, this is equivalent to the ``login`` instance
above:
>>> login2 = DefaultFrom(lambda a, b: a[0] + b, 'first', 'last')
>>> login2.keys
('first', 'last')
>>> login2.callback.func_code.co_varnames # Not the keys
('a', 'b')
>>> login2(first='John', last='Doe')
'JDoe'
If any keys are missing when calling your `DefaultFrom` instance, your
callback is not called and ``None`` is returned. For example:
>>> login(first='John', lastname='Doe') is None
True
>>> login() is None
True
Any additional keys are simply ignored, like this:
>>> login(last='Doe', first='John', middle='Whatever')
'JDoe'
As above, because `DefaultFrom.__call__` takes only pure keyword
arguments, they can be supplied in any order.
Of course, the callback need not be a ``lambda`` expression. This third
example is equivalent to both the ``login`` and ``login2`` instances
above:
>>> def get_login(first, last):
... return first[0] + last
...
>>> login3 = DefaultFrom(get_login)
>>> login3.keys
('first', 'last')
>>> login3.callback.func_code.co_varnames
('first', 'last')
>>> login3(first='John', last='Doe')
'JDoe'
c G s t | p# t t d | t | f n | | _ t | d j o> | i } | i d @o t d n | i | i
| _ n
| | _ xJ | i D]? } t | t j o& t t
d t | t | f q q Wt | d S( s
:param callback: The callable to call when all keys are present.
:param keys: Optional keys used for source values.
t callbacki i s3 callback: variable-length argument list not allowedt keysN( t callablet TypeErrorR t typeR t lent func_codet co_flagst
ValueErrort co_varnamest co_argcountR t strR
R ( t selfR R t fct key( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt __init__ s
'c C sC | i i f t d | i D } d | i i d i | f S( Nc s s x | ] } t | Vq Wd S( N( t repr( t .0t k( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pys s s %s(%s)s , ( R t __name__t tupleR t __class__t join( R t args( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt __repr__ s & c s\ t f d | i D } d | j o d Sy | i | SWn t j
o n Xd S( s
Call the callback if all keys are present.
If all keys are present, the callback is called and its return value is
returned. If any keys are missing, ``None`` is returned.
:param kw: The keyword arguments.
c 3 s% x | ] } i | d Vq Wd S( N( t gett None( R% R& ( t kw( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pys s N( R( R R. R t
StandardError( R R/ t vals( ( R/ s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt __call__ s
( R' t
__module__t __doc__R# R, R2 ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR v s E c C s t | t j o& t t d t | t | f n h t d t d t d 6t d t d t d 6t d t d t d 6} | d } | | j o | d | | f S| t d t d t f S( s
Parse shorthand ``spec`` into to ``(name, kw)``.
The ``spec`` string determines the parameter name, whether the parameter is
required, and whether the parameter 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.
t spect requiredt
multivaluet ?t *t +i( R R R R
t dictt Falset True( R5 t _mapt end( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt parse_param_spec s #
c C s t i | | S( N( t
__messagest add( t message( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s
t Paramc B s- e Z d Z e Z e d Z e d Z d e d4 f d e d4 f d e
e f d4 f d e
e f d4 f d e e
f d e e f d e e f d
e d4 f d e d4 f d e e f d
e e f d e e f d e d4 f d e d4 f d e e f d e e f d4 f d e e f d e d f d e e f d e d f d e e
f d e d4 f f Z d Z d Z d Z d Z d Z d Z d! Z d" Z d# Z d$ Z d% Z d& Z e! i" d' Z# d( Z$ d) Z% d* Z& d+ Z' d4 d, Z( d4 d4 d- Z) d4 d. Z* d/ Z+ d5 Z, d3 Z- RS(6 su
Base class for all parameters.
Param attributes:
=================
The behavior of Param class and subclasses can be controlled using the
following set of attributes:
- cli_name: option name in CLI
- cli_short_name: one character version of cli_name
- label: very short description of the parameter. This value is used in
when the Command output is printed to CLI or in a Command help
- doc: parameter long description used in help
- required: the parameter is marked as required for given Command
- multivalue: indicates if the attribute is multivalued
- primary_key: Command's parameter primary key is used for unique
identification of an LDAP object and for sorting
- normalizer: a custom function for Param value normalization
- default_from: a custom function for generating default values of
parameter instance
- autofill: by default, only `required` parameters get a default value
from the default_from function. When autofill is enabled, optional
attributes get the default value filled too
- query: this attribute is controlled by framework. When the `query`
is enabled, framework assumes that the value is only queried and not
inserted in the LDAP. Validation is then relaxed - custom
parameter validators are skipped and only basic class validators are
executed to check the parameter value
- attribute: this attribute is controlled by framework and enabled for
all LDAP objects parameters (unless parameter has "virtual_attribute"
flag). All parameters with enabled `attribute` are being encoded and
placed to an entry passed to LDAP Create/Update calls
- include: a list of contexts where this parameter should be included.
`Param.use_in_context()` provides further information.
- exclude: a list of contexts where this parameter should be excluded.
`Param.use_in_context()` provides further information.
- flags: there are several flags that can be used to further tune the
parameter behavior:
* no_display (Output parameters only): do not display the parameter
* no_create: do not include the parameter for crud.Create based
commands
* no_update: do not include the parameter for crud.update based
commands
* no_option: this attribute is not displayed in the CLI, usually
because there's a better way of setting it (for example, a
separate command)
* virtual_attribute: the parameter is not stored physically in the
LDAP and thus attribute `attribute` is not enabled
* suppress_empty (Output parameters only): do not display parameter
value when empty
* ask_create: CLI asks for parameter value even when the parameter
is not `required`. Applied for all crud.Create based commands
* ask_update: CLI asks for parameter value even when the parameter
is not `required`. Applied for all crud.Update based commands
* req_update: The parameter is `required` in all crud.Update based
commands
* nonempty: This is an internal flag; a required attribute should
be used instead of it.
The value of this parameter must not be empty, but it may
not be given at all. All crud.Update commands automatically
convert required parameters to `nonempty` ones, so the value
can be unspecified (unchanged) but cannot be deleted.
- hint: this attribute is currently not used
- alwaysask: when enabled, CLI asks for parameter value even when the
parameter is not `required`
- sortorder: used to sort a list of parameters for Command. See
`Command.finalize()` for further information
- csv: this multivalue attribute is given in CSV format
- csv_separator: character that separates values in CSV (comma by
default)
- csv_skipspace: if true, leading whitespace will be ignored in
individual CSV values
s incorrect types Only one value is allowedt cli_namet cli_short_namet labelt docR6 R7 t primary_keyt
normalizert default_fromt autofillt queryt attributet includet excludet flagst hintt alwaysaskt sortorderi t csvt
csv_separatort ,t
csv_skipspacet option_groupc O sv | | _ t | | _ t | t o
t | _ n
t | _ t | \ } } d | j o | d | d s c s s x | ] } | d Vq Wd S( i N( ( R% R[ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pys s s %s: takes no such kwargs: %ss , c s s x | ] } t | Vq Wd S( N( R$ ( R% R& ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pys s RE RG RH RK s' kwarg %r conflicts with attribute on %ss _rule_%ss$ %s: cannot have both %s=%r and %s=%rRO RP s& %s: cannot have csv without multivalues" %s: rules must be callable; got %ri s5 %s: cli_short_name can only be a single character: %s( (2 t
param_specR; t
_Param__kwt
isinstancet PasswordR= t passwordR< R@ R t nameR) R' t niceR- t kwargsR( R. R t sett
issupersetR R* t sortedR R R t _Param__clonekwt frozensett listR R
R t hasattrR t setattrt appendt getattrRE RO RP RU R7 t class_rulest rulesRM t all_rulesRF R R ( R Ra Ro R/ t kw_from_spect extrat dfRn R" t kindRZ t valuet rule_namet rule( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR# s
&# *
$$#$
&c C s# d | i i d i | i f S( sQ
Return an expresion that could construct this `Param` instance.
s %s(%s)s , ( R) R' R* t _Param__repr_iter( R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR,
s c c s t | i Vx | i D] } | i Vq Wxi t | i D]X } | i | } t | o t | d o
| i } n
t | } d | | f Vq: Wd S( NR' s %s=%s( R$ R\ Ro R' Rf R] R Rj ( R Rw R" Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt __repr_iter s
c K s | t j o | i | } n | i | i | } t | d o) | i | | i i d | i | j n | i | d | i | j | S( s$
One stop shopping.
t envt supplied( R t get_defaultt convertt normalizeRj t validateRz t contextRa ( R Ru R/ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR2 " s
) c C s! | i } | p
| i } n | S( s
Return the right name of an attribute depending on usage.
Normally errors should use cli_name, our "friendly" name. When
using the API directly or *attr return the real name.
( RE Ra ( R Ra ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt get_param_name0 s
c c s` xY t | i D]H } | i | } t | o t | d o
| i } n | | f Vq Wd S( sW
Iterate through ``(key,value)`` for all kwargs passed to constructor.
R' N( Rf R] R Rj R' ( R R" Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR/ < s
c C sF | i d j o | i | i j S| i d j o | i | i j St S( s
Return ``True`` if this parameter should be used in ``env.context``.
If a parameter is created with niether the ``include`` nor the
``exclude`` kwarg, this method will always return ``True``. For
example:
>>> from ipalib.config import Env
>>> param = Param('my_param')
>>> param.use_in_context(Env(context='foo'))
True
>>> param.use_in_context(Env(context='bar'))
True
If a parameter is created with an ``include`` kwarg, this method will
only return ``True`` if ``env.context`` is in ``include``. For example:
>>> param = Param('my_param', include=['foo', 'whatever'])
>>> param.include
frozenset(['foo', 'whatever'])
>>> param.use_in_context(Env(context='foo'))
True
>>> param.use_in_context(Env(context='bar'))
False
If a paremeter is created with an ``exclude`` kwarg, this method will
only return ``True`` if ``env.context`` is not in ``exclude``. For
example:
>>> param = Param('my_param', exclude=['foo', 'whatever'])
>>> param.exclude
frozenset(['foo', 'whatever'])
>>> param.use_in_context(Env(context='foo'))
False
>>> param.use_in_context(Env(context='bar'))
True
Note that the ``include`` and ``exclude`` kwargs are mutually exclusive
and that at most one can be suppelied to `Param.__init__()`. For
example:
>>> param = Param('nope', include=['foo'], exclude=['bar'])
Traceback (most recent call last):
...
ValueError: Param('nope'): cannot have both include=frozenset(['foo']) and exclude=frozenset(['bar'])
So that subclasses can add additional logic based on other environment
variables, the entire `config.Env` instance is passed in rather than
just the value of ``env.context``.
N( RO R. R RP R= ( R Rz ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt use_in_contextF s
3c C s | i o | d j o d S| S( sk
Return a value safe for logging.
This is used so that passwords don't get logged. If this is a
`Password` instance and ``value`` is not ``None``, a constant
``u'********'`` is returned. For example:
>>> p = Password('my_password')
>>> p.safe_value(u'This is my password')
u'********'
>>> p.safe_value(None) is None
True
If this is not a `Password` instance, ``value`` is returned unchanged.
For example:
>>> s = Str('my_str')
>>> s.safe_value(u'Some arbitrary value')
u'Some arbitrary value'
u ********N( R` R. ( R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt
safe_value s c K s | i | i | S( sD
Return a new `Param` instance similar to this one.
( t clone_renameRa ( R t overrides( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt clone s c K s | i | | i | S( sZ
Return a new `Param` instance similar to this one, but named differently
( t clone_retypeR) ( R Ra R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s c K s/ t | i } | i | | | | i | S( s\
Return a new `Param` instance similar to this one, but of a different type
( R; Rg t updateRo ( R Ra t klassR R/ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s
c c s# x | D] } | i d Vq Wd S( Ns utf-8( t encode( R t unicode_csv_datat line( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt __utf_8_encoder s c k sw t i | i | d | d | i d d d | i | } x7 | D]/ } g } | D] } | t | d qQ ~ Vq@ Wd S( Nt dialectt delimitert quotechart "t skipinitialspaces utf-8( RU t readert _Param__utf_8_encoderRV RX t unicode( R R R Rc t
csv_readert rowt _[1]t cell( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt __unicode_csv_reader s c C s | i o t | t t f j o
| f } n g } xh | D]` } t | t o= t | i } x5 | i | D] } | i | qu Wq= | i
| q= Wt | S| Sd S( s Split CSV strings into individual values.
For CSV params, ``value`` is a tuple of strings. Each of these is split
on commas, and the results are concatenated into one tuple.
For example::
>>> param = Param('telephones', multivalue=True, csv=True)
>>> param.split_csv((u'1, 2', u'3', u'4, 5, 6'))
(u'1', u'2', u'3', u'4', u'5', u'6')
If ``value`` is not a tuple (or list), it is only split::
>>> param = Param('telephones', multivalue=True, csv=True)
>>> param.split_csv(u'1, 2, 3')
(u'1', u'2', u'3')
For non-CSV params, return the value unchanged.
N( RU R R( Ri R^ t
basestringR t
splitlinest _Param__unicode_csv_readert extendRl ( R Ru t newvalt vt linesR ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt split_csv s
c sj i o* t | t t f j o
| f } q4 n i o t f d | D S i | Sd S( s
Normalize ``value`` using normalizer callback.
For example:
>>> param = Param('telephone',
... normalizer=lambda value: value.replace('.', '-')
... )
>>> param.normalize(u'800.123.4567')
u'800-123-4567'
If this `Param` instance was created with a normalizer callback and
``value`` is a unicode instance, the normalizer callback is called and
*its* return value is returned.
On the other hand, if this `Param` instance was *not* created with a
normalizer callback, if ``value`` is *not* a unicode instance, or if an
exception is caught when calling the normalizer callback, ``value`` is
returned unchanged.
:param value: A proposed value for this parameter.
c 3 s" x | ] } i | Vq Wd S( N( t _normalize_scalar( R% R ( R ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pys s N( R7 R R( Ri R ( R Ru ( ( R s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR~ s
c C sA | i d j o | Sy | i | SWn t j
o | SXd S( so
Normalize a scalar value.
This method is called once for each value in a multivalue.
N( RJ R. R0 ( R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s c s | t j o d S i oq t | t t f j o
| f } n t f d t d t | D } t | d j o d S| S i | S( s
Convert ``value`` to the Python type required by this parameter.
For example:
>>> scalar = Str('my_scalar')
>>> scalar.type
>>> scalar.convert(43.2)
u'43.2'
(Note that `Str` is a subclass of `Param`.)
All values in `constants.NULLS` will be converted to ``None``. For
example:
>>> scalar.convert(u'') is None # An empty string
True
>>> scalar.convert([]) is None # An empty list
True
Likewise, values in `constants.NULLS` will be filtered out of a
multivalue parameter. For example:
>>> multi = Str('my_multi', multivalue=True)
>>> multi.convert([1.5, '', 17, None, u'Hello'])
(u'1.5', u'17', u'Hello')
>>> multi.convert([None, u'']) is None # Filters to an empty list
True
Lastly, multivalue parameters will always return a ``tuple`` (assuming
they don't return ``None`` as in the last example above). For example:
>>> multi.convert(42) # Called with a scalar value
(u'42',)
>>> multi.convert([0, 1]) # Called with a list value
(u'0', u'1')
Note that how values are converted (and from what types they will be
converted) completely depends upon how a subclass implements its
`Param._convert_scalar()` method. For example, see
`Str._convert_scalar()`.
:param value: A proposed value for this parameter.
Nc 3 s+ x$ | ] \ } } i | | Vq Wd S( N( t _convert_scalar( R% t iR ( R ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pys B s c S s | d t j S( i ( R ( t iv( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt C s i ( R R7 R R( Ri t filtert enumerateR R ( R Ru t values( ( R s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR} s .
c C sF t | | i j o | St d | i d | d t | i d S( s0
Convert a single scalar value.
Ra t indext errorN( R R Ra t ugettextt
type_error( R Ru R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR K s c C s | d j o_ | i p | oI d | i j o9 | d j o t d | i qg t d | i n d S| i o t | t j o& t t
d t | t | f n t | d j o t d n x; t
| D] \ } } | i | | q Wn | i | d S( s
Check validity of ``value``.
:param value: A proposed value for this parameter.
:param context: The context we are running in.
:param supplied: True if this parameter was supplied explicitly.
t nonemptyt cliRa NRu i s, value: empty tuple must be converted to None( R. R6 RQ R RE Ra R7 R R( R R
R R R t _validate_scalar( R Ru R R{ R R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR U s
!
#
c C s t | | i j o2 t d | i d d | i | t | f n | d j o9 t | t j o& t t d t | t | f n x^ | i D]S } | t | } | d j o1 t d | i d | d | d | d | q q Wd S( NRa R s need a %r; got %r (a %r)R Ru Rw (
R R Ra R. t intR R
Rp R R ( R Ru R Rw R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR p s" #
c K sk | i d j oT | i | } | d j o4 y | i | i | SWq` t j
o q` Xqd n | i S( s/
Return the static default or construct and return a dynamic default.
(In these examples, we will use the `Str` and `Bytes` classes, which
both subclass from `Param`.)
The *default* static default is ``None``. For example:
>>> s = Str('my_str')
>>> s.default is None
True
>>> s.get_default() is None
True
However, you can provide your own static default via the ``default``
keyword argument when you create your `Param` instance. For example:
>>> s = Str('my_str', default=u'My Static Default')
>>> s.default
u'My Static Default'
>>> s.get_default()
u'My Static Default'
If you need to generate a dynamic default from other supplied parameter
values, provide a callback via the ``default_from`` keyword argument.
This callback will be automatically wrapped in a `DefaultFrom` instance
if it isn't one already (see the `DefaultFrom` class for all the gory
details). For example:
>>> login = Str('login', default=u'my-static-login-default',
... default_from=lambda first, last: (first[0] + last).lower(),
... )
>>> isinstance(login.default_from, DefaultFrom)
True
>>> login.default_from.keys
('first', 'last')
Then when all the keys needed by the `DefaultFrom` instance are present,
the dynamic default is constructed and returned. For example:
>>> kw = dict(last=u'Doe', first=u'John')
>>> login.get_default(**kw)
u'jdoe'
Or if any keys are missing, your *static* default is returned.
For example:
>>> kw = dict(first=u'John', department=u'Engineering')
>>> login.get_default(**kw)
u'my-static-login-default'
N( RK R. R} R~ R0 RZ ( R R/ RZ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR| s 4
t
falsehoodst truthst versionc C s h } x | i D] \ } } } | | i j o q n | t t f j o q q t t | | t o5 g } t | | g D]
} | | q ~ | | t Boolc
B s{ e Z d Z e Z e d Z e i d e e d d e
d d g f d e e d d e d
d g f f Z d
d Z
RS( sG
A parameter for boolean values (stored in the ``bool`` type).
s must be True or FalseR i u 1u trueu TRUER i u 0u falseu FALSEc C s t | | i j o | St | t o | i } n | | i j o t S| | i j o t St | t t f j o+ t
d | i d | d t | i
n t
d | i d | d t | i d S( s0
Convert a single scalar value.
Ra R R N( R R^ R t lowerR R= R R< R( Ri R Ra R R R ( R Ru R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s N( R' R3 R4 R R R R RD Rc Rh R= R< R. R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s !(t Flagc B s e Z d Z d Z RS( sR
A boolean parameter that always gets filled in with a default value.
This `Bool` subclass forces ``autofill=True`` in `Flag.__init__()`. If no
default is provided, it also fills in a default value of ``False``.
Lastly, unlike the `Bool` class, the default must be either ``True`` or
``False`` and cannot be ``None``.
For example:
>>> flag = Flag('my_flag')
>>> (flag.autofill, flag.default)
(True, False)
To have a default value of ``True``, create your `Flag` intance with
``default=True``. For example:
>>> flag = Flag('my_flag', default=True)
>>> (flag.autofill, flag.default)
(True, True)
Also note that creating a `Flag` instance with ``autofill=False`` will have
no effect. For example:
>>> flag = Flag('my_flag', autofill=False)
>>> flag.autofill
True
c O s t | d maxvalue (minvalue=%r, maxvalue=%r)( R R R# R R R. R Rb ( R Ra Ro R/ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR# Q s
3c C s t | t t f j o | St | t j oo | i d d j o. y t t | SWq t j
o q Xq y t | d SWq t j
o q Xn t | t j o( y t | SWq t j
o q Xn t d | i d | d t | i
d S( s0
Convert a single scalar value.
u .i Ra R R N( R R R R t findR R R R R R ( R Ru R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR [ s& c C s/ | | i j o | d t d | i Sd S( s'
Check min constraint.
s must be at least %(minvalue)dR N( R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _rule_minvaluex s c C s/ | | i j o | d t d | i Sd S( s'
Check max constraint.
s can be at most %(maxvalue)dR N( R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _rule_maxvalue s c C s t | t t f j o2 t d | i d d | i | t | f n | d j o9 t | t j o& t t d t | t | f n x^ | i D]S } | t | } | d j o1 t d | i
d | d | d | d | q q Wd S( s
This duplicates _validate_scalar in the Param class with
the exception that it allows both int and long types. The
min/max rules handle size enforcement.
Ra R s need a %r; got %r (a %r)R Ru Rw N( R R R R Ra R. R R
Rp R R ( R Ru R Rw R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s" #
N( R' R3 R4 R R R R RD Rc R R R R# R. R R R R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR D s
t Decimalc
B s e Z d Z e i Z e d Z e i d e i d f d e i d f d e d f d e e
f d e d f f Z d
Z d Z d Z d
Z d Z d Z d Z d d Z d Z RS( sj
A parameter for floating-point values (stored in the ``Decimal`` type).
Python Decimal type helps overcome problems tied to plain "float" type,
e.g. problem with representation or value comparison. In order to safely
transfer the value over RPC libraries, it is being converted to string
which is then converted back to Decimal number.
s must be a decimal numberR R t precisiont exponentialt numberclasss -Normals +Zeros +Normalc O sR x d D] } | i | } | d j o q n t | t t f oX y t i | } Wn4 t j
o( } t d | | t | f n X| | | maxvalue (minvalue=%s, maxvalue=%s)i s %s: precision must be at least 0( s minvalues maxvalues default( R- R. R^ R R t decimalR t ExceptionR R R R# R R Rb R ( R Ra Ro R/ t kwparamRu t e( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR# s,
c C s/ | | i j o | d t d | i Sd S( s'
Check min constraint.
s must be at least %(minvalue)sR N( R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s c C s/ | | i j o | d t d | i Sd S( s'
Check max constraint.
s can be at most %(maxvalue)sR N( R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s c C sd | i } | | i j oD t d | i d t d t d | d d i | i n d S( NRa R sW number class '%(cls)s' is not included in a list of allowed number classes: %(allowed)st clst allowedu , ( t number_classR R R R R; R* ( R Ru R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _enforce_numberclass s c C s~ | i d j oj t i d | i } y | i | } Wqz t i j
o* } t d | i d t | qz Xn | S( Ni
Ra R ( R R. R R t quantizet DecimalExceptionR R R ( R Ru t quantize_expR ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _enforce_precision s c C s | i p| y< | | i j o | i t i d n
| i } Wq t i j
o* } t d | i d t | q Xn | S( Ni Ra R (
R t to_integralR R R R~ R R R R ( R Ru R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _remove_exponent s
,c C s/ | i | | i | } | i | } | S( s
This method is run in conversion and normalization methods to test
that the Decimal number conforms to Parameter boundaries and then
normalizes the value.
( R R R ( R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _test_and_normalize s
c C s t | t t f oY y t i | } Wqo t i j
o0 } t d | i d | d t | qo Xn t | t i o | i | St
t | i | | S( NRa R R ( R^ R R R R R R R R R R R ( R Ru R R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s c C s7 t | t i o | i | St t | i | S( N( R^ R R R R R ( R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR , s N( s -Normals +Zeros +Normal( R' R3 R4 R R R R R RD Rc R. R R R< R( R# R R R R R R R R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s$
t Datac B s{ e Z d Z e i d e d f d e d f d e d f d e f d f d e f d f f Z d Z d Z d Z
d Z RS( s+
Base class for the `Bytes` and `Str` parameters.
Previously `Str` was as subclass of `Bytes`. Now the common functionality
has been split into this base class so that ``isinstance(foo, Bytes)`` wont
be ``True`` when ``foo`` is actually an `Str` instance (which is confusing).
t minlengtht maxlengtht lengtht patternt pattern_errmsgc O sp t t | i | | | | i d j p | i d j o
| i d j p t d | i n | i d j o0 | i d j o t d | i | i f n | i d j o0 | i d j o t d | i | i f n d | i | i f j op | i | i j o& t d | i | i | i f ql| i | i j o t d | i | i f qln d S( Ns1 %s: cannot mix length with minlength or maxlengthi s" %s: minlength must be >= 1; got %rs" %s: maxlength must be >= 1; got %rs6 %s: minlength > maxlength (minlength=%r, maxlength=%r)s1 %s: minlength == maxlength; use length=%d instead( R R R# R R. R R R Rb ( R Ra Ro R/ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR# F s( c C s] | i i | d j o@ | i o | i t d | i S| d t d | i Sn d S( s2
Check pattern (regex) contraint.
R s must match pattern "%(pattern)s"N( t ret matchR. t re_errmsgR; R ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt
_rule_patterng s
N( R' R3 R4 RD Rc R R. R R R R# R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR 2 s !t Bytesc B sP e Z d Z e Z e d Z d Z d Z d Z d Z
d d Z RS( s(
A parameter for binary data (stored in the ``str`` type).
This class is named *Bytes* instead of *Str* so it's aligned with the
Python v3 ``(str, unicode) => (bytes, str)`` clean-up. See:
http://docs.python.org/3.0/whatsnew/3.0.html
Also see the `Str` parameter.
s must be binary datac O sq | i d d d j o
d | _ n t i | d | _ | i d d | _ t t | i | | | d S( NR R ( R- R. R t compileR R R R# ( R Ra Ro R/ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR# s
c C s5 t | | i j o | d t d | i Sd S( s-
Check minlength constraint.
s$ must be at least %(minlength)d bytesR N( R R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _rule_minlength s c C s5 t | | i j o | d t d | i Sd S( s-
Check maxlength constraint.
s" can be at most %(maxlength)d bytesR N( R R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _rule_maxlength s c C s5 t | | i j o | d t d | i Sd S( s*
Check length constraint.
s must be exactly %(length)d bytesR N( R R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _rule_length s c C sm t | t oD y t i | } WqT t j
o } t d t | qT Xn t t | i | | S( Nt reason(
R^ R t base64t b64decodeR R R R R R ( R Ru R R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s N(
R' R3 R4 R R R R R# R R R R. R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR u s
t Strc B sr e Z d Z e i d e e f f Z e Z e d Z
d Z d d Z
d Z d Z d Z d Z RS(
s1
A parameter for Unicode text (stored in the ``unicode`` type).
This class is named *Str* instead of *Unicode* so it's aligned with the
Python v3 ``(str, unicode) => (bytes, str)`` clean-up. See:
http://docs.python.org/3.0/whatsnew/3.0.html
Also see the `Bytes` parameter.
t noextrawhitespaces must be Unicode textc O sw | i d d d j o
d | _ n t i | d t i | _ | i d d | _ t t | i | | | d S( NR R ( R- R. R R t UNICODER R R R# ( R Ra Ro R/ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR# s
c C s t | | i j o | St | t t t t i f j o | i | St | t t f j o+ t d | i d | d t
| i n t d | i d | d t
| i d S( s0
Convert a single scalar value.
Ra R R N(
R R R R R R R( Ri R Ra R R R ( R Ru R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s "c C sC | i t j o d St | t | i j o | d Sd S( s7
Do not allow leading/trailing spaces.
Ns+ Leading and trailing spaces are not allowed( R R< R t strip( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _rule_noextrawhitespace s c C s5 t | | i j o | d t d | i Sd S( s-
Check minlength constraint.
s) must be at least %(minlength)d charactersR N( R R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s c C s5 t | | i j o | d t d | i Sd S( s-
Check maxlength constraint.
s' can be at most %(maxlength)d charactersR N( R R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s c C s5 t | | i j o | d t d | i Sd S( s*
Check length constraint.
s% must be exactly %(length)d charactersR N( R R R; ( R R Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s N( R' R3 R4 R Rc R R= R R R R R# R. R R R R R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s
t IA5Strc B s# e Z d Z d Z d d Z RS( s#
An IA5String per RFC 4517
c O s t t | i | | | d S( N( R R R# ( R Ra Ro R/ ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR# s c C s t | t ot xq t t | D]Y } t | | d j o< t d | i d | d t d t d | | q# q# Wn t t
| i | | S( Ni Ra R R s( The character '%(char)r' is not allowed.t char( R^ R t xrangeR t ordR R R R; R R R ( R Ru R R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s #N( R' R3 R4 R# R. R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s R_ c B s3 e Z d Z e i d e e f f Z d d Z RS( sE
A parameter for passwords (stored in the ``unicode`` type).
t confirmc C s t | t t f oR t | d j o? | \ } } | | j o t d | i d | n | } n t t | i | | S( Ni Ra R ( R^ R( Ri R R
Ra R R_ R ( R Ru R t p1t p2( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR # s )
N( R' R3 R4 R Rc R R= R. R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR_ s t Enumc B s< e Z d Z e i d e e f f Z d Z d Z RS( s;
Base class for parameters with enumerable values.
R c O s t t | i | | | xo t | i D]^ \ } } t | | i j o< d | i | f } t t | | i | t | f q, q, Wt | i d j o t
d | i n d S( Ns
%s values[%d]i s$ %s: list of values must not be empty( R R R# R R R Rb R R
R R ( R Ra Ro R/ R R t n( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR# 5 s *c K s | | i j ol t | i d j o | d t d | i d Sd i d | i D } | d t d | Sn d S( Ni s must be '%(value)s'Ru i u , c s s x | ] } d | Vq Wd S( s '%s'N( ( R% Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pys G s s must be one of %(values)sR ( R R R; R* ( R R Ru R/ R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _rule_valuesB s
( R' R3 R4 RD Rc R( R# R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR , s
t BytesEnumc B s e Z d Z e Z RS( sB
Enumerable for binary data (stored in the ``str`` type).
( R' R3 R4 R R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR J s t StrEnumc B s e Z d Z e Z RS( sy
Enumerable for Unicode text (stored in the ``unicode`` type).
For example:
>>> enum = StrEnum('my_enum', values=(u'One', u'Two', u'Three'))
>>> enum.validate(u'Two', 'cli') is None
True
>>> enum.validate(u'Four', 'cli')
Traceback (most recent call last):
...
ValidationError: invalid 'my_enum': must be one of 'One', 'Two', 'Three'
( R' R3 R4 R R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR R s
t Anyc B s, e Z d Z e Z d d Z d d Z RS( sS
A parameter capable of holding values of any type. For internal use only.
c C s | S( N( ( R Ru R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR k s c C sb x[ | i D]P } | t | } | d j o. t d | i d | d | d | d | q
q
Wd S( NRa Ru R R Rw ( Rp R R. R Ra ( R Ru R Rw R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR n s
N( R' R3 R4 t objectR R. R R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR d s t Filec B s3 e Z d Z e i d e e f d e e f f Z RS( sh
File parameter type.
Accepts file names and loads their content into the parameter value.
t stdin_if_missingR ( R' R3 R4 R Rc R R< ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR { s t
AccessTimec B s e Z d Z d Z d Z d d d Z d Z d Z d Z d Z d
Z
d Z d Z d
Z
d Z d Z d Z RS( s
Access time parameter type.
Accepts values conforming to generalizedTime as defined in RFC 4517
section 3.3.13 without time zone information.
c C s t | d j o t d n | i p t d n t | d d ! } | d j p
| d j o t d n t | d d ! } | d j p
| d j o t d n d S(
Ni s& HHMM must be exactly 4 characters longs HHMM non-numerici i i s HH out of rangei; s MM out of range( R R t isnumericR ( R R[ t hht mm( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_HHMM s
c C sh | i o: t | } | d j p
| d j o t d qd n | d j o t d n d S(
Ni i s day of the week out of ranget Mont Tuet Wedt Thut Frit Satt Suns invalid day of the week( R
R R R R R R ( R R R ( R R[ Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_dotw s
i i c C s? | i p t d n t | } | d j o. | d j p
| d j o t d
q;n | d j o. | d j p
| d j o t d
q;n | d j o | d d j oP | d d j p | d d j o. | d j p
| d j o t d
q7q;| d j p
| d j o t d
q;n d S( Ns day of the month non-numerici i i i i i
i i s day of the month out of rangei i i i i i i id i i i ( i i i i i i
i ( i i i i ( R R R ( R R[ t month_numt yearRu ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_dotm s
3c C sW | i p t d n t | } | d j p
| d j o t d n d S( Ns week of the month non-numerici i s week of the month out of range( R R R ( R R[ Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_wotm s
c C sW | i p t d n t | } | d j p
| d j o t d n d S( Ns week of the year non-numerici i4 s week of the year out of range( R R R ( R R[ Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_woty s
c C sW | i p t d n t | } | d j p
| d j o t d n d S( Ns day of the year non-numerici im s day of the year out of range( R R R ( R R[ Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_doty s
c C sW | i p t d n t | } | d j p
| d j o t d n d S( Ns month number non-numerici i s month number out of range( R R R ( R R[ Ru ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_month_num s
c C s | i d } x | D] } | p t d n | i d } t | d j o t d n x | D] } | | ql Wt | d j o5 t | d t | d j o t d q q q Wd S( NRW s invalid time ranget -i i i ( t splitR R R ( R R[ t
check_funct intervalsR R R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_interval s !c C sF | | d j o t d n | d 7} | i | | | i | S( Nt days invalid week specifieri ( R R R ( R t tsR ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt
_check_W_spec s
c C s | | d j o5 | i | | d | i | i | | d } nC | | d j o% | d 7} | i | | | i n
t d | S( Nt weeki i R! s invalid month specifier( R R R# R R ( R R" R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt
_check_M_spec s
c C s | | d j oK | d 7} | i | | | i t | | } | i | | d } n | | d j o5 | i | | d | i | i | | d } nC | | d j o% | d 7} | i | | | i n
t d | S( Nt monthi R$ i R! s invalid year specifier( R R R R% R R# R R ( R R" R R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt
_check_Y_spec s
c C s/ t | d
j o t d n | i p t d n | i | d d ! t | d d ! } t | d d ! } | i | d d !| | t | d j o | i | d d ! n | i d
| d d ! t | d j oA t | d d ! } | d j p
| d j o t d q+n d S( Ni
i i s incomplete generalized times time non-numerici i i i s %s00i< s seconds out of range( i
i i ( R R R R R R R ( R R[ t year_numR t s( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check_generalized s
c C s | i } | d d j o t | d j o t d n | i | d | d d j o t d n | i | d t | d t | d j o t d
qn | d d j o d } | d d j o | i | d } nj | d d
j o | i | d } nC | d d j o | i | d } n | d d j o
d } n | d j o t d | d n | i | | d | i
n
t d d S( Ni t absolutei sD invalid format, must be 'absolute generalizedTime ~ generalizedTime'i i t ~s invalid time range separatori s invalid time ranget periodict yearlyt monthlyt weeklyt dailys0 period must be yearly, monthy or daily, got '%s's! time neither absolute or periodic( R R R R* R R. R' R% R# R R ( R t timeR" R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _check s0 !
c C s y | i | Wnj t j
o+ } t d | i d | i d n5 t j
o( t d | i d t d n Xd S( NRa R i s incomplete time value( R3 R R R R+ t
IndexErrorR R. ( R R Ru R ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt _rule_required0 s & ( R' R3 R4 R R R R R R R R R# R% R' R* R3 R5 ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR s t DNParamc B s e Z e Z d d Z RS( c C sn t | | i j o | Sy t | } Wn< t j
o0 } t d | i d | d t | n X| S( s0
Convert a single scalar value.
Ra R R ( R R R R R R ( R Ru R t dnR ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR ? s N( R' R3 R R R. R ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyR6 < s t DeprecatedParamc B s3 e Z e i d e e f f Z d Z d Z RS( t deprecatec O sY d | j o t | d d g | d >> s = create_param('hometown?')
>>> s
Str('hometown?')
>>> (s.name, s.required, s.multivalue)
('hometown', False, False)
On the other hand, if ``spec`` is already a `Param` instance, it is
returned unchanged. For example:
>>> b = Bytes('cert')
>>> create_param(b) is b
True
As a plugin author, you will not call this function directly (which would
be no more convenient than simply creating the `Str` instance). Instead,
`frontend.Command` will call it for you when it evaluates the
``takes_args`` and ``takes_options`` attributes, and `frontend.Object`
will call it for you when it evaluates the ``takes_params`` attribute.
:param spec: A spec string or a `Param` instance.
R5 ( R^ RD R R R R
R ( R5 ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt create_param^ s !)(9 R4 R R R RU t xmlrpclibR R t typesR t textR R t plugableR R R t errorsR R R R
R t constantsR R
R R R t utilR t ipapython.dnR R R@ Rd RA RD R R R R R R R R R R_ R R R R R R R6 R8 R< ( ( ( s5 /usr/lib/python2.6/site-packages/ipalib/parameters.pyt d sP x - #*dC>S