pydoctor._configparser.TomlConfigParser

TOML parser with support for sections.

This config parser can be used to integrate with pyproject.toml files.

Example:

    # this is a comment
    # this is TOML section table:
    [tool.my-software] 
    # how to specify a key-value pair (strings must be quoted):
    format-string = "restructuredtext"
    # 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. 
        '''
    # how to specify a empty text:
    empty-text = ''
    # how to specify a empty list:
    empty-list = []

Usage:

>>> import configargparse
>>> parser = configargparse.ArgParser(
...             default_config_files=['pyproject.toml', 'my_super_tool.toml'],
...             config_file_parser_class=configargparse.TomlConfigParser(['tool.my_super_tool']),
...          )