Special argument class to hold steering information. More...

Inheritance diagram for python.trfArgClasses.argSubstepSteering:

Collaboration diagram for python.trfArgClasses.argSubstepSteering:

Public Types
typedef HLT::TypeInformation::for_each_type_c< typenameEDMLIST::map, my_functor, my_result<>, my_arg< HLT::TypeInformation::get_cont, CONTAINER > >::type	result

Public Member Functions
	value (self)
	dumpvalue (self)
	prodsysDescription (self)
	value (self, value)
	returnMyValue (self, name=None, substep=None, first=False, exe=None)
	Return the value of this substep arg for an executor with the given parameters.
	isRunarg (self)
	Return runarg status.
	name (self)
	Name getter.
	name (self, value)
	Name setter.
	__str__ (self)
	String conversion of our value.
	__repr__ (self)
	Repr conversion of our value.
	__eq__ (self, other)
	Comparison is based on value attribute.
	__nq__ (self, other)
	__lt__ (self, other)
	__gt__ (self, other)

Static Public Attributes
dict	steeringAlises

Protected Member Functions
	_parseSetterString (self, string)
	_parseSteeringString (self, ivalue)
	_parseStringAsSubstep (self, string)
	Parse a string for substep:value format.

Protected Attributes
list	_dumpvalue = [""]
	_defaultSubstep = defaultSubstep
	_separator = separator
	_runarg = runarg
	_name = name
	_value = value

Detailed Description

Special argument class to hold steering information.

Definition at line 2331 of file trfArgClasses.py.

Member Typedef Documentation

◆ result

typedef HLT::TypeInformation::for_each_type_c<typenameEDMLIST::map,my_functor,my_result<>,my_arg<HLT::TypeInformation::get_cont,CONTAINER>>::type master_search< typenameEDMLIST::map, HLT::TypeInformation::get_cont, CONTAINER >::result

inherited

Definition at line 90 of file EDM_MasterSearch.h.

Member Function Documentation

◆ eq()

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()

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()

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()

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()

python.trfArgClasses.argument.__repr__ ( self )

inherited

Repr conversion of our value.

Definition at line 157 of file trfArgClasses.py.

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

◆ str()

python.trfArgClasses.argument.__str__ ( self )

inherited

String conversion of our value.

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)
    

◆ _parseSetterString()

python.trfArgClasses.argSubstepSteering._parseSetterString	(		self,
			string )

protected

Definition at line 2418 of file trfArgClasses.py.

    def _parseSetterString(self, string):
        if string in argSubstepSteering.steeringAlises:
            return argSubstepSteering.steeringAlises[string]
 

◆ _parseSteeringString()

python.trfArgClasses.argSubstepSteering._parseSteeringString	(		self,
			ivalue )

protected

Definition at line 2422 of file trfArgClasses.py.

    def _parseSteeringString(self, ivalue):
        retvalue = []
        for subvalue in ivalue.split(','):
            matchedParts = re.match(r'(in|out)(\+|\-)([A-Z_]+)$', subvalue)
            if not matchedParts:
                raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 
                                                          'Failed to convert string {0!s} to argSubstepSteering'.format(subvalue))
            retvalue.append((matchedParts.group(1), matchedParts.group(2), matchedParts.group(3)))
        return retvalue
 
 

◆ _parseStringAsSubstep()

python.trfArgClasses.argSubstep._parseStringAsSubstep	(		self,
			string )

protectedinherited

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

    def _parseStringAsSubstep(self, string):
        subStepMatch = re.match(r'([a-zA-Z0-9,]+)' + self._separator + r'(.*)', string)
        subStepList = []
        if subStepMatch:
            subStep = subStepMatch.group(1).split(',')
            subStepValue = subStepMatch.group(2)
        else:
            subStep = [self._defaultSubstep]
            subStepValue = string
        msg.debug('Parsed {0} as substep {1}, argument {2}'.format(string, subStep, subStepValue))
        for step in subStep:
            subStepList.append((step, subStepValue))
        return subStepList
    
    

◆ dumpvalue()

python.trfArgClasses.argSubstepSteering.dumpvalue ( self )

Definition at line 2360 of file trfArgClasses.py.

    def dumpvalue(self):
        return self._dumpvalue
 

◆ isRunarg()

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]

python.trfArgClasses.argument.name ( self )

inherited

Name getter.

Reimplemented in python.trfArgClasses.argFile, and python.trfArgClasses.argFile.

Definition at line 139 of file trfArgClasses.py.

    def name(self):
        return self._name
    

◆ name() [2/2]

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

inherited

Name setter.

Reimplemented in python.trfArgClasses.argFile, and python.trfArgClasses.argFile.

Definition at line 144 of file trfArgClasses.py.

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

◆ prodsysDescription()

python.trfArgClasses.argSubstepSteering.prodsysDescription ( self )

Reimplemented from python.trfArgClasses.argSubstep.

Definition at line 2364 of file trfArgClasses.py.

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

◆ returnMyValue()

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]

python.trfArgClasses.argSubstepSteering.value ( self )

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!

