mirror of
https://salsa.debian.org/freeipa-team/freeipa.git
synced 2025-02-25 18:55:28 -06:00
Yet more small docstring cleanup in Env
This commit is contained in:
parent
f7cae9a27c
commit
7766f0be61
@ -42,7 +42,7 @@ class Env(object):
|
|||||||
environment variables. These variables can be both set *and* retrieved
|
environment variables. These variables can be both set *and* retrieved
|
||||||
either as attributes *or* as dictionary items.
|
either as attributes *or* as dictionary items.
|
||||||
|
|
||||||
For example, we can set a variable as an attribute:
|
For example, you can set a variable as an attribute:
|
||||||
|
|
||||||
>>> env = Env()
|
>>> env = Env()
|
||||||
>>> env.attr = 'I was set as an attribute.'
|
>>> env.attr = 'I was set as an attribute.'
|
||||||
@ -51,7 +51,7 @@ class Env(object):
|
|||||||
>>> env['attr'] # Also retrieve as a dictionary item
|
>>> env['attr'] # Also retrieve as a dictionary item
|
||||||
'I was set as an attribute.'
|
'I was set as an attribute.'
|
||||||
|
|
||||||
Or we can set a variable as a dictionary item:
|
Or you can set a variable as a dictionary item:
|
||||||
|
|
||||||
>>> env['item'] = 'I was set as a dictionary item.'
|
>>> env['item'] = 'I was set as a dictionary item.'
|
||||||
>>> env['item']
|
>>> env['item']
|
||||||
@ -166,7 +166,8 @@ class Env(object):
|
|||||||
process.
|
process.
|
||||||
|
|
||||||
However, normally none of the above methods are called directly and instead
|
However, normally none of the above methods are called directly and instead
|
||||||
only `ipalib.plugable.API.bootstrap()` is called.
|
only `plugable.API.bootstrap()` is called, which itself takes care of
|
||||||
|
correctly calling the `Env` bootstrapping methods.
|
||||||
"""
|
"""
|
||||||
|
|
||||||
__locked = False
|
__locked = False
|
||||||
@ -360,7 +361,7 @@ class Env(object):
|
|||||||
|
|
||||||
After this method finishes, the `Env` instance will be locked and no
|
After this method finishes, the `Env` instance will be locked and no
|
||||||
more environment variables can be set. Aside from unit-tests and
|
more environment variables can be set. Aside from unit-tests and
|
||||||
example code, normally only one `Env` instance is created, meaning
|
example code, normally only one `Env` instance is created, which means
|
||||||
no more variables can be set during the remaining life of the process.
|
no more variables can be set during the remaining life of the process.
|
||||||
"""
|
"""
|
||||||
self.__doing('_finalize')
|
self.__doing('_finalize')
|
||||||
|
Loading…
Reference in New Issue
Block a user