python.trfArgClasses.argString Class Reference

String type argument. More...

Inheritance diagram for python.trfArgClasses.argString:

Collaboration diagram for python.trfArgClasses.argString:

Public Member Functions
def	__init__ (self, value=None, runarg=True, name=None, choices=None)
	Class initialisation. More...
def	value (self)
	Argument value getter. More...
def	value (self, value)
	Argument value setter. More...
def	choices (self)
	Choices getter. More...
def	prodsysDescription (self)
def	__str__ (self)
def	isRunarg (self)
	Return runarg status. More...
def	name (self)
	Name getter. More...
def	name (self, value)
	Name setter. 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 Attributes
	_choices
	_value
	_runarg
	_name

Detailed Description

String type argument.

Definition at line 174 of file trfArgClasses.py.

Constructor & Destructor Documentation

__init__()

def python.trfArgClasses.argString.__init__	(		self,
			value = None,
			runarg = True,
			name = None,
			choices = None
	)

Class initialisation.

Parameters

value	Initial value to be set
runarg	Boolean specifiying if this is a run time argument (specifically passed to athena by the AthenaExecutor, other executors may do the same).
name	Name for this argument
choices	Optional list of strings from which value must be set

Definition at line 182 of file trfArgClasses.py.

    def __init__(self, value = None, runarg = True, name = None, choices = None):
        self._choices = choices
        super(argString, 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.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.argString.__str__

(

self

)

Note

String value can be printed directly

Reimplemented from python.trfArgClasses.argument.

Definition at line 220 of file trfArgClasses.py.

    def __str__(self):
        return self.value
 
 

choices()

def python.trfArgClasses.argString.choices

(

self

)

Choices getter.

Returns

Valid choices list

Definition at line 208 of file trfArgClasses.py.

    def choices(self):
        return self._choices
 

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

(

self

)

Reimplemented from python.trfArgClasses.argument.

Definition at line 213 of file trfArgClasses.py.

    def prodsysDescription(self):
        desc = {'type' : 'str'}
        if self._choices:
            desc['choices'] = self._choices
        return desc
    

value() [1/2]

def python.trfArgClasses.argString.value

(

self

)

Argument value getter.

Returns

Current value

Reimplemented from python.trfArgClasses.argument.

Definition at line 189 of file trfArgClasses.py.

    def value(self):
        return self._value
 

value() [2/2]

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

Argument value setter.

Sets value directly if it's a str, otherwise call the str() converter

Reimplemented from python.trfArgClasses.argument.

Definition at line 195 of file trfArgClasses.py.

    def value(self, value):
        if value is None:
            # For strings, None maps to ''
            self._value = ''
        else:
            # Call string converter - should work for everything...
            self._value = str(value)
        if self._choices:
            if self._value not in self._choices:
                raise trfExceptions.TransformArgException(trfExit.nameToCode('TRF_ARG_CHOICES_FAIL'), 'Converted argument {0} for {1} did not match any valid choice: {2}'.format(value, self._name, self._choices))
 

Member Data Documentation

_choices

python.trfArgClasses.argString._choices

private

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

_value

python.trfArgClasses.argString._value

private

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