pyexperiment.utils.HierarchicalMapping

Provide flat, point separated interface to nested mappings

As the zen of python says, flat is better than nested. In many cases, however, it makes sense to store data in a nested data structure. To bridge the gap, the HierarchicalMapping defines an abstract base class for data structures that can be treated like an ordinary mapping from strings to values, but with the advantage that the values for keys containing a level separator, e.g., “level1.level2.level3” are stored in a nested hierarchy of mappings.

Written by Peter Duerr

class pyexperiment.utils.HierarchicalMapping.HierarchicalDict

Instance of the HierarchicalMapping based on dict

class pyexperiment.utils.HierarchicalMapping.HierarchicalMapping

ABC for flat mutable mappings where all keys are strings.

Levels of hierarchy are indicated by a separator character and the storage is implemented as a hierarchy of nested Mutable mappings.

SECTION_SEPARATOR = u'.'

Separates the hierarchy levels

__delitem__(key)

Delete an item

__getitem__(key)

Get an item

__iter__()

Need to define __iter__ to make it a MutableMapping

__len__()

Returns the number of entries in the mapping

__repr__()

Get a representation of the mapping

__setitem__(key, value)

Set an item

base_keys()

Returns the keys of the first level of the mapping

get(key, default=None)

Get the key or return the default value if provided

get_or_set(key, value)

Either gets the value associated with key or set it This can be useful as an easy way of

merge(other)

Merge in another mapping, giving precedence to self

section_keys()

Returns the keys of the sections (and subsections) of the mapping

show()

Pretty-prints the content of the mapping

class pyexperiment.utils.HierarchicalMapping.HierarchicalOrderedDict

Instance of the HierarchicalMapping based on an OrderedDict.