Public Member Functions
def	add (self, smallOption="", bigOption="", list=[], desc="", haveParam=False)

def	add_section (self, sectionName, sectionDesc)

def	parse (self)

def	display (self)

Detailed Description

Class to define the agmument list availlable for a program.

Member Function Documentation

Add a new argument possibilities...

Parameters

[in]	self	Class handle
[in]	smallOption	(char) Value for the small option ex: '-v' '-k' ... 1 single char element (no need of '-')
[in]	bigOption	(string) Value of the big option name ex: '–verbose' '–kill' ... stated with – and with the full name (no need of '–')
[in]	list	([[string,string],...]) Optionnal list of availlable option: '–mode=debug' ==> [['debug', 'debug mode'],['release', 'release the software']]
[in]	desc	(string) user friendly description with this parameter (default "")
[in]	haveParam	(bool) The option must have a parameter (default False)

def lutin.arg.LutinArg.add_section	(	self,
		sectionName,
		sectionDesc
	)

Add section on argument list.

Parameters

[in]	self	Class handle
[in]	sectionName	(string) Name of the cestion ex: "option" is displayed [option]
[in]	sectionDesc	(string) Comment assiciated with the group

def lutin.arg.LutinArg.display ( self )

Display help on console output.

Parameters

[in] self Class handle

def lutin.arg.LutinArg.parse ( self )

Parse the argument set in the command line.

Parameters

[in] self Class handle

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