ConfigArgParse 1.7 API Documentation Modules Classes Names
Clear Help

For more information on the search, visit the help page.

Class Hierarchy

  • Exception
    • argparse.ArgumentError - An error from creating or using an argument (optional or positional).
    • argparse.ArgumentTypeError - An error from trying to convert a command line string to a type.
    • configargparse.ConfigFileParserException - Raised when config file parsing failed.
  • object
    • argparse._ActionsContainer - No class docstring; 0/12 instance variable, 1/18 method documented
      • argparse._ArgumentGroup - Undocumented
        • argparse._MutuallyExclusiveGroup - Undocumented
      • argparse.ArgumentParser - Object for parsing command line strings into Python objects.
        • configargparse.ArgumentParser - Drop-in replacement for argparse.ArgumentParser that adds support for environment variables and .ini or .yaml-style config files.
    • argparse._AttributeHolder - Abstract base class that provides __repr__.
      • argparse.Action - Information about how to convert command line strings to Python objects.
        • argparse._AppendAction - Undocumented
          • argparse._ExtendAction - Undocumented
        • argparse._AppendConstAction - Undocumented
        • argparse._CountAction - Undocumented
        • argparse._HelpAction - Undocumented
        • argparse._StoreAction - Undocumented
        • argparse._StoreConstAction - Undocumented
          • argparse._StoreFalseAction - Undocumented
          • argparse._StoreTrueAction - Undocumented
        • argparse._SubParsersAction - Undocumented
        • argparse._SubParsersAction._ChoicesPseudoAction - Undocumented
        • argparse._VersionAction - Undocumented
        • argparse.BooleanOptionalAction - Undocumented
      • argparse.ArgumentParser - Object for parsing command line strings into Python objects.
        • configargparse.ArgumentParser - Drop-in replacement for argparse.ArgumentParser that adds support for environment variables and .ini or .yaml-style config files.
      • argparse.Namespace - Simple object for storing attributes.
    • argparse.FileType - Factory for creating file object types
    • argparse.HelpFormatter - Formatter for generating usage messages and argument help strings.
      • argparse.ArgumentDefaultsHelpFormatter - Help message formatter which adds default values to argument help.
        • configargparse.ArgumentDefaultsRawHelpFormatter - HelpFormatter that adds default values AND doesn't do line-wrapping
      • argparse.MetavarTypeHelpFormatter - Help message formatter which uses the argument 'type' as the default metavar value (instead of the argument 'dest')
      • argparse.RawDescriptionHelpFormatter - Help message formatter which retains any formatting in descriptions.
        • argparse.RawTextHelpFormatter - Help message formatter which retains formatting of all help text.
          • configargparse.ArgumentDefaultsRawHelpFormatter - HelpFormatter that adds default values AND doesn't do line-wrapping
        • configargparse.ArgumentDefaultsRawHelpFormatter - HelpFormatter that adds default values AND doesn't do line-wrapping
    • argparse.HelpFormatter._Section - Undocumented
    • configargparse.ConfigFileParser - This abstract class can be extended to add support for new config file formats
      • configargparse.CompositeConfigParser - Createa a config parser composed by others `ConfigFileParser`s.
      • configargparse.ConfigparserConfigFileParser - parses INI files using pythons configparser.
      • configargparse.DefaultConfigFileParser - Based on a simplified subset of INI and YAML formats. Here is the supported syntax
      • configargparse.IniConfigParser - Create a INI parser bounded to the list of provided sections. Optionaly convert multiline strings to list.
      • configargparse.TomlConfigParser - Create a TOML parser bounded to the list of provided sections.
      • configargparse.YAMLConfigFileParser - Parses YAML config files. Depends on the PyYAML module. https://pypi.python.org/pypi/PyYAML
API Documentation for ConfigArgParse 1.7, generated by pydoctor 24.11.2 at 2025-05-19 16:16:14.