Ñò
Ã#xPc @ sí d Z d d k l Z l Z d d k Z d d k Z d d k Z d d k 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 i
f d „ ƒ YZ d S( sâ
Base classes for standard CRUD operations.
These base classes are for `Method` plugins that provide standard
Create, Retrieve, Updated, and Delete operations (CRUD) for their corresponding
`Object` plugin. In particuar, these base classes provide logic to
automatically create the plugin args and options by inspecting the params on
their corresponding `Object` plugin. This provides a single point of definition
for LDAP attributes and enforces a simple, consistent API for CRUD operations.
For example, say we want CRUD operations on a hypothetical "user" entry. First
we need an `Object` plugin:
>>> from ipalib import Object, Str
>>> class user(Object):
... takes_params = (
... Str('login', primary_key=True),
... Str('first'),
... Str('last'),
... Str('ipauniqueid', flags=['no_create', 'no_update']),
... )
...
Next we need `Create`, `Retrieve`, `Updated`, and `Delete` plugins, and
optionally a `Search` plugin. For brevity, we'll just define `Create` and
`Retrieve` plugins:
>>> from ipalib import crud
>>> class user_add(crud.Create):
... pass
...
>>> class user_show(crud.Retrieve):
... pass
...
Now we'll register the plugins and finalize the `plugable.API` instance:
>>> from ipalib import create_api
>>> api = create_api()
>>> api.register(user)
>>> api.register(user_add)
>>> api.register(user_show)
>>> api.finalize()
First, notice that our ``user`` `Object` has the params we defined with the
``takes_params`` tuple:
>>> list(api.Object.user.params)
['login', 'first', 'last', 'ipauniqueid']
>>> api.Object.user.params.login
Str('login', primary_key=True)
Although we defined neither ``takes_args`` nor ``takes_options`` for our
``user_add`` plugin, the `Create` base class automatically generated them for
us:
>>> list(api.Command.user_add.args)
['login']
>>> list(api.Command.user_add.options)
['first', 'last', 'all', 'raw', 'version']
Notice that ``'ipauniqueid'`` isn't included in the options for our ``user_add``
plugin. This is because of the ``'no_create'`` flag we used when defining the
``ipauniqueid`` param. Often times there are LDAP attributes that are
automatically created by the server and therefor should not be supplied as an
option to the `Create` plugin. Often these same attributes shouldn't be
update-able either, in which case you can also supply the ``'no_update'`` flag,
as we did with our ``ipauniqueid`` param. Lastly, you can also use the ``'no_search'`` flag for attributes that shouldn't be search-able (because, for
example, the attribute isn't indexed).
As with our ``user_add` plugin, we defined neither ``takes_args`` nor
``takes_options`` for our ``user_show`` plugin; instead the `Retrieve` base
class created them for us:
>>> list(api.Command.user_show.args)
['login']
>>> list(api.Command.user_show.options)
['all', 'raw', 'version']
As you can see, `Retrieve` plugins take a single argument (the primary key) and
no options. If needed, you can still specify options for your `Retrieve` plugin
with a ``takes_options`` tuple.
Flags like ``'no_create'`` remove LDAP attributes from those that can be
supplied as *input* to a `Method`, but they don't effect the attributes that can
be returned as *output*. Regardless of what flags have been used, the output
entry (or list of entries) can contain all the attributes defined on the
`Object` plugin (in our case, the above ``user.params``).
For example, compare ``user.params`` with ``user_add.output_params`` and
``user_show.output_params``:
>>> list(api.Object.user.params)
['login', 'first', 'last', 'ipauniqueid']
>>> list(api.Command.user_add.output_params)
['login', 'first', 'last', 'ipauniqueid']
>>> list(api.Command.user_show.output_params)
['login', 'first', 'last', 'ipauniqueid']
Note that the above are all equal.
iÿÿÿÿ( t Methodt ObjectNt Createc B s) e Z d Z e i Z d „ Z d „ Z RS( s
Create a new entry.
c c s, | i i o | i i i d t ƒ Vn d S( Nt attribute( t objt primary_keyt clonet True( t self( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyt get_args… s
c c sþ | i o) x& t t | ƒ i ƒ D] } | Vq Wn x‘ | i i | i ƒ D]z } d | i j } d | i j o qI n d | i j o- | i d | d t d t d t d t
ƒ VqI | i d | ƒ VqI W| i p) x& t t | ƒ i ƒ D] } | Vqç Wn d S( Nt virtual_attributet no_createt
ask_createR t queryt requiredt autofillt alwaysask( t extra_options_firstt superR t get_optionsR t params_minust argst flagsR t FalseR ( R t optionR ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR ‰ s$
( t __name__t
__module__t __doc__t outputt standard_entryt
has_outputR R ( ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR ~ s t PKQueryc B s e Z d Z d „ Z RS( s<
Base class for `Retrieve`, `Update`, and `Delete`.
c c s2 | i i o! | i i i d t d t ƒ Vn d S( NR R
( R R R R ( R ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR ¢ s
( R R R R ( ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR s t Retrievec B s e Z d Z e i Z RS( s/
Retrieve an entry by its primary key.
( R R R R R R ( ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR © s t Updatec B s e Z d Z e i Z d „ Z RS( s4
Update one or more attributes on an entry.
c c sp | i o) x& t t | ƒ i ƒ D] } | Vq Wn x| i i ƒ D]ò } | i } d | i j } | i o | i d g ƒ } n d | i j o qC n d | i j o3 | i d | d t
d t
d t
d t d
| ƒ VqC d | i j o' | i d | d t d t
d
| ƒ VqC | i d | d t
d t
d
| ƒ VqC W| i p) x& t t | ƒ i ƒ D] } | VqYWn d S( NR
t nonemptyt no_updatet
ask_updateR R
R R R R t
req_update( R R R! R R t params_minus_pkR R t unionR R R ( R R t new_flagsR ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR ¸ s4
( R R R R R R R ( ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR! ± s t Deletec B s e Z d Z e i Z RS( s%
Delete one or more entries.
( R R R R t standard_deleteR ( ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR) Ù s t Searchc B s) e Z d Z e i Z d „ Z d „ Z RS( sB
Retrieve all entries that match a given search criteria.
c c s t i d ƒ Vd S( Ns criteria?( t
parameterst Str( R ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR è s c c sV | i o) x& t t | ƒ i ƒ D] } | Vq Wn xé | i i | i ƒ D]Ò } d | i j } d | i j o qI n d | i j o- | i d | d t d t
d t
d t ƒ VqI t | t i
ƒ o3 | i | i t i d | d t d t
d t
ƒVqI | i d | d t d t
d t
ƒ VqI W| i p) x& t t | ƒ i ƒ D] } | Vq?Wn d S( NR
t no_searcht
ask_searchR R
R R R ( R R R+ R R R R R R R R t
isinstanceR, t Flagt clone_retypet namet Bool( R R R ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR ë s.
( R R R R t standard_list_of_entriesR R R ( ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR+ á s t CrudBackendc B s; e Z d Z d „ Z d „ Z d „ Z d „ Z d „ Z RS( s7
Base class defining generic CRUD backend API.
c K s t d | i ƒ ‚ d S( sa
Create a new entry.
This method should take key word arguments representing the
attributes the created entry will have.
If this methods constructs the primary_key internally, it should raise
an exception if the primary_key was passed. Likewise, if this method
requires the primary_key to be passed in from the caller, it should
raise an exception if the primary key was *not* passed.
This method should return a dict of the exact entry as it was created
in the backing store, including any automatically created attributes.
s %s.create()N( t NotImplementedErrorR3 ( R t kw( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyt create s c C s t d | i ƒ ‚ d S( sÌ
Retrieve an existing entry.
This method should take a two arguments: the primary_key of the
entry in question and a list of the attributes to be retrieved.
If the list of attributes is None then all non-operational
attributes will be returned.
If such an entry exists, this method should return a dict
representing that entry. If no such entry exists, this method
should return None.
s
%s.retrieve()N( R7 R3 ( R R t
attributes( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyt retrieve s
c K s t d | i ƒ ‚ d S( s—
Update an existing entry.
This method should take one required argument, the primary_key of the
entry to modify, plus optional keyword arguments for each of the
attributes being updated.
This method should return a dict representing the entry as it now
exists in the backing store. If no such entry exists, this method
should return None.
s %s.update()N( R7 R3 ( R R R8 ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyt update+ s c C s t d | i ƒ ‚ d S( s“
Delete an existing entry.
This method should take one required argument, the primary_key of the
entry to delete.
s %s.delete()N( R7 R3 ( R R ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyt delete9 s c K s t d | i ƒ ‚ d S( s!
Return entries matching specific criteria.
This method should take keyword arguments representing the search
criteria. If a key is the name of an entry attribute, the value
should be treated as a filter on that attribute. The meaning of
keys outside this namespace is left to the implementation.
This method should return and iterable containing the matched
entries, where each entry is a dict. If no entries are matched,
this method should return an empty iterable.
s %s.search()N( R7 R3 ( R R8 ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyt searchB s
( R R R R9 R; R< R= R> ( ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyR6 s ( R t frontendR R t backendR, R R R R R! R) R+ t ConnectibleR6 ( ( ( s/ /usr/lib/python2.6/site-packages/ipalib/crud.pyt x s 0 (%