| |
- Error(exceptions.Exception)
-
- DuplicateSectionError
- InterpolationError
-
- InterpolationDepthError
- InterpolationSyntaxError
- NoOptionError
- NoSectionError
- ParsingError
-
- MissingSectionHeaderError
- RawConfigParser
-
- ConfigParser
-
- SafeConfigParser
class ConfigParser(RawConfigParser) |
| |
Methods defined here:
- get(self, section, option, raw=False, vars=None)
- Get an option value for a given section.
If `vars' is provided, it must be a dictionary. The option is looked up
in `vars' (if provided), `section', and in `defaults' in that order.
All % interpolations are expanded in the return values, unless the
optional argument `raw' is true. Values for interpolation keys are
looked up in the same manner as the option.
The section DEFAULT is special.
- items(self, section, raw=False, vars=None)
- 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.
Methods inherited from RawConfigParser:
- __init__(self, defaults=None, dict_type=<class 'collections.OrderedDict'>, allow_no_value=False)
- add_section(self, section)
- Create a new section in the configuration.
Raise DuplicateSectionError if a section by the specified name
already exists. Raise ValueError if name is DEFAULT or any of it's
case-insensitive variants.
- defaults(self)
- getboolean(self, section, option)
- getfloat(self, section, option)
- getint(self, section, option)
- has_option(self, section, option)
- Check for the existence of a given option in a given section.
- has_section(self, section)
- Indicate whether the named section is present in the configuration.
The DEFAULT section is not acknowledged.
- options(self, section)
- Return a list of option names for the given section name.
- optionxform(self, optionstr)
- 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.
Return list of successfully read files.
- readfp(self, fp, filename=None)
- 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.
- remove_option(self, section, option)
- Remove an option.
- remove_section(self, section)
- Remove a file section.
- sections(self)
- Return a list of section names, excluding [DEFAULT]
- set(self, section, option, value=None)
- Set an option.
- write(self, fp)
- Write an .ini-format representation of the configuration state.
Data and other attributes inherited from RawConfigParser:
- OPTCRE = <_sre.SRE_Pattern object>
- OPTCRE_NV = <_sre.SRE_Pattern object>
- SECTCRE = <_sre.SRE_Pattern object>
|
class RawConfigParser |
| |
Methods defined here:
- __init__(self, defaults=None, dict_type=<class 'collections.OrderedDict'>, allow_no_value=False)
- add_section(self, section)
- Create a new section in the configuration.
Raise DuplicateSectionError if a section by the specified name
already exists. Raise ValueError if name is DEFAULT or any of it's
case-insensitive variants.
- defaults(self)
- get(self, section, option)
- getboolean(self, section, option)
- getfloat(self, section, option)
- getint(self, section, option)
- has_option(self, section, option)
- Check for the existence of a given option in a given section.
- has_section(self, section)
- Indicate whether the named section is present in the configuration.
The DEFAULT section is not acknowledged.
- items(self, section)
- options(self, section)
- Return a list of option names for the given section name.
- optionxform(self, optionstr)
- 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.
Return list of successfully read files.
- readfp(self, fp, filename=None)
- 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.
- remove_option(self, section, option)
- Remove an option.
- remove_section(self, section)
- Remove a file section.
- sections(self)
- Return a list of section names, excluding [DEFAULT]
- set(self, section, option, value=None)
- Set an option.
- write(self, fp)
- Write an .ini-format representation of the configuration state.
Data and other attributes defined here:
- OPTCRE = <_sre.SRE_Pattern object>
- OPTCRE_NV = <_sre.SRE_Pattern object>
- SECTCRE = <_sre.SRE_Pattern object>
|
class SafeConfigParser(ConfigParser) |
| |
- Method resolution order:
- SafeConfigParser
- ConfigParser
- RawConfigParser
Methods defined here:
- set(self, section, option, value=None)
- Set an option. Extend ConfigParser.set: check for string values.
Methods inherited from ConfigParser:
- get(self, section, option, raw=False, vars=None)
- Get an option value for a given section.
If `vars' is provided, it must be a dictionary. The option is looked up
in `vars' (if provided), `section', and in `defaults' in that order.
All % interpolations are expanded in the return values, unless the
optional argument `raw' is true. Values for interpolation keys are
looked up in the same manner as the option.
The section DEFAULT is special.
- items(self, section, raw=False, vars=None)
- 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.
Methods inherited from RawConfigParser:
- __init__(self, defaults=None, dict_type=<class 'collections.OrderedDict'>, allow_no_value=False)
- add_section(self, section)
- Create a new section in the configuration.
Raise DuplicateSectionError if a section by the specified name
already exists. Raise ValueError if name is DEFAULT or any of it's
case-insensitive variants.
- defaults(self)
- getboolean(self, section, option)
- getfloat(self, section, option)
- getint(self, section, option)
- has_option(self, section, option)
- Check for the existence of a given option in a given section.
- has_section(self, section)
- Indicate whether the named section is present in the configuration.
The DEFAULT section is not acknowledged.
- options(self, section)
- Return a list of option names for the given section name.
- optionxform(self, optionstr)
- 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.
Return list of successfully read files.
- readfp(self, fp, filename=None)
- 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.
- remove_option(self, section, option)
- Remove an option.
- remove_section(self, section)
- Remove a file section.
- sections(self)
- Return a list of section names, excluding [DEFAULT]
- write(self, fp)
- Write an .ini-format representation of the configuration state.
Data and other attributes inherited from RawConfigParser:
- OPTCRE = <_sre.SRE_Pattern object>
- OPTCRE_NV = <_sre.SRE_Pattern object>
- SECTCRE = <_sre.SRE_Pattern object>
| |