configargparse.TomlConfigParser

class documentation

class TomlConfigParser(ConfigFileParser): (source)

Constructor: TomlConfigParser(sections)

Create a TOML parser bounded to the list of provided sections.

Example::

# this is a comment [tool.my-software] # TOML section table. # how to specify a key-value pair format-string = "restructuredtext" # strings must be quoted # how to set an arg which has action="store_true" warnings-as-errors = true # how to set an arg which has action="count" or type=int verbosity = 1 # how to specify a list arg (eg. arg which has action="append") repeatable-option = ["https://docs.python.org/3/objects.inv",

"https://twistedmatrix.com/documents/current/api/objects.inv"]

# how to specify a multiline text: multi-line-text = '''

Lorem ipsum dolor sit amet, consectetur adipiscing elit. Vivamus tortor odio, dignissim non ornare non, laoreet quis nunc. Maecenas quis dapibus leo, a pellentesque leo. '''

Note that the config file fragment above is also valid for the IniConfigParser class and would be parsed the same manner. Thought, any valid TOML config file will not be necessarly parsable with IniConfigParser (INI files must be rigorously indented whereas TOML files).

See the `TOML specification <>`_ for details.

Method	`__call__`	Undocumented
Method	`__init__`	No summary
Method	`get_syntax_description`	Returns a string describing the config file syntax.
Method	`parse`	Parses the keys and values from a TOML config file.
Instance Variable	`sections`	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, sections): (source) ¶

Parameters
sections	The section names bounded to the new parser.

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 TOML config file.

sections = (source) ¶

Undocumented