HelperOptions Class Reference

Inheritance diagram for HelperOptions:

Public Member Functions
def	__init__ (self, parserHelperOptions=argparse.ArgumentParser(add_help=False))
def	addArguments (self)
def	parseArgs (self)

Public Attributes
	parserHelperOptions

Detailed Description

Class for Interface -> Helper Options

Args:
    object (parser_args() object): Helper Options Interface

Definition at line 22 of file helperOptions.py.

Constructor & Destructor Documentation

__init__()

def __init__	(		self,
			parserHelperOptions = argparse.ArgumentParser(add_help = False)
	)

Definition at line 31 of file helperOptions.py.

    def __init__(self, parserHelperOptions = argparse.ArgumentParser(add_help = False)):
        super(HelperOptions, self).__init__()
        self.parserHelperOptions = parserHelperOptions
    

Member Function Documentation

addArguments()

def addArguments

(

self

)

This function allows to add arguments for parser_args() function

Definition at line 35 of file helperOptions.py.

    def addArguments(self):
        """
        This function allows to add arguments for parser_args() function
        """
        
        # Predefined Selections
        debugLevelSelections = {
            "NOTSET": "Set Debug Level to NOTSET",
            "DEBUG": "Set Debug Level to DEBUG",
            "INFO": "Set Debug Level to INFO",
            "WARNING": "Set Debug Level to WARNING",
            "ERROR": "Set Debug Level to ERROR",
            "CRITICAL": "Set Debug Level to CRITICAL",
            }
        debugLevelSelectionsList = []
        for k, v in debugLevelSelections.items():
            debugLevelSelectionsList.append(k)
        
        booleanSelections = ["true", "false"]
        
        # Interface
        groupDebugOptions = self.parserHelperOptions.add_argument_group(title = "Additional Debug Options")
        groupDebugOptions.add_argument(
            "--debug", help = "execute with debug options", action = "store", type = str.upper, default = "INFO",
            choices = debugLevelSelectionsList,
            ).completer = ChoicesCompleterList(debugLevelSelectionsList)
        groupDebugOptions.add_argument("--logFile", help = "Enable logger for both file and CLI", action = "store_true")
        groupDebug = self.parserHelperOptions.add_argument_group(title = "Choice List for debug Parameters")
        
        for key, value in debugLevelSelections.items():
            groupDebug.add_argument(key, help = value, action = "none")
        
        groupAutomations = self.parserHelperOptions.add_argument_group(title = "Automation Parameters")
        groupAutomations.add_argument(
            "--onlySelect", help = "If false JSON Overrider Interface If true JSON Additional Interface", action = "store",
            default = "true", type = str.lower, choices = booleanSelections,
            ).completer = ChoicesCompleter(booleanSelections)
        groupAutomations.add_argument(
            "--autoDummy", help = "Dummy automize parameter (don't configure it, true is highly recomended for automation)",
            action = "store", default = "true", type = str.lower, choices = booleanSelections,
            ).completer = ChoicesCompleter(booleanSelections)
    

parseArgs()

def parseArgs

(

self

)

This function allows to save the obtained arguments to the parser_args() function

Returns:
    Namespace: returns parse_args()

Definition at line 77 of file helperOptions.py.

    def parseArgs(self):
        """
        This function allows to save the obtained arguments to the parser_args() function
 
        Returns:
            Namespace: returns parse_args()
        """
        
        return self.parserHelperOptions.parse_args()

Member Data Documentation

parserHelperOptions

parserHelperOptions

Definition at line 33 of file helperOptions.py.

---

The documentation for this class was generated from the following file:

• extramodules/helperOptions.py