Loading [MathJax]/extensions/tex2jax.js
python.tools.opalsargparse Namespace Reference

OPALS internal argument parser class (extended from system built-in) More...

Classes

class  _DoxygenAction
 hidden action to generate Doxygen parameter documentation More...
 
class  _HelpAction
 Action to enable query for longer description from an option string. More...
 
class  _HelpHtmlAction
 Action to start html docu in the standard browser. More...
 
class  _PassAction
 Action to enable query for longer description from an option string. More...
 
class  _ProxyGenAction
 hidden action to generate Python proxy class More...
 
class  _VersionAction
 support version and license information More...
 
class  ArgumentGroup
 make it so that argument groups' add_argument can accept opals style keyword arguments More...
 
class  ArgumentParser
 Custom OPALS style ArgumentParser class to enable similar parameter style with C++ version. More...
 
class  ArrayArgument
 used in type keyword of add_argument More...
 
class  Boolean
 convert integer 1 or string '1', 'true', 'yes' to True and False otherwise More...
 
class  BriefHelpFormatter
 custom formatter in conjunction to opals' custom ArgumentParser More...
 
class  Check
 do common checking regarding the value of the option More...
 
class  Estimable
 to be used in remark keyword of add_argument function More...
 
class  InfoChoice
 Choice item with (explanatory) information. More...
 
class  ListArgument
 used in type keyword of add_argument More...
 
class  PathArgument
 used in type keyword More...
 
class  PkgArgumentParser
 Special case of Argument Parser for OPALS Package Script provide common parameter set. More...
 
class  ValidateElementAction
 Generic element validation use validation=... More...
 

Functions

def boolean (value)
 
def preprocess_kwargs (kwargs)
 handles opals keyword arguments (brief, description, remark) and set python's argparse known keyword arguments appropriately More...
 

Variables

string ARGREMAINDER = '~~~'
 

Detailed Description

OPALS internal argument parser class (extended from system built-in)

Author
paryan

Function Documentation

◆ preprocess_kwargs()

def python.tools.opalsargparse.preprocess_kwargs (   kwargs)

handles opals keyword arguments (brief, description, remark) and set python's argparse known keyword arguments appropriately

Referenced by ArgumentParser.add_argument().