python.trfArgClasses.argSubstepList Class Reference

Argument class for substep lists, suitable for preExec/postExec. More...

Inheritance diagram for python.trfArgClasses.argSubstepList:

Collaboration diagram for python.trfArgClasses.argSubstepList:

Public Member Functions
def	__init__ (self, value=None, runarg=True, name=None, defaultSubstep='all', splitter=None, separator=':')
	argSubstepList constructor 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)

Public Attributes
	value

Private Member Functions
def	_parseStringAsSubstep (self, value)
	Specialist parser for lists, which applies the splitter string, if defined. More...

Private Attributes
	_splitter
	_value
	_defaultSubstep
	_separator
	_runarg
	_name

Detailed Description

Argument class for substep lists, suitable for preExec/postExec.

substep is followed by a ':' then the python fragments. The substep is validated and set as the key in a dictionary with the value being the python following the ':'.

• If no substep (e.g. r2a) is specified, it will be parsed for 'all'.

  Note

  substep can be either the subspet property of an executor or the executor's name. Thus r2a:something is the same as RAWtoALL:something.

Definition at line 2070 of file trfArgClasses.py.

Constructor & Destructor Documentation

__init__()

def python.trfArgClasses.argSubstepList.__init__	(		self,
			value = None,
			runarg = True,
			name = None,
			defaultSubstep = 'all',
			splitter = None,
			separator = ':'
	)

argSubstepList constructor

Adds the optional splitter argument to the base argSubstep class

Parameters

splitter

Character used to split the string into multiple list elements

Definition at line 2075 of file trfArgClasses.py.

    def __init__(self, value = None, runarg = True, name = None, defaultSubstep = 'all', splitter = None, separator=':'):        self._splitter = splitter
        super(argSubstepList, self).__init__(value, runarg, name, defaultSubstep, separator)
 
        
 

Member Function Documentation

__eq__()

def python.trfArgClasses.argument.__eq__ (   self,   other  )

inherited

Comparison is based on value attribute.

Definition at line 161 of file trfArgClasses.py.

    def __eq__(self,other):
        return self.value == other.value
 

__gt__()

def python.trfArgClasses.argument.__gt__ (   self,   other  )

inherited

Definition at line 170 of file trfArgClasses.py.

    def __gt__(self, other):
        return self.value > other.value
 

__lt__()

def python.trfArgClasses.argument.__lt__ (   self,   other  )

inherited

Definition at line 167 of file trfArgClasses.py.

    def __lt__(self, other):
        return self.value < other.value
 

__nq__()

def python.trfArgClasses.argument.__nq__ (   self,   other  )

inherited

Definition at line 164 of file trfArgClasses.py.

    def __nq__(self, other):
        return self.value != other.value
 

__repr__()

def python.trfArgClasses.argument.__repr__ (   self )

inherited

Repr conversion of our value.

Reimplemented in python.trfArgClasses.argList.

Definition at line 157 of file trfArgClasses.py.

    def __repr__(self):
        return repr(self.value)
    

__str__()

def python.trfArgClasses.argument.__str__ (   self )

inherited

String conversion of our value.

Reimplemented in python.trfArgClasses.argFile, python.trfArgClasses.argKeyFloatValueList, python.trfArgClasses.argIntList, python.trfArgClasses.argList, and python.trfArgClasses.argString.

Definition at line 153 of file trfArgClasses.py.

    def __str__(self):
        return '{0}: Value {1} (isRunArg={2})'.format(self.__class__.__name__, self._value, self._runarg)
    

_parseStringAsSubstep()

def python.trfArgClasses.argSubstepList._parseStringAsSubstep (   self,   value  )

private

Specialist parser for lists, which applies the splitter string, if defined.

Returns

Tuple of substep plus a list of strings

Reimplemented from python.trfArgClasses.argSubstep.

Definition at line 2122 of file trfArgClasses.py.

    def _parseStringAsSubstep(self, value):
        subStepList = super(argSubstepList, self)._parseStringAsSubstep(value)
        if self._splitter:
            subStepList = [(s[0], s[1].split(self._splitter)) for s in subStepList]
        else:
            subStepList = [(s[0], [s[1]]) for s in subStepList]
        return subStepList
 

isRunarg()

