String substep argument.
More...
|
def | value (self) |
| Return argument value. More...
|
|
def | prodsysDescription (self) |
|
def | value (self, value) |
| Set argument value. More...
|
|
def | returnMyValue (self, name=None, substep=None, first=False, exe=None) |
| Return the value of this substep arg for an executor with the given parameters. More...
|
|
def | isRunarg (self) |
| Return runarg status. More...
|
|
def | name (self) |
| Name getter. More...
|
|
def | name (self, value) |
| Name setter. More...
|
|
def | __str__ (self) |
| String conversion of our value. More...
|
|
def | __repr__ (self) |
| Repr conversion of our value. More...
|
|
def | __eq__ (self, other) |
| Comparison is based on value attribute. More...
|
|
def | __nq__ (self, other) |
|
def | __lt__ (self, other) |
|
def | __gt__ (self, other) |
|
String substep argument.
Definition at line 2101 of file trfArgClasses.py.
◆ __eq__()
def python.trfArgClasses.argument.__eq__ |
( |
|
self, |
|
|
|
other |
|
) |
| |
|
inherited |
Comparison is based on value attribute.
Definition at line 161 of file trfArgClasses.py.
161 def __eq__(self,other):
162 return self.value == other.value
◆ __gt__()
def python.trfArgClasses.argument.__gt__ |
( |
|
self, |
|
|
|
other |
|
) |
| |
|
inherited |
Definition at line 170 of file trfArgClasses.py.
170 def __gt__(self, other):
171 return self.value > other.value
◆ __lt__()
def python.trfArgClasses.argument.__lt__ |
( |
|
self, |
|
|
|
other |
|
) |
| |
|
inherited |
Definition at line 167 of file trfArgClasses.py.
167 def __lt__(self, other):
168 return self.value < other.value
◆ __nq__()
def python.trfArgClasses.argument.__nq__ |
( |
|
self, |
|
|
|
other |
|
) |
| |
|
inherited |
Definition at line 164 of file trfArgClasses.py.
164 def __nq__(self, other):
165 return self.value != other.value
◆ __repr__()
def python.trfArgClasses.argument.__repr__ |
( |
|
self | ) |
|
|
inherited |
◆ __str__()
def python.trfArgClasses.argument.__str__ |
( |
|
self | ) |
|
|
inherited |
◆ _parseStringAsSubstep()
def python.trfArgClasses.argSubstep._parseStringAsSubstep |
( |
|
self, |
|
|
|
string |
|
) |
| |
|
privateinherited |
Parse a string for substep:value format.
If the string matches the substep specifier regexp then we return the two parts; if not then the substep is returned as self._defaultSubstep
, with the entire string passed back as the value
- Parameters
-
string | The string which should be parsed |
Reimplemented in python.trfArgClasses.argSubstepList.
Definition at line 1971 of file trfArgClasses.py.
1971 def _parseStringAsSubstep(self, string):
1972 subStepMatch = re.match(
r'([a-zA-Z0-9,]+)' + self._separator +
r'(.*)', string)
1975 subStep = subStepMatch.group(1).
split(
',')
1976 subStepValue = subStepMatch.group(2)
1978 subStep = [self._defaultSubstep]
1979 subStepValue = string
1980 msg.debug(
'Parsed {0} as substep {1}, argument {2}'.
format(string, subStep, subStepValue))
1981 for step
in subStep:
1982 subStepList.append((step, subStepValue))
◆ isRunarg()
def python.trfArgClasses.argument.isRunarg |
( |
|
self | ) |
|
|
inherited |
◆ name() [1/2]
def python.trfArgClasses.argument.name |
( |
|
self | ) |
|
|
inherited |
◆ name() [2/2]
def python.trfArgClasses.argument.name |
( |
|
self, |
|
|
|
value |
|
) |
| |
|
inherited |
◆ prodsysDescription()
def python.trfArgClasses.argSubstepString.prodsysDescription |
( |
|
self | ) |
|
Reimplemented from python.trfArgClasses.argSubstep.
Definition at line 2109 of file trfArgClasses.py.
2109 def prodsysDescription(self):
2110 desc = {
'type':
'substep',
'substeptype':
'str',
'separator': self._separator,
2111 'default': self._defaultSubstep}
◆ returnMyValue()
def python.trfArgClasses.argSubstep.returnMyValue |
( |
|
self, |
|
|
|
name = None , |
|
|
|
substep = None , |
|
|
|
first = False , |
|
|
|
exe = None |
|
) |
| |
|
inherited |
Return the value of this substep arg for an executor with the given parameters.
- Parameters
-
name | Executor name |
substep | Executor substep nickname |
first | Boolean flag set true if this is the first executor in the chain |
exe | Executor instance, from which 'name', 'substep' and 'first' can be taken.
|
Definition at line 1991 of file trfArgClasses.py.
1991 def returnMyValue(self, name=None, substep=None, first=False, exe=None):
1994 substep = exe.substep
1995 first = exe.conf.firstExecutor
2001 if name
in self._value:
2002 value = self._value[name]
2003 elif substep
in self._value:
2004 value = self._value[substep]
2005 elif first
and 'first' in self._value:
2006 value = self._value[
'first']
2007 elif 'default' in self._value:
2008 value = self._value[
'default']
2018 if 'all' in self._value:
2020 value = self._value[
'all']
2021 elif isinstance(value, list):
2022 value = self._value[
'all'] + value
2024 msg.debug(
'From substep argument {myvalue} picked value "{value}" for {name}, {substep}, first={first}'.
format(myvalue=self._value, value=value, name=name, substep=substep, first=first))
◆ value() [1/2]
def python.trfArgClasses.argSubstepString.value |
( |
|
self | ) |
|
◆ value() [2/2]
def python.trfArgClasses.argSubstepString.value |
( |
|
self, |
|
|
|
value |
|
) |
| |
Set argument value.
- Note
- No conversion or coercion done
Reimplemented from python.trfArgClasses.argSubstep.
Definition at line 2115 of file trfArgClasses.py.
2115 def value(self, value):
2116 msg.debug(
'Attempting to set argSubstep from {0!s} (type {1}'.
format(value,
type(value)))
2119 elif isinstance(value, str):
2120 subStepList = self._parseStringAsSubstep(value)
2121 self._value = dict([(subStep[0], subStep[1])
for subStep
in subStepList])
2122 elif isinstance(value, (list, tuple)):
2126 if not isinstance(item, str):
2127 raise trfExceptions.TransformArgException(trfExit.nameToCode(
'TRF_ARG_CONV_FAIL'),
'Failed to convert list item {0!s} to substep (should be a string)'.
format(item))
2128 subStepList = self._parseStringAsSubstep(item)
2129 for subStep
in subStepList:
2130 self._value[subStep[0]] = subStep[1]
2131 elif isinstance(value, dict):
2132 for k, v
in value.items():
2133 if not isinstance(k, str):
2134 raise trfExceptions.TransformArgException(trfExit.nameToCode(
'TRF_ARG_CONV_FAIL'),
'Dictionary key {0!s} for substep is not a string'.
format(k))
2135 if not isinstance(v, str):
2136 raise trfExceptions.TransformArgException(trfExit.nameToCode(
'TRF_ARG_CONV_FAIL'),
'Dictionary value {0!s} for substep is not a string'.
format(v))
2139 raise trfExceptions.TransformArgException(trfExit.nameToCode(
'TRF_ARG_CONV_FAIL'),
'Setter value {0!s} (type {1}) for substep argument cannot be parsed'.
format(value,
type(value)))
◆ _defaultSubstep
python.trfArgClasses.argSubstep._defaultSubstep |
|
privateinherited |
◆ _name
python.trfArgClasses.argument._name |
|
privateinherited |
◆ _runarg
python.trfArgClasses.argument._runarg |
|
privateinherited |
◆ _separator
python.trfArgClasses.argSubstep._separator |
|
privateinherited |
◆ _value
python.trfArgClasses.argSubstepString._value |
|
private |
◆ value
python.trfArgClasses.argument.value |
|
inherited |
- Note
- We have a default of None here, but all derived classes should definitely have their own value setter and translate this value to something sensible for their underlying value type. N.B. As most argument classes use this default constructor it must call the
@value
.setter function!
Definition at line 118 of file trfArgClasses.py.
The documentation for this class was generated from the following file: