python.trfArgClasses.argList Class Reference

List of string arguments. More...

Inheritance diagram for python.trfArgClasses.argList:

Collaboration diagram for python.trfArgClasses.argList:

Public Member Functions
def	__init__ (self, value=[], supressEmptyStrings=True, splitter=',', runarg=True, name=None)
	List of string arguments. More...
def	value (self)
	Argument value getter. More...
def	prodsysDescription (self)
def	value (self, value)
	Argument value setter. More...
def	append (self, addme)
	Append a value to the list. More...
def	__str__ (self)
	String conversion. More...
def	__repr__ (self)
	Repr conversion. More...
def	isRunarg (self)
	Return runarg status. More...
def	name (self)
	Name getter. More...
def	name (self, value)
	Name setter. 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 Attributes
	_splitter
	_supressEmptyStrings
	_value
	_runarg
	_name

Detailed Description

List of string arguments.

Definition at line 348 of file trfArgClasses.py.

Constructor & Destructor Documentation

__init__()

def python.trfArgClasses.argList.__init__	(		self,
			value = [],
			supressEmptyStrings = True,
			splitter = ',',
			runarg = True,
			name = None
	)

List of string arguments.

Argument holding a list of string values

Parameters

splitter	The splitter argument determines how the string is split (default by a comma)
value	Initial value to set (note default is an empty list [])
supressEmptyStrings	If empty strings are removed from the list (Can be used to easily set an empty list from the CLI)

Definition at line 356 of file trfArgClasses.py.

    def __init__(self, value = [], supressEmptyStrings = True, splitter=',', runarg=True, name=None):
        self._splitter = splitter
        self._supressEmptyStrings = supressEmptyStrings
 
        super(argList, self).__init__(value = value, runarg = runarg, name=name)
 

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.argList.__repr__

(

self

)

Repr conversion.

Return a python parsable string

Reimplemented from python.trfArgClasses.argument.

Definition at line 409 of file trfArgClasses.py.

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

__str__()

def python.trfArgClasses.argList.__str__

(

self

)

String conversion.

Flatten values and space separate

Warning

Values sets with spaces will be confused by this conversion

Reimplemented from python.trfArgClasses.argument.

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

Definition at line 404 of file trfArgClasses.py.

    def __str__(self):
        return " ".join(self._value)
    

append()

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

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

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

(

self

)

Reimplemented from python.trfArgClasses.argument.

Reimplemented in python.trfArgClasses.argFTKIPFile, python.trfArgClasses.argBZ2File, python.trfArgClasses.argNTUPFile, python.trfArgClasses.argHISTFile, python.trfArgClasses.argPOOLFile, python.trfArgClasses.argBSFile, python.trfArgClasses.argAthenaFile, python.trfArgClasses.argFile, python.trfArgClasses.argKeyFloatValueList, and python.trfArgClasses.argIntList.

Definition at line 370 of file trfArgClasses.py.

    def prodsysDescription(self):
        desc = {'type' : 'list', 'listtype': 'str'}
        if self._supressEmptyStrings:
            desc['supress Empty Strings'] = self._supressEmptyStrings
        return desc
 
 

value() [1/2]

def python.trfArgClasses.argList.value

(

self

)

Argument value getter.

Returns

Current value

Reimplemented from python.trfArgClasses.argument.

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

Definition at line 365 of file trfArgClasses.py.

    def value(self):
        return self._value
 

value() [2/2]

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

Argument value setter.

If we get a list then set that, otherwise we split a string on the splitter character

Reimplemented from python.trfArgClasses.argument.

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

Definition at line 380 of file trfArgClasses.py.

    def value(self, value):
        if isinstance(value, (list, tuple)):
            self._value = list(value)
        elif value is None:
            self._value = []
            return
        else:
            try:
                if self._supressEmptyStrings:
                    self._value = [ v for v in value.split(self._splitter) if v != '' ]
                else:
                    self._value = value.split(self._splitter)
            except AttributeError:
                raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CONV_FAIL'),
                                                          'Failed to convert %s to a list' % str(value))
 

Member Data Documentation

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

_splitter

python.trfArgClasses.argList._splitter

private

Definition at line 357 of file trfArgClasses.py.

_supressEmptyStrings

python.trfArgClasses.argList._supressEmptyStrings

private

Definition at line 358 of file trfArgClasses.py.

_value

python.trfArgClasses.argList._value

private

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