python.trfArgClasses.argSubstep Class Reference

Base class for substep arguments. More...

Inheritance diagram for python.trfArgClasses.argSubstep:

Collaboration diagram for python.trfArgClasses.argSubstep:

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
	__init__ (self, value=None, runarg=True, name=None, defaultSubstep='all', separator=':')
	argSubstep constructor
	value (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.
	prodsysDescription (self)
	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)

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

Protected Attributes
	_defaultSubstep = defaultSubstep
	_separator = separator
	_runarg = runarg
	_name = name
	_value = value

Detailed Description

Base class for substep arguments.

Sets up a dictionary with {substep1: value1, substep2: value2, ...} In this base class we don't put any restructions on the values - they will be specialised in children.

Definition at line 1960 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.

Constructor & Destructor Documentation

__init__()

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

argSubstep constructor

Parameters

defaultSubstep

Default substep to use when no specific substep has been given - this should be set to first for arguments that apply, by default, to the first executor in the chain (e.g., maxEvents)

Definition at line 1965 of file trfArgClasses.py.

    def __init__(self, value = None, runarg = True, name = None, defaultSubstep = 'all', separator = ':'):
        self._defaultSubstep = defaultSubstep
        self._separator = separator
        super(argSubstep, self).__init__(value, runarg, name)
    

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)
    

_parseStringAsSubstep()

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

protected

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
    
    

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.argSubstep.prodsysDescription

(

self

)

Reimplemented from python.trfArgClasses.argument.

Reimplemented in python.trfArgClasses.argSubstepBool, python.trfArgClasses.argSubstepConditions, python.trfArgClasses.argSubstepFloat, python.trfArgClasses.argSubstepInt, python.trfArgClasses.argSubstepList, python.trfArgClasses.argSubstepSteering, and python.trfArgClasses.argSubstepString.

Definition at line 2059 of file trfArgClasses.py.

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

returnMyValue()

python.trfArgClasses.argSubstep.returnMyValue	(		self,
			name = None,
			substep = None,
			first = False,
			exe = None )

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.argSubstep.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.argument.

Reimplemented in python.trfArgClasses.argSubstepBool, python.trfArgClasses.argSubstepBool, python.trfArgClasses.argSubstepConditions, python.trfArgClasses.argSubstepConditions, python.trfArgClasses.argSubstepFloat, python.trfArgClasses.argSubstepFloat, python.trfArgClasses.argSubstepInt, python.trfArgClasses.argSubstepInt, python.trfArgClasses.argSubstepList, python.trfArgClasses.argSubstepList, python.trfArgClasses.argSubstepSteering, python.trfArgClasses.argSubstepSteering, python.trfArgClasses.argSubstepString, and python.trfArgClasses.argSubstepString.

Definition at line 1972 of file trfArgClasses.py.

    def value(self):
        return self._value
 

value() [2/2]

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

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.argument.

Reimplemented in python.trfArgClasses.argSubstepBool, python.trfArgClasses.argSubstepBool, python.trfArgClasses.argSubstepConditions, python.trfArgClasses.argSubstepConditions, python.trfArgClasses.argSubstepFloat, python.trfArgClasses.argSubstepFloat, python.trfArgClasses.argSubstepInt, python.trfArgClasses.argSubstepInt, python.trfArgClasses.argSubstepList, python.trfArgClasses.argSubstepList, python.trfArgClasses.argSubstepSteering, python.trfArgClasses.argSubstepSteering, python.trfArgClasses.argSubstepString, and python.trfArgClasses.argSubstepString.

Definition at line 1977 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, so we go through them one by one
            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))
                self._value.update(dict(self._parseStringAsSubstep(item)))
        elif isinstance(value, dict):
            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 = defaultSubstep

protected

Definition at line 1966 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

protected

Definition at line 1967 of file trfArgClasses.py.

_value

python.trfArgClasses.argument._value = value

protectedinherited

Definition at line 130 of file trfArgClasses.py.

---

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

• trfArgClasses.py