Public Member Functions | |
def | __init__ |
def | add_subparsers |
def | convert_arg_line_to_args |
def | error |
def | exit |
def | format_help |
def | format_usage |
def | format_version |
def | parse_args |
def | parse_known_args |
def | print_help |
def | print_usage |
def | print_version |
Public Attributes | |
add_help | |
epilog | |
formatter_class | |
fromfile_prefix_chars | |
prog | |
usage | |
version |
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 1527 of file argparse.py.
Constructor & Destructor Documentation
def basis::argparse::ArgumentParser::__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 |
|||
) |
Definition at line 1545 of file argparse.py.
Member Function Documentation
def basis::argparse::ArgumentParser::add_subparsers | ( | self, | |
kwargs | |||
) |
Definition at line 1639 of file argparse.py.
def basis::argparse::ArgumentParser::convert_arg_line_to_args | ( | self, | |
arg_line | |||
) |
Definition at line 1996 of file argparse.py.
def basis::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 2340 of file argparse.py.
def basis::argparse::ArgumentParser::exit | ( | self, | |
status = 0 , |
|||
message = None |
|||
) |
Definition at line 2335 of file argparse.py.
def basis::argparse::ArgumentParser::format_help | ( | self | ) |
Definition at line 2269 of file argparse.py.
def basis::argparse::ArgumentParser::format_usage | ( | self | ) |
Definition at line 2263 of file argparse.py.
def basis::argparse::ArgumentParser::format_version | ( | self | ) |
Definition at line 2292 of file argparse.py.
def basis::argparse::ArgumentParser::parse_args | ( | self, | |
args = None , |
|||
namespace = None |
|||
) |
Definition at line 1690 of file argparse.py.
def basis::argparse::ArgumentParser::parse_known_args | ( | self, | |
args = None , |
|||
namespace = None |
|||
) |
Definition at line 1697 of file argparse.py.
def basis::argparse::ArgumentParser::print_help | ( | self, | |
file = None |
|||
) |
Definition at line 2313 of file argparse.py.
def basis::argparse::ArgumentParser::print_usage | ( | self, | |
file = None |
|||
) |
Definition at line 2308 of file argparse.py.
def basis::argparse::ArgumentParser::print_version | ( | self, | |
file = None |
|||
) |
Definition at line 2318 of file argparse.py.
Member Data Documentation
Definition at line 1545 of file argparse.py.
Definition at line 1545 of file argparse.py.
Definition at line 1545 of file argparse.py.
Definition at line 1545 of file argparse.py.
Definition at line 1545 of file argparse.py.
Definition at line 1545 of file argparse.py.
Definition at line 1545 of file argparse.py.
The documentation for this class was generated from the following file: