EnvConfig.Variable.Scalar Class Reference

Inheritance diagram for EnvConfig.Variable.Scalar:

Collaboration diagram for EnvConfig.Variable.Scalar:

Public Member Functions
def	__init__
def	name (self)
def	set
def	unset
def	value
def	remove_regexp
def	remove
def	append
def	prepend
def	search (self, expr)
def	__str__ (self)
Public Member Functions inherited from EnvConfig.Variable.VariableBase
def	__init__
def	process (self, value, env)

Public Attributes
	val
Public Attributes inherited from EnvConfig.Variable.VariableBase
	varName
	local
	expandVars
	log

Detailed Description

Class for manipulating with environment scalars.

Definition at line 295 of file Variable.py.

Constructor & Destructor Documentation

def EnvConfig.Variable.Scalar.__init__	(		self,
			name,
			local = False
	)

Definition at line 298 of file Variable.py.

    def __init__(self, name, local=False):
        super(Scalar, self).__init__(name, local)
        self.val = ''

Member Function Documentation

def EnvConfig.Variable.Scalar.__str__

(

self

)

Definition at line 339 of file Variable.py.

    def __str__(self):
        return self.val

def EnvConfig.Variable.Scalar.append	(		self,
			value,
			separator = ':',
			environment = None
	)

Adds value(s) at the end of the scalar.

Definition at line 327 of file Variable.py.

    def append(self, value, separator=':', environment=None):# pylint: disable=W0613
        '''Adds value(s) at the end of the scalar.'''
        self.val += self.process(value, environment)

def EnvConfig.Variable.Scalar.name

(

self

)

Returns the name of the scalar.

Definition at line 302 of file Variable.py.

    def name(self):
        '''Returns the name of the scalar.'''
        return self.varName

def EnvConfig.Variable.Scalar.prepend	(		self,
			value,
			separator = ':',
			environment = None
	)

Adds value(s) at the beginning of the scalar.

Definition at line 331 of file Variable.py.

    def prepend(self, value, separator=':', environment=None):# pylint: disable=W0613
        '''Adds value(s) at the beginning of the scalar.'''
        self.val = self.process(value, environment) + self.val

def EnvConfig.Variable.Scalar.remove	(		self,
			value,
			separator = ':',
			regexp = True
	)

Removes value(s) from the scalar. If value is not found, removal is canceled.

Definition at line 321 of file Variable.py.

    def remove(self, value, separator=':', regexp=True):# pylint: disable=W0613
        '''Removes value(s) from the scalar. If value is not found, removal is canceled.'''
        value = self.search(value)
        for val in value:
            self.val = self.val.replace(val, '')

def EnvConfig.Variable.Scalar.remove_regexp	(		self,
			value,
			separator = ':'
	)

Definition at line 318 of file Variable.py.

    def remove_regexp(self, value, separator=':'):
        self.remove(value, separator, True)

def EnvConfig.Variable.Scalar.search	(		self,
			expr
	)

Searches in scalar`s values for a match

Definition at line 335 of file Variable.py.

    def search(self, expr):
        '''Searches in scalar`s values for a match'''
        return re.findall(expr, self.val)

def EnvConfig.Variable.Scalar.set	(		self,
			value,
			separator = ':',
			environment = None
	)

Sets the value of the scalar. Any previous value is overwritten.

Definition at line 306 of file Variable.py.

    def set(self, value, separator=':', environment=None):# pylint: disable=W0613
        '''Sets the value of the scalar. Any previous value is overwritten.'''
        self.val = self.process(value, environment)

def EnvConfig.Variable.Scalar.unset	(		self,
			value,
			separator = ':',
			environment = None
	)

Sets the value of the variable to empty. Any previous value is overwritten.

Definition at line 310 of file Variable.py.

    def unset(self, value, separator=':', environment=None):# pylint: disable=W0613
        '''Sets the value of the variable to empty. Any previous value is overwritten.'''
        self.val = ''

def EnvConfig.Variable.Scalar.value	(		self,
			asString = False,
			separator = ':'
	)

Returns values of the scalar.

Definition at line 314 of file Variable.py.

    def value(self, asString=False, separator=':'):# pylint: disable=W0613
        '''Returns values of the scalar.'''
        return self.val

Member Data Documentation

EnvConfig.Variable.Scalar.val

Definition at line 300 of file Variable.py.

---

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

• InstallArea/x86_64-slc6-gcc49-opt/scripts/EnvConfig/Variable.py