b.u.c.c.Section(dict) : class documentation

Part of bzrlib.util.configobj.configobj View In Hierarchy

Known subclasses: bzrlib.util.configobj.configobj.ConfigObj

A dictionary-like object that represents a section in a config file.

It does string interpolation if the 'interpolation' attribute of the 'main' object is set to True.

Interpolation is tried first from this object, then from the 'DEFAULT' section of this object, next from the parent and its 'DEFAULT' section, and so on until the main object is reached.

A Section will behave like an ordered dictionary - following the order of the scalars and sections attributes. You can use this to change the order of members.

Iteration follows the order: scalars, then sections.

Method __setstate__ Undocumented
Method __reduce__ Undocumented
Method __init__
  • parent is the section above
Method __getitem__ Fetch the item and do string interpolation.
Method __setitem__ Correctly set a value.
Method __delitem__ Remove items from the sequence when deleting.
Method get A version of get that doesn't bypass string interpolation.
Method update A version of update that uses our __setitem__.
Method pop 'D.pop(k[,d]) -> v, remove specified key and return the corresponding value.
Method popitem Pops the first (key,val)
Method clear A version of clear that also affects scalars/sections
Method setdefault A version of setdefault that sets sequence if appropriate.
Method items D.items() -> list of D's (key, value) pairs, as 2-tuples
Method keys D.keys() -> list of D's keys
Method values D.values() -> list of D's values
Method iteritems D.iteritems() -> an iterator over the (key, value) items of D
Method iterkeys D.iterkeys() -> an iterator over the keys of D
Method itervalues D.itervalues() -> an iterator over the values of D
Method __repr__ x.__repr__() <==> repr(x)
Method dict Return a deepcopy of self as a dictionary.
Method merge A recursive update - useful for merging config files.
Method rename Change a keyname to another, without changing position in sequence.
Method walk Walk every member and call a function on the keyword and value.
Method as_bool Accepts a key as input. The corresponding value must be a string or
Method as_int A convenience method which coerces the specified value to an integer.
Method as_float A convenience method which coerces the specified value to a float.
Method as_list A convenience method which fetches the specified value, guaranteeing
Method restore_default Restore (and return) default value for the specified key.
Method restore_defaults Recursively restore default values to all members
Method _initialise Undocumented
Method _interpolate Undocumented
def __setstate__(self, state):
Undocumented
def __reduce__(self):
Undocumented
def __init__(self, parent, depth, main, indict=None, name=None):
  • parent is the section above
  • depth is the depth level of this section
  • main is the main ConfigObj
  • indict is a dictionary to initialise the section with
def _initialise(self):
Undocumented
def _interpolate(self, key, value):
Undocumented
def __getitem__(self, key):
Fetch the item and do string interpolation.
def __setitem__(self, key, value, unrepr=False):
Correctly set a value.

Making dictionary values Section instances. (We have to special case 'Section' instances - which are also dicts)

Keys must be strings. Values need only be strings (or lists of strings) if main.stringify is set.

unrepr must be set when setting a value to a dictionary, without creating a new sub-section.

def __delitem__(self, key):
Remove items from the sequence when deleting.
def get(self, key, default=None):
A version of get that doesn't bypass string interpolation.
def update(self, indict):
A version of update that uses our __setitem__.
def pop(self, key, *args):
'D.pop(k[,d]) -> v, remove specified key and return the corresponding value. If key is not found, d is returned if given, otherwise KeyError is raised'
def popitem(self):
Pops the first (key,val)
def clear(self):

A version of clear that also affects scalars/sections Also clears comments and configspec.

Leaves other attributes alone :
depth/main/parent are not affected
def setdefault(self, key, default=None):
A version of setdefault that sets sequence if appropriate.
def items(self):
D.items() -> list of D's (key, value) pairs, as 2-tuples
def keys(self):
D.keys() -> list of D's keys
def values(self):
D.values() -> list of D's values
def iteritems(self):
D.iteritems() -> an iterator over the (key, value) items of D
def iterkeys(self):
D.iterkeys() -> an iterator over the keys of D
def itervalues(self):
D.itervalues() -> an iterator over the values of D
def __repr__(self):
x.__repr__() <==> repr(x)
def dict(self):

Return a deepcopy of self as a dictionary.

All members that are Section instances are recursively turned to ordinary dictionaries - by calling their dict method.

>>> n = a.dict()
>>> n == a
1
>>> n is a
0
def merge(self, indict):

A recursive update - useful for merging config files.