Reimplemented from python.trfArgClasses.argSubstep.

Definition at line 2354 of file trfArgClasses.py.

    def value(self):
        return self._value
    

◆ value() [2/2]

python.trfArgClasses.argSubstepSteering.value	(		self,
			value )

For strings passed to the setter we expect the format to be substep:{in/out}{+/-}DATATYPE or to be a steering alias, which is then expanded to the more complex format. This is then cast into a dictionary of tuples {substep: [('in/out', '+/-', DATATYPE), ...], ...}

Reimplemented from python.trfArgClasses.argSubstep.

Definition at line 2373 of file trfArgClasses.py.

    def value(self, value):
        msg.debug('Attempting to set argSubstepSteering from {0!s} (type {1})'.format(value, type(value)))
        if value is None:
            self._value = {}
            self._dumpvalue = [""]
        elif isinstance(value, dict):
            # OK, this should be the direct setable dictionary - but do a check of that
            for k, v in value.items():
                if not isinstance(k, str) or not isinstance(v, list):
                    raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 
                                                              'Failed to convert dict {0!s} to argSubstepSteering'.format(value))
                for subv in v:
                    if not isinstance(subv, (list, tuple)) or len(subv) != 3 or subv[0] not in ('in', 'out') or subv[1] not in ('+', '-'):                    
                        raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'), 
                                                                  'Failed to convert dict {0!s} to argSubstepSteering'.format(value))                    
            self._value = value
            # Note we are a little careful here to never reset the dumpvalue - this is 
            # because when processing the _list_ of steering arguments down to a single
            # multi-valued argument we re-call value() with an expanded diectionary and
            # one can nievely reset dumpvalue by mistake
            self._dumpvalue = getattr(self, "_dumpvalue", value)
        elif isinstance(value, (str, list, tuple)):
            if isinstance(value, str):
                value = [value,]
            self._dumpvalue = getattr(self, "_dumpvalue", value)
            # Now we have 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))
                if item in argSubstepSteering.steeringAlises:
                    msg.debug("Found value {0} in steeringAlises ({1})".format(item, argSubstepSteering.steeringAlises[item]))
                    for substep, steerlist in argSubstepSteering.steeringAlises[item].items():
                        if substep in self._value:
                            self._value[substep].extend(steerlist)
                        else:
                            self._value[substep] = steerlist
                else:
                    subStepList = self._parseStringAsSubstep(item)
                    self._value.update(dict([(subStep[0], self._parseSteeringString(subStep[1])) for subStep in subStepList]))
        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 = defaultSubstep

protectedinherited

Definition at line 1966 of file trfArgClasses.py.

◆ _dumpvalue

list python.trfArgClasses.argSubstepSteering._dumpvalue = [""]

protected

Definition at line 2377 of file trfArgClasses.py.

◆ _name

python.trfArgClasses.argument._name = name

protectedinherited

Definition at line 111 of file trfArgClasses.py.

◆ _runarg

python.trfArgClasses.argument._runarg = runarg

protectedinherited

Definition at line 110 of file trfArgClasses.py.

◆ _separator

python.trfArgClasses.argSubstep._separator = separator

protectedinherited

Definition at line 1967 of file trfArgClasses.py.

◆ _value

python.trfArgClasses.argument._value = value

protectedinherited

Definition at line 130 of file trfArgClasses.py.

◆ steeringAlises

dict python.trfArgClasses.argSubstepSteering.steeringAlises

static

Initial value:

=  {
                      'no': {},
                      'doRDO_TRIG': {'RAWtoALL': [('in', '-', 'RDO'), ('in', '+', 'RDO_TRIG'), ('in', '-', 'BS')]},
                      'doOverlay': {'HITtoRDO': [('in', '-', 'HITS'), ('out', '-', 'RDO'), ('out', '-', 'RDO_FILT')],
                                    'Overlay': [('in', '+', ('HITS', 'RDO_BKG')), ('out', '+', 'RDO')]},
                      'doFCtoDAOD': {'Derivation': [('in', '-', 'EVNT')]},
                      'afterburn': {'generate': [('out', '-', 'EVNT')]},
                      'doRAWtoALL': {},
                      'doTRIGtoALL': {}
                      }

Definition at line 2341 of file trfArgClasses.py.

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

trfArgClasses.py

Public Types

Public Member Functions

Static Public Attributes

Protected Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ result

Member Function Documentation

◆ __eq__()

◆ __gt__()

◆ __lt__()

◆ __nq__()

◆ __repr__()

◆ __str__()

◆ _parseSetterString()

◆ _parseSteeringString()

◆ _parseStringAsSubstep()

◆ dumpvalue()

◆ isRunarg()

◆ name() [1/2]

◆ name() [2/2]

◆ prodsysDescription()

◆ returnMyValue()

◆ value() [1/2]

◆ value() [2/2]

Member Data Documentation

◆ _defaultSubstep

◆ _dumpvalue

◆ _name

◆ _runarg

◆ _separator

◆ _value

◆ steeringAlises

◆ eq()

◆ gt()

◆ lt()

◆ nq()

◆ repr()

◆ str()