Inheritance diagram for python.trfArgClasses.argKeyFloatValueList:

Collaboration diagram for python.trfArgClasses.argKeyFloatValueList:

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={}, supressEmptyStrings=True, splitter=',', kvsplitter=":", runarg=True, name=None)
	Dictionary of key value arguments, where the values are floats.
	value (self)
	Argument value getter.
	value (self, value)
	Argument value setter.
	__str__ (self)
	prodsysDescription (self)
	append (self, addme)
	Append a value to the list.
	__repr__ (self)
	Repr conversion.
	isRunarg (self)
	Return runarg status.
	name (self)
	Name getter.
	name (self, value)
	Name setter.
	__eq__ (self, other)
	Comparison is based on value attribute.
	__nq__ (self, other)
	__lt__ (self, other)
	__gt__ (self, other)

Protected Attributes
	_kvsplitter = kvsplitter
	_splitter = splitter
	_supressEmptyStrings = supressEmptyStrings
	_runarg = runarg
	_name = name
	_value = value

Detailed Description

Definition at line 458 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.argKeyFloatValueList.__init__	(	self,
		value = {},
		supressEmptyStrings = True,
		splitter = ',',
		kvsplitter = ":",
		runarg = True,
		name = None )

Dictionary of key value arguments, where the values are floats.

Parameters

splitter	The splitter argument determines how the string is split (default by a comma)
kvsplitter	The kvsplitter argument determines how the key and value are split (default by a colon)
value	Initial value to set (note default is an empty dictionary {})
supressEmptyStrings	If empty strings are removed from the list (Can be used to easily set an empty list from the CLI)

Definition at line 465 of file trfArgClasses.py.

    def __init__(self, value = {}, supressEmptyStrings = True, splitter=',', kvsplitter=":", runarg=True, name=None):
        self._splitter = splitter
        self._kvsplitter = kvsplitter
        self._supressEmptyStrings = supressEmptyStrings
 
        super(argList, self).__init__(value = value, runarg = runarg, name=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.argList.__repr__ ( self )

inherited

Repr conversion.

Return a python parsable string

Definition at line 409 of file trfArgClasses.py.

    def __repr__(self):
        return '[' + ','.join([ repr(s) for s in self._value ]) + ']'

◆ str()

python.trfArgClasses.argKeyFloatValueList.__str__ ( self )

Definition at line 511 of file trfArgClasses.py.

    def __str__(self):
        return str(self._value)
 

◆ append()

python.trfArgClasses.argList.append	(		self,
			addme )

inherited

Append a value to the list.

Parameters

addme Item to add

Definition at line 398 of file trfArgClasses.py.

    def append(self, addme):
        self._value.append(addme)
    

◆ 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.argKeyFloatValueList.prodsysDescription ( self )

Reimplemented from python.trfArgClasses.argList.

Definition at line 515 of file trfArgClasses.py.

    def prodsysDescription(self):
        desc = {'type' : 'list', 'listtype' : 'str:float'}
        return desc
        
 

◆ value() [1/2]

python.trfArgClasses.argKeyFloatValueList.value ( self )

Argument value getter.

Returns: Current value

Reimplemented from python.trfArgClasses.argList.

Definition at line 475 of file trfArgClasses.py.

    def value(self):
        return self._value
 

◆ value() [2/2]

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

Argument value setter.

If we get a dict then set that, otherwise we split a string on the splitter character and then on the kvsplitter into key and value, with the value being converted to float

Exceptions

trfExceptions.TransformArgException	Exception thrown if any dictionary `key:value` member is not `string:int`
trfExceptions.TransformArgException	Exception thrown if any `int()` conversion fails of the kvsplitter is not found

Reimplemented from python.trfArgClasses.argList.

Definition at line 484 of file trfArgClasses.py.

    def value(self, value):
        if isinstance(value, dict):
            for k, v in value.items():
                if not isinstance(k, str):
                    raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_ERROR'),
                                                              'Illegal key argument type {0} in dictionary for argKeyFloatValueList'.format(k))
                if not isinstance(v, float):
                    raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_ERROR'),
                                                              'Illegal value argument type {0} in dictionary for argKeyFloatValueList'.format(v))
            self._value = value
        elif value is None:
            self._value = {}
            return
        else:
            self._value = {}
            try:
                if self._supressEmptyStrings:
                    kvlist = [ v for v in value.split(self._splitter) if v != '' ]
                else:
                    kvlist = value.split(self._splitter)
                for item in kvlist:
                    k, v = item.split(self._kvsplitter, 1)
                    self._value[k] = float(v)
            except (AttributeError, ValueError):
                raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'),
                                                          'Failed to convert {0} to a dictionary of string:int values'.format(value))
 

Member Data Documentation

◆ _kvsplitter

python.trfArgClasses.argKeyFloatValueList._kvsplitter = kvsplitter

protected

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

◆ _splitter

python.trfArgClasses.argList._splitter = splitter

protectedinherited

Definition at line 357 of file trfArgClasses.py.

◆ _supressEmptyStrings

python.trfArgClasses.argList._supressEmptyStrings = supressEmptyStrings

protectedinherited

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

Public Types

Public Member Functions

Protected Attributes

Detailed Description

Member Typedef Documentation

◆ result

Constructor & Destructor Documentation

◆ __init__()

Member Function Documentation

◆ __eq__()

◆ __gt__()

◆ __lt__()

◆ __nq__()

◆ __repr__()

◆ __str__()

◆ append()

◆ isRunarg()

◆ name() [1/2]

◆ name() [2/2]

◆ prodsysDescription()

◆ value() [1/2]

◆ value() [2/2]

Member Data Documentation

◆ _kvsplitter

◆ _name

◆ _runarg

◆ _splitter

◆ _supressEmptyStrings

◆ _value

◆ init()

◆ eq()

◆ gt()

◆ lt()

◆ nq()

◆ repr()

◆ str()