Class RawConfigParser

Known Subclasses:

ConfigParser

Instance Methods

[hide private]

__init__(self, defaults=None)

defaults(self)

sections(self)
Return a list of section names, excluding [DEFAULT]

add_section(self, section)
Create a new section in the configuration.

has_section(self, section)
Indicate whether the named section is present in the configuration.

options(self, section)
Return a list of option names for the given section name.

read(self, filenames)
Read and parse a filename or a list of filenames.

readfp(self, fp, filename=None)
Like read() but the argument must be a file-like object.

get(self, section, option)

items(self, section)

_get(self, section, conv, option)

getint(self, section, option)

getfloat(self, section, option)

getboolean(self, section, option)

optionxform(self, optionstr)

has_option(self, section, option)
Check for the existence of a given option in a given section.

set(self, section, option, value)
Set an option.

write(self, fp)
Write an .ini-format representation of the configuration state.

remove_option(self, section, option)
Remove an option.

remove_section(self, section)
Remove a file section.

_read(self, fp, fpname)
Parse a sectioned setup file.

Class Variables

[hide private]

_boolean_states = {'0': False, '1': True, 'false': False, 'no'...

SECTCRE = re.compile(r'\[(?P<header>[^\]]+)\]')

OPTCRE = re.compile(r'(?P<option>[^:=\s][^:=]*)\s*(?P<vi>[:=])...

Method Details

[hide private]

add_section(self, section)

Create a new section in the configuration.

Raise DuplicateSectionError if a section by the specified name already exists.

has_section(self, section)

Indicate whether the named section is present in the configuration.

The DEFAULT section is not acknowledged.

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.

_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.

Class Variable Details

[hide private]

_boolean_states

Value:

{'0': False,
 '1': True,
 'false': False,
 'no': False,
 'off': False,
 'on': True,
 'true': True,
 'yes': True}

OPTCRE

Value:

re.compile(r'(?P<option>[^:=\s][^:=]*)\s*(?P<vi>[:=])\s*(?P<value>.*)$
')