ConfigArgParse 1.7 API Documentation Modules Classes Names

search in docstrings

Search bar offers the following options:

Term presence. The below example searches for documents that must contain “foo”, might contain “bar” and must not contain “baz”: +foo bar -baz
Wildcards. The below example searches for documents with words beginning with “foo”: foo*
Search in specific fields. The following search matches all objects in "twisted.mail" that matches “search”: +qname:twisted.mail.* +search
Possible fields: 'name', 'qname' (fully qualified name), 'docstring', and 'kind'. Last two fields are only applicable if "search in docstrings" is enabled.
Fuzzy matches. The following search matches all documents that have a word within 1 edit distance of “foo”: foo~1

Results provided by Lunr.js

Exception ConfigFileParserException

Module configargparse

Classes

ArgumentDefaultsRawHelpFormatter
ArgumentParser
CompositeConfigParser
ConfigFileParser
ConfigparserConfigFileParser
DefaultConfigFileParser
IniConfigParser
TomlConfigParser
YAMLConfigFileParser
ConfigFileParserException

Functions

add_argument
already_on_command_line
get_argument_parser
get_toml_section
init_argument_parser
is_quoted
parse_toml_section_name
unquote_str

Variables

ACTION_TYPES_THAT_DONT_NEED_A_VALUE
is_boolean_optional_action
_COMMAND_LINE_SOURCE_KEY
_CONFIG_FILE_SOURCE_KEY
_DEFAULTS_SOURCE_KEY
_ENV_VAR_SOURCE_KEY
_QUOTED_STR_REGEX
_TRIPLE_QUOTED_STR_REGEX
_parsers

`configargparse.ConfigFileParserException`

exception documentation

class ConfigFileParserException(Exception): (source)

View In Hierarchy

Raised when config file parsing failed.

API Documentation for ConfigArgParse 1.7, generated by pydoctor 23.4.1 at 2023-07-23 16:19:32.