API Reference

Extend ConfigParser to add some inheritance functionality.

exception zconfigparser.ZDictError

Base class for ZDict Exceptions.

exception zconfigparser.ZKeyError(key)

Raised when no zkey is found.

exception zconfigparser.DuplicateZKeyError(new, old)

Raised when duplicate zkeys are found.

exception zconfigparser.RecursiveZkeyError(key)

Raised when circular zkey structure is found.

cf. ‘[aa : bb]’, ‘[bb : cc]’, ‘[cc : aa]’

exception zconfigparser.Error

Base class for ZConfigParser Exceptions.

exception zconfigparser.NoZSectionError(section)

Raised when no zsection is found.

exception zconfigparser.NoZOptionError(option, section)

Raised when no option in a zsection is found.

class zconfigparser.ZDict(*args, **kwargs)

A custom dictionary used in ZConfigParser.

It creates and keeps internal zsection dependency dictionaries. (They are ordinary dict). Without this, ZConfigParser has to search all sections all the time and is very slow.

zkeys()

Collect all shortnames and longnames.

Two dictionary keys are combined (sections and zsections), so key ordering of OrderedDict part is not preserved.

class zconfigparser.ZDictGen(*args, **kwargs)

A supplement class needed to create ZSEP pre-initialized ZDict.

To adjust for ConfigParser intialization argument dict_type.

class zconfigparser.ZConfigParser(*args, **kwargs)

ConfigParser, plus some section inheritance function.

E.g. section [aa : bb] becomes [aa], and inherits and overrides section [bb]. Default separator word is ‘ : ‘, exactly one space before and after ‘:’.

get(section, option, **kwargs)

Override ConfigParser’s method.

ZConfigParser only wraps Exceptions in get. Other ‘get’ (getint etc.) might leak (raise) ConfigParser’s Exceptions.

zsections()

Return all section shortnames and longnames.

has_zsection(section)

Check section name (whether short or long).

has_zoption(section, option)

Check option name in a zsection (whether short or long).