>>> a = '''[section1]
...     option1 = True
...     [[subsection]]
...     more_options = False
...     # end of file'''.splitlines()
>>> b = '''# File is user.ini
...     [section1]
...     option1 = False
...     # end of file'''.splitlines()
>>> c1 = ConfigObj(b)
>>> c2 = ConfigObj(a)
>>> c2.merge(c1)
>>> c2
ConfigObj({'section1': {'option1': 'False', 'subsection': {'more_options': 'False'}}})
def rename(self, oldkey, newkey):
Change a keyname to another, without changing position in sequence.

Implemented so that transformations can be made on keys, as well as on values. (used by encode and decode)

Also renames comments.

def walk(self, function, raise_errors=True, call_on_sections=False, **keywargs):

Walk every member and call a function on the keyword and value.

Return a dictionary of the return values

If the function raises an exception, raise the errror unless raise_errors=False, in which case set the return value to False.

Any unrecognised keyword arguments you pass to walk, will be pased on to the function you pass in.

Note: if call_on_sections is True then - on encountering a subsection, first the function is called for the whole subsection, and then recurses into it's members. This means your function must be able to handle strings, dictionaries and lists. This allows you to change the key of subsections as well as for ordinary members. The return value when called on the whole subsection has to be discarded.

See the encode and decode methods for examples, including functions.

caution

You can use walk to transform the names of members of a section but you mustn't add or delete members.

>>> config = '''[XXXXsection]
... XXXXkey = XXXXvalue'''.splitlines()
>>> cfg = ConfigObj(config)
>>> cfg
ConfigObj({'XXXXsection': {'XXXXkey': 'XXXXvalue'}})
>>> def transform(section, key):
...     val = section[key]
...     newkey = key.replace('XXXX', 'CLIENT1')
...     section.rename(key, newkey)
...     if isinstance(val, (tuple, list, dict)):
...         pass
...     else:
...         val = val.replace('XXXX', 'CLIENT1')
...         section[newkey] = val
>>> cfg.walk(transform, call_on_sections=True)
{'CLIENT1section': {'CLIENT1key': None}}
>>> cfg
ConfigObj({'CLIENT1section': {'CLIENT1key': 'CLIENT1value'}})
def as_bool(self, key):

Accepts a key as input. The corresponding value must be a string or the objects (True or 1) or (False or 0). We allow 0 and 1 to retain compatibility with Python 2.2.

If the string is one of True, On, Yes, or 1 it returns True.

If the string is one of False, Off, No, or 0 it returns False.

as_bool is not case sensitive.

Any other input will raise a ValueError.

>>> a = ConfigObj()
>>> a['a'] = 'fish'
>>> a.as_bool('a')
Traceback (most recent call last):
ValueError: Value "fish" is neither True nor False
>>> a['b'] = 'True'
>>> a.as_bool('b')
1
>>> a['b'] = 'off'
>>> a.as_bool('b')
0
def as_int(self, key):

A convenience method which coerces the specified value to an integer.

If the value is an invalid literal for int, a ValueError will be raised.

>>> a = ConfigObj()
>>> a['a'] = 'fish'
>>> a.as_int('a')
Traceback (most recent call last):
ValueError: invalid literal for int() with base 10: 'fish'
>>> a['b'] = '1'
>>> a.as_int('b')
1
>>> a['b'] = '3.2'
>>> a.as_int('b')
Traceback (most recent call last):
ValueError: invalid literal for int() with base 10: '3.2'
def as_float(self, key):

A convenience method which coerces the specified value to a float.

If the value is an invalid literal for float, a ValueError will be raised.

>>> a = ConfigObj()
>>> a['a'] = 'fish'
>>> a.as_float('a')
Traceback (most recent call last):
ValueError: invalid literal for float(): fish
>>> a['b'] = '1'
>>> a.as_float('b')
1.0
>>> a['b'] = '3.2'
>>> a.as_float('b')
3.2000000000000002
def as_list(self, key):

A convenience method which fetches the specified value, guaranteeing that it is a list.

>>> a = ConfigObj()
>>> a['a'] = 1
>>> a.as_list('a')
[1]
>>> a['a'] = (1,)
>>> a.as_list('a')
[1]
>>> a['a'] = [1]
>>> a.as_list('a')
[1]
def restore_default(self, key):
Restore (and return) default value for the specified key.

This method will only work for a ConfigObj that was created with a configspec and has been validated.

If there is no default value for this key, KeyError is raised.

def restore_defaults(self):
Recursively restore default values to all members that have them.

This method will only work for a ConfigObj that was created with a configspec and has been validated.

It doesn't delete or modify entries without default values.

API Documentation for Bazaar, generated by pydoctor at 2019-07-16 00:33:44.