Next Comment
ConfigParser.py
Configuration file parser.
A setup file consists of sections, lead by a "[section]" header,
and followed by "name: value" entries, with continuations and such in
the style of RFC 822.
the same section, or values in a special [DEFAULT] section.
For example:
something: %(dir)s/whatever
would resolve the "%(dir)s" to the value of dir. All reference
expansions are done late, on demand.
Intrinsic defaults can be specified by passing them into the
ConfigParser constructor as a dictionary.
class:
ConfigParser -- responsible for parsing a list of
configuration files, and managing the parsed database.
methods:
__init__(defaults=None)
create the parser and specify a dictionary of intrinsic defaults. The
keys must be strings, the values must be appropriate for %()s string
interpolation. Note that `__name__' is always an intrinsic default;
it's value is the section's name.
sections()
return all the configuration section names, sans DEFAULT
has_section(section)
return whether the given section exists
has_option(section, option)
return whether the given option exists in the given section
options(section)
return list of configuration options for the named section
read(filenames)
read and parse the list of named configuration files, given by
name. A single filename is also allowed. Non-existing files
are ignored.
readfp(fp, filename=None)
read and parse one configuration file, given as a file object.
The filename defaults to fp.name; it is only used in error
messages (if fp has no `name' attribute, the string `<???>' is used).
get(section, option, raw=False, vars=None)
return a string value for the named option. All % interpolations are
expanded in the return values, based on the defaults passed into the
constructor and the DEFAULT section. Additional substitutions may be
provided using the `vars' argument, which must be a dictionary whose
contents override any pre-existing defaults.
getint(section, options)
like get(), but convert value to an integer
getfloat(section, options)
like get(), but convert value to a float
getboolean(section, options)
like get(), but convert value to a boolean (currently case
insensitively defined as 0, false, no, off for False, and 1, true,
yes, on for True). Returns False or True.
items(section, raw=False, vars=None)
return a list of tuples with (name, value) for each option
in the section.
remove_section(section)
remove the given file section and all its options
remove_option(section, option)
remove the given option from the given section
set(section, option, value)
set the given option
write(fp)
write the configuration state in .ini format
Next Comment
Error
Base class for ConfigParser exceptions.
Next Comment
NoSectionError
Rasssised when no section matches a requested option.
Next Comment
DuplicateSectionError
Raised when a section is multiply-created.
Next Comment
NoOptionError
A requested option was not found.
Next Comment
InterpolationError
Base class for interpolation-related exceptions.
Next Comment
InterpolationMissingOptionError
A string substitution required a setting which was not available.
Next Comment
InterpolationSyntaxError
Raised when the source text into which substitutions are made
does not conform to the required syntax.
Next Comment
InterpolationDepthError
Raised when substitutions are nested too deeply.
Next Comment
ParsingError
Raised when a configuration file does not follow legal syntax.
Next Comment
MissingSectionHeaderError
Raised when a key-value pair is found before any section header.
Next Comment
sections(self)
Return a list of section names, excluding [DEFAULT]
Next Comment
add_section(self, section)
Create a new section in the configuration.
Raise DuplicateSectionError if a section by the specified name
already exists.
Next Comment
has_section(self, section)
Indicate whether the named section is present in the configuration.
The DEFAULT section is not acknowledged.
Next Comment
options(self, section)
Return a list of option names for the given section name.
Next Comment
read(self, filenames)
Read and parse a filename or a list of filenames.
Files that cannot be opened are silently ignored; this is
designed so that you can specify a list of potential
configuration file locations (e.g. current directory, user's
home directory, systemwide directory), and all existing
configuration files in the list will be read. A single
filename may also be given.
Next Comment
readfp(self, fp, filename)
Like read() but the argument must be a file-like object.
The `fp' argument must have a `readline' method. Optional
second argument is the `filename', which if not given, is
taken from fp.name. If fp has no `name' attribute, `<???>' is
used.
Next Comment
has_option(self, section, option)
Check for the existence of a given option in a given section.
Next Comment
set(self, section, option, value)
Set an option.
Next Comment
write(self, fp)
Write an .ini-format representation of the configuration state.
Next Comment
remove_option(self, section, option)
Remove an option.
Next Comment
remove_section(self, section)
Remove a file section.
Next Comment
_read(self, fp, fpname)
Parse a sectioned setup file.
The sections in setup file contains a title line at the top,
indicated by a name in square brackets (`[]'), plus key/value
options lines, indicated by `name: value' format lines.
Continuations are represented by an embedded newline then
leading whitespace. Blank lines, lines beginning with a '#',
and just about everything else are ignored.
Next Comment
get(self, section, option, raw, vars)
Get an option value for a given section.
All % interpolations are expanded in the return values, based on the
defaults passed into the constructor, unless the optional argument
`raw' is true. Additional substitutions may be provided using the
`vars' argument, which must be a dictionary whose contents overrides
any pre-existing defaults.
The section DEFAULT is special.
Next Comment
items(self, section, raw, vars)
Return a list of tuples with (name, value) for each option
in the section.
All % interpolations are expanded in the return values, based on the
defaults passed into the constructor, unless the optional argument
`raw' is true. Additional substitutions may be provided using the
`vars' argument, which must be a dictionary whose contents overrides
any pre-existing defaults.
The section DEFAULT is special.