Ñò
Ã#xPc
@ sÐ d Z d d k l Z l Z d d k l Z d d k Z d d k l Z d d k Z d d k l
Z
d d k l Z d d k
l Z d d k l Z d d
k l Z l Z l Z l Z d e f d „ ƒ YZ d S(
sp
Process-wide static configuration and environment.
The standard run-time instance of the `Env` class is initialized early in the
`ipalib` process and is then locked into a read-only state, after which no
further changes can be made to the environment throughout the remaining life
of the process.
For the per-request thread-local information, see `ipalib.request`.
iÿÿÿÿ( t RawConfigParsert ParsingError( t NoneTypeN( t path( t getfqdn( t DN( t
check_name( t CONFIG_SECTION( t
TYPE_ERRORt OVERRIDE_ERRORt SET_ERRORt DEL_ERRORt Envc B s¿ e Z d Z e 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 RS( s•
Store and retrieve environment variables.
First an foremost, the `Env` class provides a handy container for
environment variables. These variables can be both set *and* retrieved
either as attributes *or* as dictionary items.
For example, you can set a variable as an attribute:
>>> env = Env()
>>> env.attr = 'I was set as an attribute.'
>>> env.attr
u'I was set as an attribute.'
>>> env['attr'] # Also retrieve as a dictionary item
u'I was set as an attribute.'
Or you can set a variable as a dictionary item:
>>> env['item'] = 'I was set as a dictionary item.'
>>> env['item']
u'I was set as a dictionary item.'
>>> env.item # Also retrieve as an attribute
u'I was set as a dictionary item.'
The variable names must be valid lower-case Python identifiers that neither
start nor end with an underscore. If your variable name doesn't meet these
criteria, a ``ValueError`` will be raised when you try to set the variable
(compliments of the `base.check_name()` function). For example:
>>> env.BadName = 'Wont work as an attribute'
Traceback (most recent call last):
...
ValueError: name must match '^[a-z][_a-z0-9]*[a-z0-9]$|^[a-z]$'; got 'BadName'
>>> env['BadName'] = 'Also wont work as a dictionary item'
Traceback (most recent call last):
...
ValueError: name must match '^[a-z][_a-z0-9]*[a-z0-9]$|^[a-z]$'; got 'BadName'
The variable values can be ``str``, ``int``, or ``float`` instances, or the
``True``, ``False``, or ``None`` constants. When the value provided is an
``str`` instance, some limited automatic type conversion is performed, which
allows values of specific types to be set easily from configuration files or
command-line options.
So in addition to their actual values, the ``True``, ``False``, and ``None``
constants can be specified with an ``str`` equal to what ``repr()`` would
return. For example:
>>> env.true = True
>>> env.also_true = 'True' # Equal to repr(True)
>>> env.true
True
>>> env.also_true
True
Note that the automatic type conversion is case sensitive. For example:
>>> env.not_false = 'false' # Not equal to repr(False)!
>>> env.not_false
u'false'
If an ``str`` value looks like an integer, it's automatically converted to
the ``int`` type. Likewise, if an ``str`` value looks like a floating-point
number, it's automatically converted to the ``float`` type. For example:
>>> env.lucky = '7'
>>> env.lucky
7
>>> env.three_halves = '1.5'
>>> env.three_halves
1.5
Leading and trailing white-space is automatically stripped from ``str``
values. For example:
>>> env.message = ' Hello! ' # Surrounded by double spaces
>>> env.message
u'Hello!'
>>> env.number = ' 42 ' # Still converted to an int
>>> env.number
42
>>> env.false = ' False ' # Still equal to repr(False)
>>> env.false
False
Also, empty ``str`` instances are converted to ``None``. For example:
>>> env.empty = ''
>>> env.empty is None
True
`Env` variables are all set-once (first-one-wins). Once a variable has been
set, trying to override it will raise an ``AttributeError``. For example:
>>> env.date = 'First'
>>> env.date = 'Second'
Traceback (most recent call last):
...
AttributeError: cannot override Env.date value u'First' with 'Second'
An `Env` instance can be *locked*, after which no further variables can be
set. Trying to set variables on a locked `Env` instance will also raise
an ``AttributeError``. For example:
>>> env = Env()
>>> env.okay = 'This will work.'
>>> env.__lock__()
>>> env.nope = 'This wont work!'
Traceback (most recent call last):
...
AttributeError: locked: cannot set Env.nope to 'This wont work!'
`Env` instances also provide standard container emulation for membership
testing, counting, and iteration. For example:
>>> env = Env()
>>> 'key1' in env # Has key1 been set?
False
>>> env.key1 = 'value 1'
>>> 'key1' in env
True
>>> env.key2 = 'value 2'
>>> len(env) # How many variables have been set?
2
>>> list(env) # What variables have been set?
['key1', 'key2']
Lastly, in addition to all the handy container functionality, the `Env`
class provides high-level methods for bootstraping a fresh `Env` instance
into one containing all the run-time and configuration information needed
by the built-in freeIPA plugins.
These are the `Env` bootstraping methods, in the order they must be called:
1. `Env._bootstrap()` - initialize the run-time variables and then
merge-in variables specified on the command-line.
2. `Env._finalize_core()` - merge-in variables from the configuration
files and then merge-in variables from the internal defaults, after
which at least all the standard variables will be set. After this
method is called, the plugins will be loaded, during which
third-party plugins can merge-in defaults for additional variables
they use (likely using the `Env._merge()` method).
3. `Env._finalize()` - one last chance to merge-in variables and then
the instance is locked. After this method is called, no more
environment variables can be set during the remaining life of the
process.
However, normally none of these three bootstraping methods are called
directly and instead only `plugable.API.bootstrap()` is called, which itself
takes care of correctly calling the `Env` bootstrapping methods.
c K sE t i | d h ƒ t i | d t ƒ ƒ | o | i | n d S( Nt _Env__dt
_Env__done( t objectt __setattr__t sett _merge( t selft
initialize( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __init__Ê s c C sA | i t j o t d | i i ƒ ‚ n t i | d t ƒ d S( s9
Prevent further changes to environment.
s %s.__lock__() already calledt _Env__lockedN( R t Truet
StandardErrort __class__t __name__R R ( R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __lock__Ð s c C s | i S( s,
Return ``True`` if locked.
( R ( R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __islocked__Ú s c C s | | | >> env = Env()
>>> env.name = 'A value'
>>> del env.name
Traceback (most recent call last):
...
AttributeError: locked: cannot delete Env.name
N( R# R R R ( R R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __delattr__ s
c C s
| | i j S( sS
Return True if instance contains ``key``; otherwise return False.
( R
( R R3 ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __contains__& s c C s
t | i ƒ S( s;
Return number of variables currently set.
( t lenR
( R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __len__, s c c s# x t | i ƒ D] } | Vq Wd S( s:
Iterate through keys in ascending order.
N( t sortedR
( R R3 ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __iter__2 s c K sX d } x? | i ƒ D]1 \ } } | | j o | | | <| d 7} q q W| t | ƒ f S( s
Merge variables from ``kw`` into the environment.
Any variables in ``kw`` that have already been set will be ignored
(meaning this method will *not* try to override them, which would raise
an exception).
This method returns a ``(num_set, num_total)`` tuple containing first
the number of variables that were actually set, and second the total
number of variables that were provided.
For example:
>>> env = Env()
>>> env._merge(one=1, two=2)
(2, 2)
>>> env._merge(one=1, three=3)
(1, 2)
>>> env._merge(one=1, two=2, three=3)
(0, 3)
Also see `Env._merge_from_file()`.
:param kw: Variables provides as keyword arguments.
i i ( t iteritemsR9 ( R t kwt iR3 R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyR 9 s
c C s% t i | ƒ | j o t d | ƒ ‚ n t i | ƒ p d St ƒ } y | i | ƒ Wn t j
o d SX| i t ƒ p | i t ƒ n | i
t ƒ } t | ƒ d j o d Sd } x9 | D]1 \ } } | | j o | | | <| d 7} qÅ qÅ Wd | j o t | d >> env = Env()
>>> env._merge_from_file('my/config.conf')
Traceback (most recent call last):
...
ValueError: config_file must be an absolute path; got 'my/config.conf'
Also see `Env._merge()`.
:param config_file: Absolute path of the configuration file to load.
s, config_file must be an absolute path; got %rNi i t
config_loaded( i i (
R t abspathR/ t isfileR t readR t has_sectionR t add_sectiont itemsR9 R ( R t config_filet parserRF R? R3 R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt _merge_from_fileZ s0
c G s7 | | j o& | | d j o t i | | | ΠSd S( s
Append path components in ``parts`` to base path ``self[key]``.
For example:
>>> env = Env()
>>> env.home = '/people/joe'
>>> env._join('home', 'Music', 'favourites')
u'/people/joe/Music/favourites'
N( R R t join( R R3 t parts( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt _join s c C sD | | i j o t d | i i | f ƒ ‚ n | i i | ƒ d S( Ns %s.%s() already called( R R R R t add( R R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __doing s c C s( | | i j o t | | ƒ ƒ n d S( N( R t getattr( R R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt __do_if_not_done¤ s c C s
| | i j S( N( R ( R R ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt _isdone¨ s c K s
| i d ƒ t i t i t ƒ ƒ | _ t i | i ƒ | _ t i t i d ƒ | _ t i | i ƒ | _
t i i
d d ƒ | _ | i | d | j oL | i
| i j o, t i t i | i
d ƒ ƒ o
t | _ qé t | _ n | i o d | j o
d | _ n d | j o | i d d
ƒ | _ n d | j o
d | _ n d
| j o6 | i o | i | _ qt i d d d ƒ | _ n d | j o | i d
d | i ƒ | _ n d | j o | i d
d ƒ | _ n d | j o | i d j | _ n d S( sˆ
Initialize basic environment.
This method will perform the following steps:
1. Initialize certain run-time variables. These run-time variables
are strictly determined by the external environment the process
is running in; they cannot be specified on the command-line nor
in the configuration files.
2. Merge-in the variables in ``overrides`` by calling
`Env._merge()`. The intended use of ``overrides`` is to merge-in
variables specified on the command-line.
3. Intelligently fill-in the *in_tree*, *context*, *conf*, and
*conf_default* variables if they haven't been set already.
Also see `Env._finalize_core()`, the next method in the bootstrap
sequence.
:param overrides: Variables specified via command-line options.
t
_bootstrapi t HOMEt in_trees setup.pyt modet developert dot_ipat homes .ipat contextt defaultt confdirt /t etct ipat confs %s.conft conf_defaults default.conft plugins_on_demandt cliN( t _Env__doingR t dirnameRA t __file__t ipalibt
site_packagest syst argvt scriptt bint ost environt getR RX R RB RJ R RT R RU RL RW RY R[ R_ R` Ra ( R t overrides( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyRR « s8
c K s | i d ƒ | i d ƒ | i i d d ƒ d j o$ | i | i ƒ | i | i ƒ n d | j o | i d j | _ n d | j oM | i
p | i o | i d d ƒ | _ q× t
i d
d d d ƒ | _ n d | j o | i d d
| i ƒ | _ n | i | d S( s„
Complete initialization of standard IPA environment.
This method will perform the following steps:
1. Call `Env._bootstrap()` if it hasn't already been called.
2. Merge-in variables from the configuration file ``self.conf``
(if it exists) by calling `Env._merge_from_file()`.
3. Merge-in variables from the defaults configuration file
``self.conf_default`` (if it exists) by calling
`Env._merge_from_file()`.
4. Intelligently fill-in the *in_server* , *logdir*, and *log*
variables if they haven't already been set.
5. Merge-in the variables in ``defaults`` by calling `Env._merge()`.
In normal circumstances ``defaults`` will simply be those
specified in `constants.DEFAULT_CONFIG`.
After this method is called, all the environment variables used by all
the built-in plugins will be available. As such, this method should be
called *before* any plugins are loaded.
After this method has finished, the `Env` instance is still writable
so that 3rd-party plugins can set variables they may require as the
plugins are registered.
Also see `Env._finalize()`, the final method in the bootstrap sequence.
:param defaults: Internal defaults for all built-in variables.
t _finalize_coreRR RU t dummyt in_servert servert logdirRW t logR\ t varR^ s %s.logN( Rc t _Env__do_if_not_doneR
Rn R RI R_ R` RY Rr RT RL Rt R RJ Ru R ( R t defaults( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyRp ö s "
c K s5 | i d ƒ | i d ƒ | i | | i ƒ d S( sV
Finalize and lock environment.
This method will perform the following steps:
1. Call `Env._finalize_core()` if it hasn't already been called.
2. Merge-in the variables in ``lastchance`` by calling
`Env._merge()`.
3. Lock this `Env` instance, after which no more environment
variables can be set on this instance. Aside from unit-tests
and example code, normally only one `Env` instance is created,
which means that after this step, no more variables can be set
during the remaining life of the process.
This method should be called after all plugins have been loaded and
after `plugable.API.finalize()` has been called.
:param lastchance: Any final variables to merge-in before locking.
t _finalizeRp N( Rc Rw R R ( R t
lastchance( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyRy 1 s
( R t
__module__t __doc__R R R R R R R5 R6 R7 R8 R: R< R RI RL Rc Rw RQ RR Rp Ry ( ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyR - s* ™
' ! 5 K ;( R| t ConfigParserR R t typesR Rl R Rh t socketR t ipapython.dnR t baseR t constantsR R R R
R R R ( ( ( s1 /usr/lib/python2.6/site-packages/ipalib/config.pyt s "