configargparse.CompositeConfigParser

class documentation

class CompositeConfigParser(ConfigFileParser): (source)

Constructor: CompositeConfigParser(config_parser_types)

Createa a config parser composed by others `ConfigFileParser`s.

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 serialize Does the inverse of config parsing by taking parsed values and converting them back to a string representing config file contents.

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