python.trfEnv.pathVar Class Reference

Helper class for environment variables using colon separated paths. More...

Inheritance diagram for python.trfEnv.pathVar:

Collaboration diagram for python.trfEnv.pathVar:

Public Member Functions
def	__init__ (self, varname, separator=":", testForExistance=True)
def	add (self, value, prepend=True)
	Add a new element to the variable. More...
def	__str__ (self)
	Return the correct string representing the value for the shell. More...

Private Attributes
	_name
	_separator
	_testExistance
	_value

Static Private Attributes
	_currentEnvironmentValue

Detailed Description

Helper class for environment variables using colon separated paths.

Definition at line 105 of file trfEnv.py.

Constructor & Destructor Documentation

__init__()

def python.trfEnv.pathVar.__init__	(		self,
			varname,
			separator = ":",
			testForExistance = True
	)

Definition at line 108 of file trfEnv.py.

    def __init__(self, varname, separator=":", testForExistance=True):        self._name = varname
        self._separator = separator
        self._testExistance = testForExistance
        
        # Note the special value @c _currentEnvironmentValue that will be expanded to the current
        # setting in the environment (i.e., @c os.environ['self._name']), if it exists
        self._value = [self._currentEnvironmentValue]
        
 

Member Function Documentation

__str__()

def python.trfEnv.pathVar.__str__

(

self

)

Return the correct string representing the value for the shell.

Definition at line 136 of file trfEnv.py.

    def __str__(self):
        valStr = ""
        for v in self._value:
            if v == self._currentEnvironmentValue:
                if self._name in os.environ:
                    valStr += "$" + self._name + self._separator
            else:
                valStr += v + self._separator
        valStr = valStr[:-1]
        return valStr

add()

def python.trfEnv.pathVar.add	(		self,
			value,
			prepend = True
	)

Add a new element to the variable.

Definition at line 118 of file trfEnv.py.

    def add(self, value, prepend=True):
        msg.debug('Adding new value "{0}" to envvar {1} (currently {2}'.format(value, self._name, self._value))
        if value in self._value:
            msg.warning('Attempt to add environment element {0} twice to {1}'.format(value, self._name))
        if self._testExistance:
            # expand environment variables (will only check current release, but this is the most common anyways)
            test_value = value
            if '$' in test_value:
                test_value = os.path.join(os.environ[os.path.dirname(value)[1:]], os.path.basename(value))
            if not os.access(test_value, os.R_OK):
                msg.warning("Path to {0} is not readable - will not add it to {1}".format(value, self._name))
                return
        if prepend:
            self._value[0:0] = [value]
        else:
            self._value.append(value)
 

Member Data Documentation

_currentEnvironmentValue

python.trfEnv.pathVar._currentEnvironmentValue

staticprivate

Definition at line 106 of file trfEnv.py.

_name

python.trfEnv.pathVar._name

private

Definition at line 109 of file trfEnv.py.

_separator

python.trfEnv.pathVar._separator

private

Definition at line 110 of file trfEnv.py.

_testExistance

python.trfEnv.pathVar._testExistance

private

Definition at line 111 of file trfEnv.py.

_value

python.trfEnv.pathVar._value

private

Definition at line 115 of file trfEnv.py.

---

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

• trfEnv.py