Methods
| __init__([defaults, dict_type, allow_no_value]) | |
| add_section(section) | Create a new section in the configuration. |
| defaults() | |
| get(section, option[, raw, vars]) | Get an option value for a given section. |
| getboolean(section, option) | |
| getfloat(section, option) | |
| getint(section, option) | |
| has_option(section, option) | Check for the existence of a given option in a given section. |
| has_section(section) | Indicate whether the named section is present in the configuration. |
| items(section[, raw, vars]) | Return a list of tuples with (name, value) for each option in the section. |
| options(section) | Return a list of option names for the given section name. |
| optionxform(optionstr) | |
| read(filenames) | Read and parse a filename or a list of filenames. |
| readfp(fp[, filename]) | Like read() but the argument must be a file-like object. |
| remove_option(section, option) | Remove an option. |
| remove_section(section) | Remove a file section. |
| sections() | Return a list of section names, excluding [DEFAULT] |
| set(section, option[, value]) | Set an option. |
| write(fp) | Write an .ini-format representation of the configuration state. |
Attributes
| OPTCRE | |
| OPTCRE_NV | |
| SECTCRE |
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.
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.
Check for the existence of a given option in a given section.
Indicate whether the named section is present in the configuration.
The DEFAULT section is not acknowledged.
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.
Return a list of option names for the given section name.
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.
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 an option.
Remove a file section.
Return a list of section names, excluding [DEFAULT]
Set an option. Extend ConfigParser.set: check for string values.
Write an .ini-format representation of the configuration state.