PkgArgumentParser Class Reference
+ Inheritance diagram for PkgArgumentParser:

Public Member Functions

def add_package_arguments (self, fullscriptpath, **kwargs)
 
def add_logging_options (self)
 
def parse_args (self, args=None, namespace=None)
 
- Public Member Functions inherited from ArgumentParser
def __init__ (self, prog=None, usage=None, description=None, epilog=None, version=None, parents=None, formatter_class=BriefHelpFormatter, prefix_chars='-', fromfile_prefix_chars=None, argument_default=None, conflict_handler='error', add_help=True)
 
def format_help (self)
 
def add_argument_group (self, *args, **kwargs)
 
def add_output_argument_group (self, *args, **kwargs)
 
def add_argument (self, *args, **kwargs)
 
def generate_proxy_cls (self)
 construct class from a dict containing object definition (name, attributes) More...
 
def print_single_help (self, values)
 
def print_doxygen_help (self, file=None)
 

Public Attributes

 pkg_arguments
 
 has_subscripts
 
 subscripts
 
 allscripts
 
 out_pairs
 
 logging_arguments
 
- Public Attributes inherited from ArgumentParser
 user_actions
 
 action_extras
 
 doxygen_description_width
 
 epilog
 

Static Public Attributes

bool pkg_arguments = False
 
bool logging_arguments = False
 
bool has_subscripts = False
 
list allscripts = []
 
list subscripts = []
 
 fullscriptpath = __file__
 
bool out_pairs = False
 

Detailed Description

 Special case of Argument Parser for OPALS Package Script
 provide common parameter set

Member Function Documentation

◆ add_package_arguments()

def add_package_arguments (   self,
  fullscriptpath,
**  kwargs 
)
     add common arguments for OPALS package script (input, output, tempdir, config, projectdir, etc.)

References ArgumentParser.add_argument_group(), PkgArgumentParser.add_logging_options(), PkgArgumentParser.allscripts, PkgArgumentParser.fullscriptpath, PkgArgumentParser.has_subscripts, PkgArgumentParser.logging_arguments, PkgArgumentParser.out_pairs, PkgArgumentParser.pkg_arguments, and PkgArgumentParser.subscripts.