configargparse.CompositeConfigParser

class documentation

class CompositeConfigParser(ConfigFileParser): (source)

Constructor: CompositeConfigParser(config_parser_types)

Create a config parser composed by other ConfigFileParser types.

The composite parser will successively try to parse the file with each parser, until it succeeds, else raise execption with all encountered errors.

Method	`__call__`	Undocumented
Method	`__init__`	Undocumented
Method	`get_syntax_description`	Returns a string describing the config file syntax.
Method	`parse`	Parses the keys and values from a config file.
Instance Variable	`parsers`	Undocumented

Inherited from ConfigFileParser:

Method	`process_config_entry`	This function may be overridden in custom ConfigFileParser subclasses to allow for modification or values or other side effects when a value is found in a config file.
Method	`serialize`	Does the inverse of config parsing by taking parsed values and converting them back to a string representing config file contents.
Method	`_process_config_entry`	Ensure that all (possibly altered) values really are strings, or list of strings, or None, in order to update the collection of values.

def __call__(self): (source) ¶

Undocumented

def __init__(self, config_parser_types): (source) ¶

Undocumented

def get_syntax_description(self): (source) ¶

overrides configargparse.ConfigFileParser.get_syntax_description

Returns a string describing the config file syntax.

def parse(self, stream): (source) ¶

overrides configargparse.ConfigFileParser.parse

Parses the keys and values from a config file.

Note

For keys that were specified to configargparse as action="store_true" or "store_false", the config file value must be one of: "yes", "no", "on", "off", "true", "false", "1", "0". Otherwise an error will be raised.

Parameters
stream:`IO`	A config file input stream (such as an open file object).

Returns
`OrderedDict`	Items where the keys are strings and the values are either strings or lists (eg. to support config file formats like YAML which allow lists).

parsers = (source) ¶

Undocumented