#xPc @ s d Z d d k Z d d k Z d d k Z d d k Z d d k Z d d k l Z d d k Z d d k Z d d k Z d d k
l Z d d k Z d d k
Z
d d k
l Z d d k l Z l Z l Z l Z l Z d d k l Z d d k Td 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 S( s
Plugin framework.
The classes in this module make heavy use of Python container emulation. If
you are unfamiliar with this Python feature, see
http://docs.python.org/ref/sequence-types.html
iN( t path( t Env( t _( t ReadOnlyt NameSpacet lockt islockedt
check_name( t DEFAULT_CONFIG( t *s %s: need a %r; got a %r: %rc C sO t | d d d j o t St | i d d d j o t S| i i d j S( sv
If the object has self.env.mode defined and that mode is
production return True, otherwise return False.
t envt modet
productionN( t getattrt Nonet FalseR
R ( t obj( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt is_production_mode0 s
t SetProxyc B s2 e Z d Z d Z d Z d Z d Z RS( sc
A read-only container with set/sequence behaviour.
This container acts as a proxy to an actual set-like object (a set,
frozenset, or dict) that is passed to the constructor. To the extent
possible in Python, this underlying set-like object cannot be modified
through the SetProxy... which just means you wont do it accidentally.
c C sj t t t f } t | | j o t d t | | f n | | _ t | p t | n d S( sR
:param s: The target set-like object (a set, frozenset, or dict)
s %r not in %rN( t sett frozensett dictt typet TypeErrort _SetProxy__sR R ( t selft st allowed( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __init__E s
c C s
t | i S( s?
Return the number of items in this container.
( t lenR ( R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __len__P s c c s# x t | i D] } | Vq Wd S( s<
Iterate (in ascending order) through keys.
N( t sortedR ( R t key( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __iter__V s c C s
| | i j S( sv
Return True if this container contains ``key``.
:param key: The key to test for membership.
( R ( R R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __contains__] s ( t __name__t
__module__t __doc__R R R! R" ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR < s
t DictProxyc B s) e Z d Z d Z d Z d Z RS( sd
A read-only container with mapping behaviour.
This container acts as a proxy to an actual mapping object (a dict) that
is passed to the constructor. To the extent possible in Python, this
underlying mapping object cannot be modified through the DictProxy...
which just means you wont do it accidentally.
Also see `SetProxy`.
c C sV t | t j o t d t | t f n | | _ t t | i | d S( s>
:param d: The target mapping object (a dict)
s %r is not %rN( R R R t
_DictProxy__dt superR& R ( R t d( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR q s c C s | i | S( s|
Return the value corresponding to ``key``.
:param key: The key of the value you wish to retrieve.
( R' ( R R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __getitem__z s c c s! x | D] } | i | Vq Wd S( sE
Iterate (in ascending order by key) through values.
N( R' ( R R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __call__ s ( R# R$ R% R R* R+ ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR& f s
t MagicDictc B s e Z d Z d Z RS( s
A mapping container whose values can be accessed as attributes.
For example:
>>> magic = MagicDict({'the_key': 'the value'})
>>> magic['the_key']
'the value'
>>> magic.the_key
'the value'
This container acts as a proxy to an actual mapping object (a dict) that
is passed to the constructor. To the extent possible in Python, this
underlying mapping object cannot be modified through the MagicDict...
which just means you wont do it accidentally.
Also see `DictProxy` and `SetProxy`.
c C s6 y | | SWn# t j
o t d | n Xd S( s
Return the value corresponding to ``name``.
:param name: The name of the attribute you wish to retrieve.
s no magic attribute %rN( t KeyErrort AttributeError( R t name( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __getattr__ s ( R# R$ R% R0 ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR, s t Pluginc B s e Z d Z e Z d Z d Z d Z e e Z
d Z d Z d Z
d e f d YZ d Z d Z d
Z RS( s%
Base class for all plugins.
c C sh d | _ t | _ t | _ t i | _ | i } | i | _
| i | _ d | i | i
f | _
t d | i D | _ t | i | _ | i i p d | i
| _ n) t | i i d d d i | _ t i | t | i d j o t i | i
d | _ n t | i t i p6 t! t" | i
d t i t# | i | i f n d S( Ns %s.%sc s s) x" | ] } d | i | i f Vq Wd S( s %s.%sN( R$ R# ( t .0t b( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pys s s <%s>s
i i s .label($ R t _Plugin__apiR t _Plugin__finalize_calledt _Plugin__finalizedt threadingt RLockt _Plugin__finalize_lockt __class__R# R/ R$ t modulet fullnamet tuplet __bases__t basesR R% t doct msgt summaryt unicodet splitt stript log_mgrt
get_loggert Truet labelt textt FixMet
isinstancet LazyTextR t
TYPE_ERRORR ( R t cls( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR s0
(
c C s | i S( s
Return `API` instance passed to `set_api()`.
If `set_api()` has not yet been called, None is returned.
( R4 ( R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __get_api s c C se | i i i zJ | i o d St | _ | i t | _ t | p t | n Wd QXd S( s
Finalize plugin initialization.
This method calls `_on_finalize()` and locks the plugin object.
Subclasses should not override this method. Custom finalization is done
in `_on_finalize()`.
N( R9 t __exit__t __enter__R5 RH t _on_finalizeR6 R R ( R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt finalize s
c C s d S( s
Do custom finalization.
This method is called from `finalize()`. Subclasses can override this
method in order to add custom finalization.
N( ( R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyRS s c C s7 | i i i z | i p | i n Wd QXd S( sR
Finalize plugin initialization if it has not yet been finalized.
N( R9 RQ RR R6 RT ( R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt ensure_finalized s
t
finalize_attrc B s) e Z d Z d Z d d Z d Z RS( s/
Create a stub object for plugin attribute that isn't set until the
finalization of the plugin initialization.
When the stub object is accessed, it calls `ensure_finalized()` to make
sure the plugin initialization is finalized. The stub object is expected
to be replaced with the actual attribute value during the finalization
(preferably in `_on_finalize()`), otherwise an `AttributeError` is
raised.
This is used to implement on-demand finalization of plugin
initialization.
R/ t valuec C s | | _ | | _ d S( N( R/ RW ( R R/ RW ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR s c C sy | d j p | i d j o | i S| i y t | | i SWn/ t j
o# t d | i | i f n Xd S( Ns7 attribute '%s' of plugin '%s' was not set in finalize()( R t apiRW RU R
R/ t RuntimeErrorR. ( R R RO ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __get__ s
( s names valueN( R# R$ R% t __slots__R R RZ ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyRV s
c C s | | _ t | t p d Sx" | D] } t | | | | q% Wx; d D]3 } t | | o t | | t | | qJ qJ Wd S( s2
Set reference to `API` instance.
NR
t context( s envs context( R4 RL t APIt setattrt hasattrR
( R RX R/ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt set_api# s c G sY | f | } | i d | t i | } | d j o t i d | d | n d S( s
Call ``executable`` with ``args`` using subprocess.call().
If the call exits with a non-zero exit status,
`ipalib.errors.SubprocessError` is raised, from which you can retrieve
the exit code by checking the SubprocessError.returncode attribute.
This method does *not* return what ``executable`` sent to stdout... for
that, use `Plugin.callread()`.
s
Calling %ri t
returncodet argvN( t debugt
subprocesst callt errorst SubprocessError( R t
executablet argsRb t code( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyRe 4 s
c C s d | i i | i i f S( s
Return 'module_name.class_name()' representation.
This representation could be used to instantiate this Plugin
instance given the appropriate environment.
s %s.%s()( R: R$ R# ( R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __repr__E s N( R# R$ R% RH t finalize_earlyR RI R t _Plugin__get_apit propertyRX RT RS RU t objectRV R` Re Rk ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR1 s $ t Registrarc B s5 e Z d Z d Z d Z d Z e d Z RS( s
Collects plugin classes as they are registered.
The Registrar does not instantiate plugins... it only implements the
override logic and stores the plugins in a namespace per allowed base
class.
The plugins are instantiated when `API.finalize()` is called.
c G sK t d | D | _ t | _ t t | i t | i d S( sw
:param allowed: Base classes from which plugins accepted by this
Registrar must subclass.
c s s x | ] } | h f Vq Wd S( N( ( R2 t base( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pys a s N( R t _Registrar__allowedR t _Registrar__registeredR( Rp R t _Registrar__base_iter( R R ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR \ s c c sp xi | i i D]X \ } } t | p n | i } t | p n t | | t | | | f Vq Wd S( N( Rr t iteritemsR R# R^ R, ( R Rq t sub_dR/ ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __base_iterg s
c c s t | p n t } xB | i i D]1 \ } } t | | o t } | | f Vq' q' W| p% t i d | d | i i n d S( s
Iterates through allowed bases that ``klass`` is a subclass of.
Raises `errors.PluginSubclassError` if ``klass`` is not a subclass of
any allowed base.
:param klass: The plugin class to find bases for.
t pluginR? N( R R Rr Ru t
issubclassRH Rf t PluginSubclassErrort keys( R t klasst foundRq Rv ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt __findbasesq s
c C s t i | p t d | n | | i j o t i d | n x | i | D] \ } } | i | j o3 | p( t i d | i d | i d | q n0 | o( t i d | i d | i d | n | | | i s ( R R| R# R/ R R$ R; Rx R= R? R R ( R t p( R ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR s
( R# R$ R ( ( R ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR s c 3 s x | D] } | j o | | s t _API__finalizedc 3 s x | ] } | Vq Wd S( N( ( R2 R ( R ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pys s R c 3 s x | ] } | Vq Wd S( N( ( R2 R ( R ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pys s N( R R Ro R R R R R
R R R t
itervaluesR R` RU RH R= ( R R t production_modeR/ Rq t namespaceR ( ( R R R R R R s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyRT s@
"
N( R# R$ R% R R R R R R R R R R RT ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyR] s <+ .( R% t reR R R7 R R Rd R Rf t configR R RJ R Rq R R R R R t constantsR t ipapython.ipa_log_managerRN R R R& R, R1 Rp R] ( ( ( s3 /usr/lib/python2.6/site-packages/ipalib/plugable.pyt s0 (
*$ ]