Ñò
ìÿÒXc @ s d Z d d k Z d d k 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
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 l Z l Z l Z l Z d d k l Z d d
k! l" Z" d d k# l$ Z$ d d k% l& Z& d
Z' d „ Z( d „ 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 „ ƒ YZ0 d e0 e, f d „ ƒ YZ1 d e0 f d „ ƒ YZ2 d! e1 f d" „ ƒ YZ3 d S(# s)
Base classes for all front-end plugins.
iÿÿÿÿN( t lockt
check_namet NameSpace( t Plugint is_production_mode( t create_paramt parse_param_spect Paramt Strt Flagt Password( t Outputt Entryt
ListOfEntries( t _t ngettext( t ZeroArgumentErrort MaxArgumentErrort OverlapErrort RequiresRoott VersionErrort RequirementErrort OptionError( t InvocationError( t
TYPE_ERROR( t API_VERSION( t versiont validation_rulec C s t | t t ƒ | S( N( t setattrt RULE_FLAGt True( t obj( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt rule* s c C s# t | ƒ o t | t t ƒ t j S( N( t callablet getattrR t FalseR ( R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt is_rule/ s c C s^ d } xQ | D]I } t | | ƒ t j o | t | | ƒ } q
| t | | ƒ } q
W| S( sÑ
Return the number of entries in an entry. This is primarly for the
failed output parameter so we don't print empty values.
We also use this to determine if a non-zero return value is needed.
i ( t typet dictt entry_countt len( t entryt num_entriest f( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR' 3 s t HasParamc B s8 e Z d Z e Z d d „ Z d d „ Z d d „ Z RS( s¢
Base class for plugins that have `Param` `NameSpace` attributes.
Subclasses of `HasParam` will on one or more attributes store `NameSpace`
instances containing zero or more `Param` instances. These parameters might
describe, for example, the arguments and options a command takes, or the
attributes an LDAP entry can include, or whatever else the subclass sees
fit.
Although the interface a subclass must implement is very simple, it must
conform to a specific naming convention: if you want a namespace
``SubClass.foo``, you must define a ``Subclass.takes_foo`` attribute and a
``SubCLass.get_foo()`` method, and you may optionally define a
``SubClass.check_foo()`` method.
A quick big-picture example
===========================
Say you want the ``options`` instance attribute on your subclass to be a
`Param` `NameSpace`... then according to the enforced naming convention,
your subclass must define a ``takes_options`` attribute and a
``get_options()`` method. For example:
>>> from ipalib import Str, Int
>>> class Example(HasParam):
...
... options = None # This will be replaced with your namespace
...
... takes_options = (Str('one'), Int('two'))
...
... def get_options(self):
... return self._get_param_iterable('options')
...
>>> eg = Example()
The ``Example.takes_options`` attribute is a ``tuple`` defining the
parameters you want your ``Example.options`` namespace to contain. Your
``Example.takes_options`` attribute will be accessed via
`HasParam._get_param_iterable()`, which, among other things, enforces the
``('takes_' + name)`` naming convention. For example:
>>> eg._get_param_iterable('options')
(Str('one'), Int('two'))
The ``Example.get_options()`` method simply returns
``Example.takes_options`` by calling `HasParam._get_param_iterable()`. Your
``Example.get_options()`` method will be called via
`HasParam._filter_param_by_context()`, which, among other things, enforces
the ``('get_' + name)`` naming convention. For example:
>>> list(eg._filter_param_by_context('options'))
[Str('one'), Int('two')]
At this point, the ``eg.options`` instance attribute is still ``None``:
>>> eg.options is None
True
`HasParam._create_param_namespace()` will create the ``eg.options``
namespace from the parameters yielded by
`HasParam._filter_param_by_context()`. For example:
>>> eg._create_param_namespace('options')
>>> eg.options
NameSpace(<2 members>, sort=False)
>>> list(eg.options) # Like dict.__iter__()
['one', 'two']
Your subclass can optionally define a ``check_options()`` method to perform
sanity checks. If it exists, the ``check_options()`` method is called by
`HasParam._create_param_namespace()` with a single value, the `NameSpace`
instance it created. For example:
>>> class Example2(Example):
...
... def check_options(self, namespace):
... for param in namespace(): # Like dict.itervalues()
... if param.name == 'three':
... raise ValueError("I dislike the param 'three'")
... print ' ** Looks good! **' # Note output below
...
>>> eg = Example2()
>>> eg._create_param_namespace('options')
** Looks good! **
>>> eg.options
NameSpace(<2 members>, sort=False)
However, if we subclass again and add a `Param` named ``'three'``:
>>> class Example3(Example2):
...
... takes_options = (Str('one'), Int('two'), Str('three'))
...
>>> eg = Example3()
>>> eg._create_param_namespace('options')
Traceback (most recent call last):
...
ValueError: I dislike the param 'three'
>>> eg.options is None # eg.options was not set
True
The Devil and the details
=========================
In the above example, ``takes_options`` is a ``tuple``, but it can also be
a param spec (see `create_param()`), or a callable that returns an iterable
containing one or more param spec. Regardless of how ``takes_options`` is
defined, `HasParam._get_param_iterable()` will return a uniform iterable,
conveniently hiding the details.
The above example uses the simplest ``get_options()`` method possible, but
you could instead implement a ``get_options()`` method that would, for
example, produce (or withhold) certain parameters based on the whether
certain plugins are loaded.
Think of ``takes_options`` as declarative, a simple definition of *what*
parameters should be included in the namespace. You should only implement
a ``takes_options()`` method if a `Param` must reference attributes on your
plugin instance (for example, for validation rules); you should not use a
``takes_options()`` method to filter the parameters or add any other
procedural behaviour.
On the other hand, think of the ``get_options()`` method as imperative, a
procedure for *how* the parameters should be created and filtered. In the
example above the *how* just returns the *what* unchanged, but arbitrary
logic can be implemented in the ``get_options()`` method. For example, you
might filter certain parameters from ``takes_options`` base on some
criteria, or you might insert additional parameters provided by other
plugins.
The typical use case for using ``get_options()`` this way is to procedurally
generate the arguments and options for all the CRUD commands operating on a
specific LDAP object: the `Object` plugin defines the possible LDAP entry
attributes (as `Param`), and then the CRUD commands intelligently build
their ``args`` and ``options`` namespaces based on which attribute is the
primary key. In this way new LDAP attributes (aka parameters) can be added
to the single point of definition (the `Object` plugin), and all the
corresponding CRUD commands pick up these new parameters without requiring
modification. For an example of how this is done, see the
`ipalib.crud.Create` base class.
However, there is one type of filtering you should not implement in your
``get_options()`` method, because it's already provided at a higher level:
you should not filter parameters based on the value of ``api.env.context``
nor (preferably) on any values in ``api.env``.
`HasParam._filter_param_by_context()` already does this by calling
`Param.use_in_context()` for each parameter. Although the base
`Param.use_in_context()` implementation makes a decision solely on the value
of ``api.env.context``, subclasses can override this with implementations
that consider arbitrary ``api.env`` values.
t takesc C s | d | } t | | d ƒ } t | ƒ t j o | St | t t f ƒ o | f St | ƒ o | ƒ S| d j o t ƒ St d | i | | f ƒ ‚ d S( sà
Return an iterable of params defined by the attribute named ``name``.
A sequence of params can be defined one of three ways: as a ``tuple``;
as a callable that returns an iterable; or as a param spec (a `Param` or
``str`` instance). This method returns a uniform iterable regardless of
how the param sequence was defined.
For example, when defined with a tuple:
>>> class ByTuple(HasParam):
... takes_args = (Param('foo'), Param('bar'))
...
>>> by_tuple = ByTuple()
>>> list(by_tuple._get_param_iterable('args'))
[Param('foo'), Param('bar')]
Or you can define your param sequence with a callable when you need to
reference attributes on your plugin instance (for validation rules,
etc.). For example:
>>> class ByCallable(HasParam):
... def takes_args(self):
... yield Param('foo', self.validate_foo)
... yield Param('bar', self.validate_bar)
...
... def validate_foo(self, _, value, **kw):
... if value != 'Foo':
... return _("must be 'Foo'")
...
... def validate_bar(self, _, value, **kw):
... if value != 'Bar':
... return _("must be 'Bar'")
...
>>> by_callable = ByCallable()
>>> list(by_callable._get_param_iterable('args'))
[Param('foo', validate_foo), Param('bar', validate_bar)]
Lastly, as a convenience for when a param sequence contains a single
param, your defining attribute may a param spec (either a `Param`
or an ``str`` instance). For example:
>>> class BySpec(HasParam):
... takes_args = Param('foo')
... takes_options = 'bar?'
...
>>> by_spec = BySpec()
>>> list(by_spec._get_param_iterable('args'))
[Param('foo')]
>>> list(by_spec._get_param_iterable('options'))
['bar?']
For information on how an ``str`` param spec is interpreted, see the
`create_param()` and `parse_param_spec()` functions in the
`ipalib.parameters` module.
Also see `HasParam._filter_param_by_context()`.
R s0 %s.%s must be a tuple, callable, or spec; got %rN(
R" t NoneR% t tuplet
isinstanceR t strR! t TypeErrort name( t selfR3 t verbt src_namet src( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt _get_param_iterableâ s ;
c c s t | d | ƒ } d | } t | | ƒ p t d | i | f ƒ ‚ n t | | ƒ } t | ƒ p t d | i | | f ƒ ‚ n xx | ƒ D]m } t | ƒ } | d j p | i | ƒ o> | d j o( t | d ƒ o t i
| d | ƒ n | Vq q Wd S( sK
Filter params on attribute named ``name`` by environment ``env``.
For example:
>>> from ipalib.config import Env
>>> class Example(HasParam):
...
... takes_args = (
... Str('foo_only', include=['foo']),
... Str('not_bar', exclude=['bar']),
... 'both',
... )
...
... def get_args(self):
... return self._get_param_iterable('args')
...
...
>>> eg = Example()
>>> foo = Env(context='foo')
>>> bar = Env(context='bar')
>>> another = Env(context='another')
>>> (foo.context, bar.context, another.context)
(u'foo', u'bar', u'another')
>>> list(eg._filter_param_by_context('args', foo))
[Str('foo_only', include=['foo']), Str('not_bar', exclude=['bar']), Str('both')]
>>> list(eg._filter_param_by_context('args', bar))
[Str('both')]
>>> list(eg._filter_param_by_context('args', another))
[Str('not_bar', exclude=['bar']), Str('both')]
t envt get_s %s.%s()s %s.%s must be a callable; got %rN( R" t hasattrt NotImplementedErrorR3 R! R2 R R. t use_in_contextt objectt __setattr__( R4 R3 R9 t get_namet gett spect param( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt _filter_param_by_context- s
c C st t | i | | ƒ d t ƒ} t | ƒ p5 t | d | d ƒ } t | ƒ o | | ƒ q` n t | | | ƒ d S( Nt sortt check_( R RD R# R R" R. R! R ( R4 R3 R9 t namespacet check( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt _create_param_namespaced s
N( t __name__t
__module__t __doc__R# t NO_CLIR8 R. RD RI ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR, D s
™ K 7t Commandc B sâ e Z d Z e Z e ƒ Z e ƒ Z e i d ƒ Z
e i d ƒ Z e i d ƒ Z e i d ƒ Z
d2 Z e Z e i d ƒ Z d3 Z e i d ƒ Z e ƒ Z e ƒ Z d2 Z e d ƒ 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% d „ Z& d „ Z' d „ Z( d „ Z) d „ Z* d „ Z+ d „ Z, d „ Z- d „ Z. d „ Z/ d „ Z0 d „ Z1 d! „ Z2 d" „ Z3 d# „ Z4 d$ „ Z5 d% „ Z6 d& „ Z7 d4 Z8 d5 Z9 d0 „ Z: d1 „ Z; RS(6 sF
A public IPA atomic operation.
All plugins that subclass from `Command` will be automatically available
as a CLI command and as an XML-RPC method.
Plugins that subclass from Command are registered in the ``api.Command``
namespace. For example:
>>> from ipalib import create_api
>>> api = create_api()
>>> class my_command(Command):
... pass
...
>>> api.register(my_command)
>>> api.finalize()
>>> list(api.Command)
['my_command']
>>> api.Command.my_command # doctest:+ELLIPSIS
ipalib.frontend.my_command()
t argst optionst paramst params_by_defaultt outputt resultt
output_paramss1 Results are truncated, try a more specific searchc O s¾ | i ƒ d | j } | o | i t | d ƒ ƒ n | i | | Ž } | i d | i d i | i | ƒ ƒ | i | i | ƒ | i
| } | i | } | i d | i d i | i | ƒ ƒ | i i
i o d | j o t | d >> class my_cmd(Command):
... takes_args = ('login',)
... takes_options=(Password('passwd'),)
...
>>> c = my_cmd()
>>> c.finalize()
>>> list(c._repr_iter(login=u'Okay.', passwd=u'Private!'))
["u'Okay.'", "passwd=u'********'"]
s %s=%rN( RO RA R3 R. t reprt
safe_valueRP ( R4 RQ t argRp t option( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR] Ñ s
c O sþ | i d j o[ t | ƒ | i j oE | i d j o t d | i ƒ ‚ n t d | i d | i ƒ ‚ n t | i | ƒ ƒ } t | ƒ d j og t | i | ƒ ƒ } t | ƒ i
| ƒ } t | ƒ d j o t d t | ƒ ƒ ‚ n | i
| ƒ n | S( s4
Merge (args, options) into params.
i R3 t countt namesN( t max_argsR. R( R R3 R R& t _Command__options_2_paramst _Command__args_2_paramst sett intersectionR t sortedR^ ( R4 RO RP RQ t arg_kwR} ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRZ í s & c c sÇ t } xº t | i ƒ ƒ D]¦ \ } } t | ƒ | j o† | i of t } t | ƒ | d j o3 t | | ƒ t t f j o | i | | f Vqº | i | | f Vq¿ | i | | f Vq Pq Wd S( Ni (
R# t enumerateRO R( t
multivalueR R% t listR/ R3 ( R4 Rm R t iRu ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __args_2_paramsþ s
4c c s‹ x6 | i D]+ } | | j o | | i | ƒ f Vq
q
Wt | ƒ i | i ƒ } | i d ƒ | o" t t d ƒ d | i ƒ ƒ‚ n d S( NR s Unknown option: %(option)sRv ( RQ t popR| t
differencet internal_optionst discardR R ( R4 RP R3 t unused_keys( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __options_2_params s
c O s% | i | | Ž } t | i | ƒ ƒ S( sK
Creates a LDAP entry from attributes in args and options.
( RZ R& t _Command__attributes_2_entry( R4 RO RP t kw( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt args_options_2_entry s c c s x† | i D]{ } | i | i od | | j oW | | } t | t ƒ o* | g } | D]
} | | qV ~ f Vq… | | | f Vq
q
Wd S( N( RQ t attributeR0 R/ ( R4 RΠR3 Rp t _[1]t v( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __attributes_2_entry s
*c s> t ‡ f d † | i Dƒ ƒ } t | i ˆ ƒ ƒ } | | f S( s4
Split params into (args, options).
c 3 s% x | ] } ˆ i | d ƒ Vq Wd S( N( RA R. ( t .0R3 ( RQ ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pys - s ( R/ RO R& t _Command__params_2_options( R4 RQ RO RP ( ( RQ s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRe ) s c c s8 x1 | i D]& } | | j o | | | f Vq
q
Wd S( N( RP ( R4 RQ R3 ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __params_2_options1 s
c s t ‡ f d † | i ƒ Dƒ ƒ S( s§
Return a dictionary of values where values are decoded from CSV.
For example:
>>> class my_command(Command):
... takes_options = (
... Param('flags', multivalue=True, csv=True),
... )
...
>>> c = my_command()
>>> c.finalize()
>>> c.split_csv(flags=u'public,replicated')
{'flags': (u'public', u'replicated')}
c 3 s5 x. | ]' \ } } | ˆ i | i | ƒ f Vq Wd S( N( RQ t split_csv( R’ t kR ( R4 ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pys G s ( R& t iteritems( R4 RŒ ( ( R4 s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR• 6 s c s t ‡ f d † | i ƒ Dƒ ƒ S( s½
Return a dictionary of normalized values.
For example:
>>> class my_command(Command):
... takes_options = (
... Param('first', normalizer=lambda value: value.lower()),
... Param('last'),
... )
...
>>> c = my_command()
>>> c.finalize()
>>> c.normalize(first=u'JOHN', last=u'DOE')
{'last': u'DOE', 'first': u'john'}
c 3 s5 x. | ]' \ } } | ˆ i | i | ƒ f Vq Wd S( N( RQ R` ( R’ R– R ( R4 ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pys \ s ( R& R— ( R4 RŒ ( ( R4 s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR` J s c s t ‡ f d † | i ƒ Dƒ ƒ S( s‡
Return a dictionary of values converted to correct type.
>>> from ipalib import Int
>>> class my_command(Command):
... takes_args = (
... Int('one'),
... 'two',
... )
...
>>> c = my_command()
>>> c.finalize()
>>> c.convert(one=1, two=2)
{'two': u'2', 'one': 1}
c 3 s5 x. | ]' \ } } | ˆ i | i | ƒ f Vq Wd S( N( RQ Ra ( R’ R– R ( R4 ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pys p s ( R& R— ( R4 RŒ ( ( R4 s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRa _ s c C s> x7 | i ƒ D]) } | i | i d ƒ d j o q
q
q
Wd S( N( RQ RA R3 R. ( R4 RΠRC ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __convert_iters s
c K sh g } | i ƒ D]8 } | i | j o" | i p
| i o | | i q q ~ } t | i | | ƒ ƒ S( s›
Return a dictionary of defaults for all missing required values.
For example:
>>> from ipalib import Str
>>> class my_command(Command):
... takes_args = Str('color', default=u'Red')
...
>>> c = my_command()
>>> c.finalize()
>>> c.get_default()
{'color': u'Red'}
>>> c.get_default(color=u'Yellow')
{}
( RQ R3 t requiredt autofillR& t _Command__get_default_iter( R4 RŒ R Ro RQ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR_ x s Rc K s( t | i | g | ƒ ƒ } | i | ƒ S( s<
Return default value for parameter `name`.
( R& R› RA ( R4 R3 RŒ t default( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt get_default_ofŒ s c c sn t ƒ } xv t | i ƒ D]e } | i | j p | i | j o? | i d j o q n x% | i i D] } | i | ƒ qc Wq q Wxå | i ƒ D]× } d } t } | i | j oh | i | j o! | | | i | | | i >> class user_add(Command):
... def execute(self, **kw):
... return self.api.Backend.ldap.add(**kw)
...
s %s.execute()N( R< R3 ( R4 RO RŒ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR³ ñ s
c O s | i i i | i | | Ž S( sK
Forward call over XML-RPC to this same command on server.
( t Backendt xmlclientR´ R3 ( R4 RO RŒ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR´ s c C s« | i d ƒ t | i ƒ d j p | i d i o t | i ƒ | _ n
d | _ | i d ƒ t | i ƒ ƒ t | i ƒ ƒ } d „ } t t | d | ƒd t
ƒ| _ g } x¡ | D]™ } t | ƒ } xt | D]l } | i d j o qÓ n | i
| i i j o qÓ n y t | | i | ƒ ƒ } WqÓ t j
o qÓ XqÓ W| i | | ƒ qº Wt | d t
ƒ| _ t | i ƒ d t
ƒ| _ | i d ƒ t t | ƒ i ƒ d S(
s‰
Finalize plugin initialization.
This method creates the ``args``, ``options``, and ``params``
namespaces. This is not done in `Command.__init__` because
subclasses (like `crud.Add`) might need to access other plugins
loaded in self.api to determine what their custom `Command.get_args`
and `Command.get_options` methods should yield.
RO i iÿÿÿÿRP c S s@ | i o2 | i d j o | i S| i d j o d Sd Sd S( Ni i i ( R™ t sortorderRŸ R. ( Ro ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt get_key s
t keyRE RU N( RI R( RO R Ry R. R/ RP R R~ R# RQ RŸ R3 R t mint indext
ValueErrort insertRR t _iter_outputRS t superRN t _on_finalize( R4 t
params_nosortR¸ RQ Rƒ t post j( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRÀ s:
(
"
c c sÐ t | i ƒ t j o/ t d | i t t | i ƒ | i f ƒ ‚ n x„ t | i ƒ D]s \ } } t | t ƒ o t | ƒ } n t | t ƒ p2 t d | i | t t f t | ƒ | f ƒ ‚ n | VqU Wd S( Ns& %s.has_output: need a %r; got a %r: %rs* %s.has_output[%d]: need a %r; got a %r: %r( R% t
has_outputR/ R2 R3 R€ R0 R1 R ( R4 Rƒ t o( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR¾ 8 s ) ,c c s# x | i d ƒ D] } | Vq Wd S( sM
Iterate through parameters for ``Command.args`` namespace.
This method gets called by `HasParam._create_param_namespace()`.
Subclasses can override this to customize how the arguments are
determined. For an example of why this can be useful, see the
`ipalib.crud.Create` subclass.
RO N( R8 ( R4 Ru ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt get_argsF s
c C s’ t } t } x | ƒ D]t } | o! | i o t d | i ƒ ‚ n | o t d | i ƒ ‚ n | i p
t } n | i o
t } q q Wd S( s{
Sanity test for args namespace.
This method gets called by `HasParam._create_param_namespace()`.
s$ %s: required argument after optionals) %s: only final argument can be multivalueN( R# R™ R¼ R3 R R ( R4 RO t optionalR Ru ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt
check_argsS s
c
c sÓ x | i d ƒ D] } | Vq Wx | i D]¢ } t | t t f ƒ o† t d d d d t d ƒ d d d d g ƒVt d
d d
d t d ƒ d d d d g ƒVt d d t d
ƒ d d d d d g ƒVd Sq) Wd S( s'
Iterate through parameters for ``Command.options`` namespace.
This method gets called by `HasParam._create_param_namespace()`.
For commands that return entries two special options are generated:
--all makes the command retrieve/display all attributes
--raw makes the command display attributes as they are stored
Subclasses can override this to customize how the arguments are
determined. For an example of why this can be useful, see the
`ipalib.crud.Create` subclass.
RP t allt cli_namet docsJ Retrieve and print all attributes from the server. Affects command output.t excludet webuit flagst no_outputt rawsB Print entries as stored on the server. Only affects output format.s version?s@ Client version. Used to determine if server will accept request.t no_optionN( R8 RÄ R0 R R
R R R ( R4 Rv RÅ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt get_optionsi s*
c C su d | i } t | t ƒ p& t d | t t | ƒ | f ƒ ‚ n t | i ƒ } t | ƒ } | | j ol | | } | o# t d | t | ƒ | f ƒ ‚ n | | } | o# t d | t | ƒ | f ƒ ‚ q× n x— | i ƒ D]‰ } | | i } | i d j p t | | i ƒ p/ t d | | i | i t | ƒ | f ƒ ‚ n t
| i ƒ o | i | | ƒ qä qä Wd S( sY
Validate the return value to make sure it meets the interface contract.
s %s.validate_output()s %s: need a %r; got a %r: %rs %s: missing keys %r in %rs %s: unexpected keys %r in %rs% %s:
output[%r]: need %r; got %r: %rN( R3 R0 R& R2 R% R| RS R¼ R~ R. R! Rd ( R4 RS t nicet expected_sett
actual_sett missingt extraRÅ Rp ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRi Ž s.
!
#)c c sq x" | i d d d ƒD] } | Vq W| i d j o d Sx0 | i ƒ D]" } d | i j o qG n | VqG Wd S( NRU R5 t hasRÏ ( R8 RQ R. RÎ ( R4 RC ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt get_output_params s
c O s¹ t | t ƒ p d Sd } g } | i ƒ D] } | | i q, ~ } | i d t ƒ o | i d d ƒ t } n t } | i d t ƒ o
d }
n t d „ | i ƒ Dƒ ƒ }
t d „ | i ƒ Dƒ ƒ } xå| i D]Ú} | i | }
d |
i
j o q× n | | } | i ƒ d j o | d j o
d
} n8 | i ƒ d j o$ t | ƒ d j o q× qld
} n t |
t
ƒ o | i | | |
| | ƒ q× t | t t f ƒ o | i | | |
| | ƒ q× t |
t ƒ o | i | | |
| | ƒ q× t | t ƒ o | i | | |
| | ƒ q× t | t ƒ o/ | d j o | i | ƒ q±| i | ƒ q× t | t ƒ o q× t | t ƒ o( | i | d
t | i | i ƒ ƒ q× q× W| S( s
Generic output method. Prints values the output argument according
to their type and self.output.
Entry attributes are labeled and printed in the order specified in
self.output_params. Attributes that aren't present in
self.output_params are not printed unless the command was invokend
with the --all option. Attribute labelling is disabled if the --raw
option was given.
Subclasses can override this method, if custom output is needed.
Ni RÉ t dnRÐ c s s+ x$ | ] } | i t | i ƒ f Vq Wd S( N( R3 RY t label( R’ Ro ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pys Ó s c s s% x | ] } | i | i f Vq Wd S( N( R3 RÎ ( R’ Ro ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pys Ô s t
no_displayRw i t failedRV s %s %%d( R0 R& RU R3 RA R# R½ R R. RS RÎ t lowerR' R
t
print_entriesR/ R‚ R t print_entryRY t
print_summaryt print_indentedt boolt intt print_countRË ( R4 t textuiRS RO RP t rvR Ro t ordert print_allt labelsRÎ RÅ t outpRT ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt output_for_cli· sR
*
,R3 t
takes_argsRÉ RÐ t attrst addattrt delattrR R c c sF x? | i ƒ D]1 } | i | i j o | Vq
h | i d 6Vq
Wd S( s;
Get only options we want exported to JSON
R3 N( RÒ R3 t json_only_presence_options( R4 Rv ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt get_json_options s
c s9 t ‡ f d † ˆ i Dƒ ƒ } t ˆ i ƒ ƒ | d <| S( Nc 3 s( x! | ] } | t ˆ | ƒ f Vq Wd S( N( R" ( R’ t a( R4 ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pys s t
takes_options( R& t json_friendly_attributesR‚ Rò ( R4 t json_dict( ( R4 s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __json__ s N( s result( s names
takes_args( s alls rawRî Rï s delattrs setattrs version(< RJ RK RL R# t finalize_earlyR/ Rô Rí R t
finalize_attrRO RP RQ RR R. R R Rh RS RÄ RU t has_output_paramsR‡ Rg R t
msg_truncatedRl Rr R] RZ R{ Rz R R‹ Re R“ R• R` Ra t _Command__convert_iterR_ R R› Rd RX Rf R³ R´ RÀ R¾ RÆ RÈ RÒ Ri RÙ Rì Rõ Rñ Rò R÷ ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRN p sf '
( 2
%
F
t
LocalOrRemotec B s2 e Z d Z e d d e d ƒ ƒf Z d „ Z RS( s[
A command that is explicitly executed locally or remotely.
This is for commands that makes sense to execute either locally or
remotely to return a perhaps different result. The best example of
this is the `ipalib.plugins.f_misc.env` plugin which returns the
key/value pairs describing the configuration state: it can be
s server?RË s, Forward to server instead of running locallyc O s: | d o | i i o | i | | Ž S| i | | Ž S( sw
Dispatch to forward() or execute() based on ``server`` option.
When running in a client context, this command is executed remotely if
``options['server']`` is true; otherwise it is executed locally.
When running in a server context, this command is always executed
locally and the value of ``options['server']`` is ignored.
R© ( R9 Rc R´ R³ ( R4 RO RP ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRf ) s
( RJ RK RL R R Rô Rf ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRý s t Localc B s e Z d Z d „ Z RS( s™
A command that is explicitly executed locally.
This is for commands that makes sense to execute only locally
such as the help command.
c O s | i | | Ž S( s.
Dispatch to forward() onlly.
( R´ ( R4 RO RP ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRf @ s ( RJ RK RL Rf ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRþ 8 s t Objectc B s¤ e Z e Z e i d ƒ Z e i d ƒ Z e i d ƒ Z e i d ƒ Z e i d ƒ Z
e i d ƒ Z d Z
e ƒ Z d „ Z d „ Z d „ Z d „ Z d
„ Z RS( t backendt methodst
propertiesRQ t primary_keyt params_minus_pkc C sg t | i d ƒ d t d d ƒ| _ t | i d ƒ d t d d ƒ| _ | i d ƒ t d „ | i ƒ ƒ } t | ƒ d j o0 t d | i
d
i d „ | Dƒ ƒ f ƒ ‚ n t | ƒ d j o8 | d | _ t t d
„ | i ƒ ƒ d t ƒ| _
n d | _ | i | _
d | i j o0 | i | i i j o | i i | i | _ n t t | ƒ i ƒ d S( Nt MethodRE t name_attrt attr_namet PropertyRQ c S s | i S( ( R ( Ro ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt ^ s i s) %s (Object) has multiple primary keys: %ss , c s s x | ] } | i Vq Wd S( N( R3 ( R’ Ro ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pys c s i c S s | i S( ( R ( Ro ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR i s Rµ ( R t _Object__get_attrsR# R R RI t filterRQ R( R¼ R3 R\ R R R. Rb t backend_nameRµ R R¿ Rÿ RÀ ( R4 t pkeys( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRÀ V s( !!
$
( &c g sŒ t | ƒ d j o) t | d t t f ƒ o | d } n t | ƒ } x= | i ƒ D]/ } | i | j p
| | j o qU n | VqU Wd S( sA
Yield all Param whose name is not in ``names``.
i i N( R( R0 R R1 t frozensetRQ R3 ( R4 Rx t minusRC ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt params_minust s .
c O s t d | i ƒ ‚ d S( s'
Construct an LDAP DN.
s %s.get_dn()N( R< R3 ( R4 RO t kwargs( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt get_dn€ s c c sV | | i j o d S| i | } x- | ƒ D]" } | i | i j o | Vq, q, Wd S( N( Rb t obj_nameR3 ( R4 R3 RG t plugin( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __get_attrs† s
c c s½ | i i ƒ } xs | i d ƒ D]b } t | ƒ t j o | i d ƒ } n
| i } | | j o | i | ƒ i Vq t | ƒ Vq Wd „ } x( t
| i ƒ d | ƒD] } | i Vq§ Wd S( sR
This method gets called by `HasParam._create_param_namespace()`.
RQ s ?*+c S s. | i i o | i i d j o d Sd Sd S( Ni i i ( RC R™ RŸ R. ( Ro ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR¸ ž s
R¹ N( R t
__todict__R8 R% R1 t rstripR3 R… RC R R~ t
itervalues( R4 t propsRB R¹ R¸ t prop( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt
get_params s
N( RJ RK R# Rø R Rù R R R RQ R R R. R R/ t takes_paramsRÀ R R R
R ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRÿ G s t Attributec B sƒ e Z d Z e Z e i d ƒ Z e i d ƒ Z
d „ Z d „ Z e
e ƒ Z d „ Z e
e ƒ Z d „ Z e
e ƒ Z d „ Z RS( sr
Base class implementing the attribute-to-object association.
`Attribute` plugins are associated with an `Object` plugin to group
a common set of commands that operate on a common set of parameters.
The association between attribute and object is done using a simple
naming convention: the first part of the plugin class name (up to the
first underscore) is the object name, and rest is the attribute name,
as this table shows:
=============== =========== ==============
Class name Object name Attribute name
=============== =========== ==============
noun_verb noun verb
user_add user add
user_first_name user first_name
=============== =========== ==============
For example:
>>> class user_add(Attribute):
... pass
...
>>> instance = user_add()
>>> instance.obj_name
'user'
>>> instance.attr_name
'add'
In practice the `Attribute` class is not used directly, but rather is
only the base class for the `Method` and `Property` classes. Also see
the `Object` class.
sF ^(?P[a-z][a-z0-9]+)_(?P[a-z][a-z0-9]+(?:_[a-z][a-z0-9]+)*)$t _Attribute__objc C sV | i i t | ƒ i ƒ } | i d ƒ | _ | i d ƒ | _ t t | ƒ i ƒ d S( NR t attr(
t
NAME_REGEXt matchR% RJ t groupt _Attribute__obj_namet _Attribute__attr_nameR¿ R t __init__( R4 t m( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR% Ô s c C s | i S( N( R# ( R4 ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __get_obj_nameÛ s c C s | i S( N( R$ ( R4 ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __get_attr_nameß s c C s | i S( s}
Returns the obj instance this attribute is associated with, or None
if no association has been set.
( R ( R4 ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __get_objã s c C s- | i i | i | _ t t | ƒ i ƒ d S( N( Rb Rÿ R R R¿ R RÀ ( R4 ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRÀ ë s ( RJ RK RL R# Rø t ret compileR R Rù R R% t _Attribute__get_obj_namet propertyR t _Attribute__get_attr_nameR t _Attribute__get_objR RÀ ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR ¨ s " R c B s, e Z d Z e Z e Z d „ Z d „ Z RS( s"
A command with an associated object.
A `Method` plugin must have a corresponding `Object` plugin. The
association between object and method is done through a simple naming
convention: the first part of the method name (up to the first under
score) is the object name, as the examples in this table show:
============= =========== ==============
Method name Object name Attribute name
============= =========== ==============
user_add user add
noun_verb noun verb
door_open_now door open_now
============= =========== ==============
There are three different places a method can be accessed. For example,
say you created a `Method` plugin and its corresponding `Object` plugin
like this:
>>> from ipalib import create_api
>>> api = create_api()
>>> class user_add(Method):
... def run(self):
... return dict(result='Added the user!')
...
>>> class user(Object):
... pass
...
>>> api.register(user_add)
>>> api.register(user)
>>> api.finalize()
First, the ``user_add`` plugin can be accessed through the ``api.Method``
namespace:
>>> list(api.Method)
['user_add']
>>> api.Method.user_add() # Will call user_add.run()
{'result': 'Added the user!'}
Second, because `Method` is a subclass of `Command`, the ``user_add``
plugin can also be accessed through the ``api.Command`` namespace:
>>> list(api.Command)
['user_add']
>>> api.Command.user_add() # Will call user_add.run()
{'result': 'Added the user!'}
And third, ``user_add`` can be accessed as an attribute on the ``user``
`Object`:
>>> list(api.Object)
['user']
>>> list(api.Object.user.methods)
['add']
>>> api.Object.user.methods.add() # Will call user_add.run()
{'result': 'Added the user!'}
The `Attribute` base class implements the naming convention for the
attribute-to-object association. Also see the `Object` and the
`Property` classes.
c C s t t | ƒ i ƒ d S( N( R¿ R R% ( R4 ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR% 3 s c c s² x3 | i i ƒ D]" } d | i j o q n | Vq WxP | i ƒ D]B } | i t | i i ƒ j o d | i j o qC n | VqC qC Wx" | i d d d ƒD] } | VqŸ Wd S( NRÏ RU R5 RØ ( R RQ RÎ R3 R‚ R8 ( R4 RC ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRÙ 6 s
( RJ RK RL R# t extra_options_firstt extra_args_firstR% RÙ ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR ð s
? R c B s; e Z e Z d Z d Z d Z d „ Z d „ Z d „ Z
RS( c C s• t t | ƒ i ƒ d | _ t t | i ƒ d d „ ƒƒ | _ t t | i ƒ d d „ ƒƒ | _
t | i
ƒ } | i | i
| i | Ž | _ d S( NR¹ c S s
t | d ƒ S( RJ ( R" ( R+ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR P s c S s | d S( i ( ( t keyvalue( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR S s ( R¿ R R% R. RÛ R/ R~ t _Property__rules_itert rulest _Property__kw_iterR R& t klassR RC ( R4 RŒ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR% J s !!c c sU xN | i i D]@ \ } } } t | | d ƒ d j o | t | | ƒ f Vq
q
Wd S( N( R6 R R" R. ( R4 R¹ t kindRœ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __kw_iterX s
c c s} xv t | i ƒ D]e } | i d ƒ o q n t | i | ƒ } t | ƒ o) t | | ƒ } t | ƒ o | Vqu q q Wd S( s
Iterates through the attributes in this instance to retrieve the
methods implementing validation rules.
R N( t dirt __class__t
startswithR" R$ ( R4 R3 t base_attrR ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt __rules_iter] s
N( RJ RK R R6 R. Rœ RŸ t
normalizerR% R5 R3 ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR D s t Updaterc B s e Z d Z d „ Z d „ Z RS( sš
An LDAP update with an associated object (always update).
All plugins that subclass from `Updater` will be automatically available
as a server update function.
Plugins that subclass from Updater are registered in the ``api.Updater``
namespace. For example:
>>> from ipalib import create_api
>>> api = create_api()
>>> class my(Object):
... pass
...
>>> api.register(my)
>>> class my_update(Updater):
... pass
...
>>> api.register(my_update)
>>> api.finalize()
>>> list(api.Updater)
['my_update']
>>> api.Updater.my_update # doctest:+ELLIPSIS
ipalib.frontend.my_update()
c C s t t | ƒ i ƒ d S( N( R¿ R? R% ( R4 ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR% … s c K s | i d | i ƒ | i | S( Ns raw: %s( R[ R3 R³ ( R4 RP ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyRl ˆ s
( RJ RK RL R% Rl ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyR? k s (4 RL R* t inspectt baseR R R t plugableR R t
parametersR R R R R R
RS R R R
t textR R Rn R R R R R R R R t constantsR t ipapython.versionR t distutilsR R R R$ R' R, RN Rý Rþ Rÿ R R R R? ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/frontend.pyt s8 . 4 ÿ -ÿ ÿ « aHT'