def python.trfArgClasses.argument.isRunarg (   self )

inherited

Return runarg status.

Definition at line 134 of file trfArgClasses.py.

    def isRunarg(self):
        return self._runarg
    

name() [1/2]

def python.trfArgClasses.argument.name (   self )

inherited

Name getter.

Reimplemented in python.trfArgClasses.argFile.

Definition at line 139 of file trfArgClasses.py.

    def name(self):
        return self._name
    

name() [2/2]

def python.trfArgClasses.argument.name (   self,   value  )

inherited

Name setter.

Reimplemented in python.trfArgClasses.argFile.

Definition at line 144 of file trfArgClasses.py.

    def name(self, value):
        self._name = value
 

prodsysDescription()

def python.trfArgClasses.argSubstepList.prodsysDescription

(

self

)

Reimplemented from python.trfArgClasses.argSubstep.

Definition at line 2086 of file trfArgClasses.py.

    def prodsysDescription(self):
        desc = {'type': 'substep', 'substeptype': 'list', 'listtype': 'str',
                'separator': self._separator,
                'default': self._defaultSubstep}
        return desc

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 2021 of file trfArgClasses.py.

    def returnMyValue(self, name=None, substep=None, first=False, exe=None):
        if exe:
            name = exe.name
            substep = exe.substep
            first = exe.conf.firstExecutor
 
        name = commonExecutorStepName(name)
 
        value = None
        
        if name in self._value:
            value = self._value[name]
        elif substep in self._value:
            value = self._value[substep]  
        elif first and 'first' in self._value:
            value = self._value['first']
        elif 'default' in self._value:
            value = self._value['default']
            
        
        if 'all' in self._value:
            if value is None:
                value = self._value['all']
            elif isinstance(value, list):
                value = self._value['all'] + value
                
        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))
        
        return value
 

value() [1/2]

def python.trfArgClasses.argSubstepList.value

(

self

)

Return argument value.

Returns

Current value

Reimplemented from python.trfArgClasses.argSubstep.

Definition at line 2082 of file trfArgClasses.py.

    def value(self):
        return self._value
 

value() [2/2]

def python.trfArgClasses.argSubstepList.value	(		self,
			value
	)

Set argument value.

Note

No conversion or coercion done

Reimplemented from python.trfArgClasses.argSubstep.

Definition at line 2092 of file trfArgClasses.py.

    def value(self, value):
        msg.debug('Attempting to set argSubstep from {0!s} (type {1}'.format(value, type(value)))
        if value is None:
            self._value = {}
        elif isinstance(value, str):
            self._value = dict(self._parseStringAsSubstep(value))
        elif isinstance(value, (list, tuple)):
            # This is a list of strings to parse
            self._value = {}
            for item in value:
                if not isinstance(item, str):
                    raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 'Failed to convert list item {0!s} to substep (should be a string)'.format(item))
                subStepList = self._parseStringAsSubstep(item)
                for subStep in subStepList:
                    if subStep[0] in self._value:
                        self._value[subStep[0]].extend(subStep[1])
                    else:
                        self._value[subStep[0]] = subStep[1]
        elif isinstance(value, dict):
            for k, v in value.items():
                if not isinstance(k, str):
                    raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 'Dictionary key {0!s} for substep is not a string'.format(k))
                if not isinstance(v, list):
                    raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 'Dictionary value {0!s} for substep is not a list'.format(v))
            self._value = value
        else:
            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)))
 

Member Data Documentation

_defaultSubstep

python.trfArgClasses.argSubstep._defaultSubstep

privateinherited

Definition at line 1966 of file trfArgClasses.py.

_name

python.trfArgClasses.argument._name

privateinherited

Definition at line 111 of file trfArgClasses.py.

_runarg

python.trfArgClasses.argument._runarg

privateinherited

Definition at line 110 of file trfArgClasses.py.

_separator

python.trfArgClasses.argSubstep._separator

privateinherited

Definition at line 1967 of file trfArgClasses.py.

_splitter

python.trfArgClasses.argSubstepList._splitter

private

Definition at line 2076 of file trfArgClasses.py.

_value

python.trfArgClasses.argSubstepList._value

private

Definition at line 2095 of file trfArgClasses.py.

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:

• trfArgClasses.py