Index of the initools module
-
m
initools
...
-
m
configparser
...
- This implements the public ConfigParser interface, but with some
additional enhancements.
- a MAX_INTERPOLATION_DEPTH ...
-
C
ConfigParser
...
- a case_sensitive ...
- a continuation_indent ...
- a default_extend_name ...
- a default_extend_section_name ...
- a encoding ...
- a global_extend_section_names ...
- a inherit_defaults ...
- f __init__ ...
- f add_section ... - Add a section named section to the instance.
- f allitems ...
- f asdict ...
- f defaults ... - Return a dictionary containing the instance-wide defaults.
- f get ... - Get an option value for the named section.
- f getboolean ... - A convenience method which coerces the option in the specified section to a Boolean value.
- f getfilename ... - Returns the value of the option, interpreted as a filename relative to the location of where the option was defined.
- f getfloat ... - A convenience method which coerces the option in the specified section to a floating point number.
- f getint ... - A convenience method which coerces the option in the specified section to an integer.
- f has_option ... - If the given section exists, and contains the given option, return True; otherwise return False.
- f has_section ... - Indicates whether the named section is present in the configuration.
- f items ... - Return a list of (name, value) pairs for each option in the given section.
- f options ... - Returns a list of options available in the specified section.
- f optionxform ... - Transforms the option name option as found in an input file or as passed in by client code to the form that should be used in the internal structures.
- f read ... - Attempt to read and parse a list of filenames, returning a list of filenames which were successfully parsed.
- f readfp ... - Read and parse configuration data from the file or file-like object in fp
- f remove_option ... - Remove the specified option from the specified section.
- f remove_section ... - Remove the specified section from the configuration.
- f sectiondict ...
- f sections ... - Return a list of the sections available; DEFAULT is not included in the list.
- f sectionxform ... - Transforms the section name option as found in an input file or as passed in by client code to the form that should be used in the internal structures.
- f set ... - If the given section exists, set the given option to the specified value; otherwise raise NoSectionError.
- f write ... - Write a representation of the configuration to the specified file object.
-
C
DuplicateSectionError
...
- Exception raised if add_section() is called with the name of a
section that is already present.
-
C
Error
...
- C InterpolationDepthError ... - Exception raised when string interpolation cannot be completed because the number of iterations exceeds MAX_INTERPOLATION_DEPTH. Subclass of InterpolationError.
- C InterpolationError ... - Base class for exceptions raised when problems occur performing string interpolation.
- C InterpolationMissingOptionError ... - Exception raised when an option referenced from a value does not exist. Subclass of InterpolationError.
- C InterpolationSyntaxError ... - Exception raised when the source text into which substitutions are made does not conform to the required syntax. Subclass of InterpolationError.
-
C
MissingSectionHeaderError
...
- Exception raised when attempting to parse a file which has no
section headers.
-
C
NoOptionError
...
- Exception raised when a specified option is not found in the
specified section.
-
C
NoSectionError
...
- Exception raised when a specified section is not found.
-
C
RawConfigParser
...
- f __init__ ...
- f add_section ... - Add a section named section to the instance.
- f allitems ...
- f asdict ...
- f defaults ... - Return a dictionary containing the instance-wide defaults.
- f get ... - Get an option value for the named section.
- f getboolean ... - A convenience method which coerces the option in the specified section to a Boolean value.
- f getfilename ... - Returns the value of the option, interpreted as a filename relative to the location of where the option was defined.
- f getfloat ... - A convenience method which coerces the option in the specified section to a floating point number.
- f getint ... - A convenience method which coerces the option in the specified section to an integer.
- f has_option ... - If the given section exists, and contains the given option, return True; otherwise return False.
- f has_section ... - Indicates whether the named section is present in the configuration.
- f items ... - Return a list of (name, value) pairs for each option in the given section.
- f options ... - Returns a list of options available in the specified section.
- f optionxform ... - Transforms the option name option as found in an input file or as passed in by client code to the form that should be used in the internal structures.
- f read ... - Attempt to read and parse a list of filenames, returning a list of filenames which were successfully parsed.
- f readfp ... - Read and parse configuration data from the file or file-like object in fp
- f remove_option ... - Remove the specified option from the specified section.
- f remove_section ... - Remove the specified section from the configuration.
- f sectiondict ...
- f sections ... - Return a list of the sections available; DEFAULT is not included in the list.
- f sectionxform ... - Transforms the section name option as found in an input file or as passed in by client code to the form that should be used in the internal structures.
- f set ... - If the given section exists, set the given option to the specified value; otherwise raise NoSectionError.
- f write ... - Write a representation of the configuration to the specified file object.
-
C
SafeConfigParser
...
- f add_section ... - Add a section named section to the instance.
- f allitems ...
- f asdict ...
- f defaults ... - Return a dictionary containing the instance-wide defaults.
- f getfloat ... - A convenience method which coerces the option in the specified section to a floating point number.
- f has_option ... - If the given section exists, and contains the given option, return True; otherwise return False.
- f items ... - Return a list of (name, value) pairs for each option in the given section.
- f options ... - Returns a list of options available in the specified section.
- f optionxform ... - Transforms the option name option as found in an input file or as passed in by client code to the form that should be used in the internal structures.
- f readfp ... - Read and parse configuration data from the file or file-like object in fp
- f remove_option ... - Remove the specified option from the specified section.
- f remove_section ... - Remove the specified section from the configuration.
- f sectiondict ...
- f sectionxform ... - Transforms the section name option as found in an input file or as passed in by client code to the form that should be used in the internal structures.
-
m
configwrapper
...
- Deprecated (13 Aug 2006)
- a __warningregistry__ ...
-
C
Config
...
- A configuration object. Acts a little like a dictionary, but not
really.
- a false_values ...
- a true_values ...
- f __init__ ...
- f clean_section ...
- f get ... - Get a single value, returning default if none found.
- f getbool ... - Get a single boolean value. Boolean values are things like true, false, etc.
-
f
getinlinelist
...
-
Get a list, where the list is defined like:
- f getint ... - Get an integer value.
-
f
getlist
...
-
Get a list of all matching keys. Example:
- f getraw ... - Mostly for internal use, returns a list of all matching keys.
- f getstartswith ... - Returns a list of [(key, value), ...] for all keys in the section that start with startswith.
- f keys ...
- f sections ...
-
C
NoDefault
...
- f clean_name ...
- f load_options ... - Given a parser object and the parsed options and a configuration object or filename, this will load the configuration into the parsed options.
-
m
iniparser
...
- A parser for .ini-syntax files. INIParser should be subclassed to
create a data structure from the file. See INIParser for more
-
C
BasicParser
...
- A simple subclass of INIParser; creates a nested data structure
like {'section_name': {'variable': ['values']}}
- f __init__ ...
- f add_comment ...
- f assignment ...
- f error_continuation_without_assignment ...
- f error_missing_equal ...
- f error_no_section_name ...
- f get_comment ... - Returns None if not a comment
- f load ...
- f new_section ...
- f parse_error ...
- f process_assignment ...
- f process_file ...
- f reset ...
- f split_name_value ...
-
C
INIParser
...
- A parser for .ini-syntax files.
- f __init__ ...
- f add_comment ...
- f assignment ...
- f error_continuation_without_assignment ...
- f error_missing_equal ...
- f error_no_section_name ...
- f error_section_without_end_bracket ...
- f get_comment ... - Returns None if not a comment
- f get_section ... - Returns None if not a section
- f load ...
- f loadfile ...
- f loadstring ...
- f new_section ...
- f parse_error ...
- f process_assignment ...
- f process_file ...
- f reset ...
- f split_name_value ...
- C ParseError ...
-
C
BasicParser
...
- A simple subclass of INIParser; creates a nested data structure
like {'section_name': {'variable': ['values']}}
-
m
inischema
...
- Probably will be deprecated (13 Aug 2006): I'm not sure if this
is worth keeping around.
-
C
INIMeta
...
- a __bases__ ...
- a __basicsize__ ...
- a __dictoffset__ ...
- a __flags__ ...
- a __itemsize__ ...
- a __mro__ ...
- a __name__ ...
- a __weakrefoffset__ ...
-
C
INISchema
...
- f __classinit__ ...
- f __init__ ...
- f add_option ... - Classmethod: add the option using the given attribute name. This can be called after the class has been created, to dynamically build up the options.
- f as_dict ... - Returns the loaded configuration as a dictionary.
- f ini_repr ... - Returns the loaded values as a string, suitable as a configuration file.
- f load ... - Loads the filename. Use the encoding keyword argument to specify the file's encoding.
- f loadstring ... - Loads the string, which is the content of the ini files. Use the filename keyword argument to indicate the filename source (or another way to identify the source of the string in error messages).
- f set_config_value ...
-
C
NoDefault
...
-
C
ParseValueError
...
-
C
SchemaINIParser
...
- f __init__ ...
- f assignment ...
- f new_section ...
- C opt ...
- C optbool ...
-
C
optconverter
...
- a converter_func ...
- a misc_error_message ...
- f __get__ ...
- f __init__ ...
- f __set__ ...
- f convert ...
- f get_converter ...
- f ini_assignment ...
- f ini_fold ...
- f set_schema ...
- f set_value ...
- f validate ...
-
C
optdefault
...
- f __delete__ ...
- f __init__ ...
- f ini_assignment ...
- f ini_fold ...
- f ini_repr ...
- f set_config_value ...
- f set_value ...
-
C
optfloat
...
- a bad_type_message ...
- a too_large_message ...
- a too_small_message ...
- f __delete__ ...
- f __get__ ...
- f __set__ ...
- f convert ...
- f ini_assignment ...
- f set_schema ...
- f set_value ...
- f validate ...
-
C
optint
...
- a bad_type_message ...
- f __set__ ...
- f ini_fold ...
- f set_schema ...
- f validate ...
- C optlist ...
-
C
INIMeta
...
-
m
lazyiniparser
...
- A parser that keeps lots of information around, so the file can be
reconstructed almost exactly like it originally was entered. Also, if
there are errors with values, they can be tracked back to a file and
line number.
- C Configuration ...
-
C
ConversionError
...
- C Item ...
-
C
LazyINIParser
...
- f __init__ ...
- f add_comment ...
- f assignment ...
- f new_section ...
- C Section ...
- f canonical_name ...
- m lazyloader ... - Deprecated (13 Aug 2006)
- m nested ... - Deprecated (13 Aug 2006)
-
m
configparser
...
- This implements the public ConfigParser interface, but with some
additional enhancements.