argparse.ArgumentParser Class Reference
Inheritance diagram for argparse.ArgumentParser:
Public Member Functions | |
| def | __init__ (self, prog=None, usage=None, description=None, epilog=None, version=None, parents=[], formatter_class=HelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True) |
| def | add_subparsers (self, **kwargs) |
| def | parse_args (self, args=None, namespace=None) |
| def | parse_known_args (self, args=None, namespace=None) |
| def | convert_arg_line_to_args (self, arg_line) |
| def | format_usage (self) |
| def | format_help (self) |
| def | format_version (self) |
| def | print_usage (self, file=None) |
| def | print_help (self, file=None) |
| def | print_version (self, file=None) |
| def | exit (self, status=0, message=None) |
| def | error (self, message) |
 Public Member Functions inherited from argparse._AttributeHolder | |
| def | __repr__ (self) |
| Public Member Functions inherited from argparse._ActionsContainer | |
| def | __init__ (self, description, prefix_chars, argument_default, conflict_handler) |
| def | register (self, registry_name, value, object) |
| def | set_defaults (self, **kwargs) |
| def | get_default (self, dest) |
| def | add_argument (self, *args, **kwargs) |
| def | add_argument_group (self, *args, **kwargs) |
| def | add_mutually_exclusive_group (self, **kwargs) |
Public Attributes | |
| prog | |
| usage | |
| epilog | |
| version | |
| formatter_class | |
| fromfile_prefix_chars | |
| add_help | |
| Public Attributes inherited from argparse._ActionsContainer | |
| description | |
| argument_default | |
| prefix_chars | |
| conflict_handler | |
Detailed Description
Object for parsing command line strings into Python objects.
Keyword Arguments:
- prog -- The name of the program (default: sys.argv[0])
- usage -- A usage message (default: auto-generated from arguments)
- description -- A description of what the program does
- epilog -- Text following the argument descriptions
- parents -- Parsers whose arguments should be copied into this one
- formatter_class -- HelpFormatter class for printing help messages
- prefix_chars -- Characters that prefix optional arguments
- fromfile_prefix_chars -- Characters that prefix files containing
additional arguments
- argument_default -- The default value for all arguments
- conflict_handler -- String indicating how to handle conflicts
- add_help -- Add a -h/-help option
Definition at line 1538 of file argparse.py.
Member Function Documentation
◆ error()
| def argparse.ArgumentParser.error | ( | self, | |
| message | |||
| ) |
error(message: string) Prints a usage message incorporating the message to stderr and exits. If you override this in a subclass, it should not return -- it should either exit or raise an exception.
Definition at line 2364 of file argparse.py.
The documentation for this class was generated from the following file:
- otsdaq-utilities/tools/argparse.py
