parser

The parser module is used for interacting with argparse, setting up the argument parser and the default values.

Command line argument parsing

helper.parser.description(value)

A string providing a description of the application (default: none)

Parameters:value (str) – Description value

helper.parser.epilog(value)

Text to display after the description of the arguments (default: none)

Parameters:value (str) – Epilog value

helper.parser.get()

Return the handle to the argument parser.

Return type:argparse.ArgumentParser

helper.parser.name(value)

A string providing an override of the name of the application from what is obtained from sys.argv[0]. (default: sys.argv[0])

Parameters:value (str) – Name value

helper.parser.parse()

Parse the command line arguments and return the result

Return type:argparse.Namespace

helper.parser.usage(value)

The string describing the program usage (default: generated from arguments added to parser)

Parameters:value (str) – Usage value