lutin.arg.ArgDefine Class Reference
Public Member Functions | |
| def | get_option_small (self) |
| def | get_option_big (self) |
| def | need_parameters (self) |
| def | get_porperties (self) |
| def | check_availlable (self, argument) |
| def | display (self) |
Public Attributes | |
| option_small | |
| option_big | |
| list | |
| have_param | |
| description | |
Detailed Description
Declare a possibility of an argument value.
Member Function Documentation
| def lutin.arg.ArgDefine.check_availlable | ( | self, | |
| argument | |||
| ) |
Check if the user added value is correct or not with the list of availlable value.
- Parameters
-
[in] self Class handle [in] argument (string) User parameter value (string)
- Returns
- True The parameter is OK
- False The parameter is NOT Availlable
| def lutin.arg.ArgDefine.display | ( | self | ) |
Display the argument property when user request help.
- Parameters
-
[in] self Class handle
| def lutin.arg.ArgDefine.get_option_big | ( | self | ) |
Get the big name of the option ex: '–verbose'.
- Parameters
-
[in] self Class handle
- Returns
- (string) Big name value
| def lutin.arg.ArgDefine.get_option_small | ( | self | ) |
Get the small name of the option ex: '-v'.
- Parameters
-
[in] self Class handle
- Returns
- (string) Small name value
| def lutin.arg.ArgDefine.get_porperties | ( | self | ) |
| def lutin.arg.ArgDefine.need_parameters | ( | self | ) |
Get the status of getting user parameter value.
- Parameters
-
[in] self Class handle
- Returns
- True The user must write a value
- False The user must NOT write a value
The documentation for this class was generated from the following file:
- lutin/lutin/arg.py
