Class p.u.c.Section(dict):

Part of pida.utils.configobj View In Hierarchy

Known subclasses: pida.utils.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.

Line # Kind Name Docs
468 Method __init__
  • parent is the section above
508 Method _interpolate Undocumented
530 Method __getitem__ Fetch the item and do string interpolation.
537 Method __setitem__ Correctly set a value.
595 Method __delitem__ Remove items from the sequence when deleting.
605 Method get A version of get that doesn't bypass string interpolation.
612 Method update A version of update that uses our __setitem__.
619 Method pop Undocumented
634 Method popitem Pops the first (key,val)
644 Method clear A version of clear that also affects scalars/sections
659 Method setdefault A version of setdefault that sets sequence if appropriate.
667 Method items Undocumented
671 Method keys Undocumented
675 Method values Undocumented
679 Method iteritems Undocumented
683 Method iterkeys Undocumented
689 Method itervalues Undocumented
693 Method __repr__ Undocumented
701 Method dict Return a deepcopy of self as a dictionary.
728 Method merge A recursive update - useful for merging config files.
754 Method rename Change a keyname to another, without changing position in sequence.
783 Method walk Walk every member and call a function on the keyword and value.
867 Method decode Decode all strings and values to unicode, using the specified encoding.
910 Method encode Encode all strings and values from unicode,
935 Method istrue A deprecated version of as_bool.
941 Method as_bool Accepts a key as input. The corresponding value must be a string or
983 Method as_int A convenience method which coerces the specified value to an integer.
1005 Method as_float A convenience method which coerces the specified value to a float.
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 _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):
Undocumented
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):
Undocumented
def keys(self):
Undocumented
def values(self):
Undocumented
def iteritems(self):
Undocumented
def iterkeys(self):
Undocumented
def itervalues(self):
Undocumented
def __repr__(self):
Undocumented
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
{'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
{'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
{'CLIENT1section': {'CLIENT1key': 'CLIENT1value'}}
def decode(self, encoding):
Decode all strings and values to unicode, using the specified encoding.

Works with subsections and list values.

Uses the walk method.

Testing encode and decode. >>> m = ConfigObj(a) >>> m.decode('ascii') >>> def testuni(val): ... for entry in val: ... if not isinstance(entry, unicode): ... print >> sys.stderr, type(entry) ... raise AssertionError, 'decode failed.' ... if isinstance(val[entry], dict): ... testuni(val[entry]) ... elif not isinstance(val[entry], unicode): ... raise AssertionError, 'decode failed.' >>> testuni(m) >>> m.encode('ascii') >>> a == m 1

def encode(self, encoding):
Encode all strings and values from unicode, using the specified encoding.

Works with subsections and list values. Uses the walk method.

def istrue(self, key):
A deprecated version of as_bool.
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(): 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(): 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
API Documentation for PIDA, generated by pydoctor.