EnvConfig.Variable.List Class Reference

Inheritance diagram for EnvConfig.Variable.List:

Collaboration diagram for EnvConfig.Variable.List:

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, regExp)
def	__getitem__ (self, key)
def	__setitem__ (self, key, value)
def	__delitem__ (self, key)
def	__iter__ (self)
def	__contains__ (self, item)
def	__len__ (self)
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 lists.

It holds its name and values represented by a list.
Some operations are done with separator, which is usually colon. For windows use semicolon.

Definition at line 187 of file Variable.py.

Constructor & Destructor Documentation

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

Definition at line 195 of file Variable.py.

    def __init__(self, name, local=False):
        super(List, self).__init__(name, local)
        self.val = []

Member Function Documentation

def EnvConfig.Variable.List.__contains__	(		self,
			item
	)

Definition at line 285 of file Variable.py.

    def __contains__(self, item):
        return item in self.val

def EnvConfig.Variable.List.__delitem__	(		self,
			key
	)

Definition at line 278 of file Variable.py.

    def __delitem__(self, key):
        self.remove(self.val[key])

def EnvConfig.Variable.List.__getitem__	(		self,
			key
	)

Definition at line 269 of file Variable.py.

    def __getitem__(self, key):
        return self.val[key]

def EnvConfig.Variable.List.__iter__

(

self

)

Definition at line 281 of file Variable.py.

    def __iter__(self):
        for i in self.val:
            yield i

def EnvConfig.Variable.List.__len__

(

self

)

Definition at line 288 of file Variable.py.

    def __len__(self):
        return len(self.val)

def EnvConfig.Variable.List.__setitem__	(		self,
			key,
			value
	)

Definition at line 272 of file Variable.py.

    def __setitem__(self, key, value):
        if value in self.val:
            self.log.info('Var: "%s" value: "%s". Addition canceled because of duplicate entry.', self.varName, value)
        else:
            self.val.insert(key, value)

def EnvConfig.Variable.List.__str__

(

self

)

Definition at line 291 of file Variable.py.

    def __str__(self):
        return ':'.join(self.val)

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

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

Definition at line 240 of file Variable.py.

    def append(self, value, separator=':', environment=None):
        '''Adds value(s) at the end of the list.'''
        if isinstance(value, str):
            value = value.split(separator)
        self.val = self.process(self.val + value, environment)

def EnvConfig.Variable.List.name

(

self

)

Returns the name of the List.

Definition at line 199 of file Variable.py.

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

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

Adds value(s) at the beginning of the list.
resolve references and duplications

Definition at line 246 of file Variable.py.

    def prepend(self, value, separator=':', environment=None):
        '''Adds value(s) at the beginning of the list.
        resolve references and duplications'''
        if isinstance(value, str):
            value = value.split(separator)
        self.val = self.process(value + self.val, environment)

def EnvConfig.Variable.List.remove	(		self,
			value,
			separator = ':',
			regexp = False
	)

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

Definition at line 224 of file Variable.py.

    def remove(self, value, separator=':', regexp=False):
        '''Removes value(s) from List. If value is not found, removal is canceled.'''
        if regexp:
            value = self.search(value, True)

        elif isinstance(value,str):
            value = value.split(separator)

        for i in range(len(value)):
            val = value[i]
            if val not in value:
                self.log.info('Value "%s" not found in List: "%s". Removal canceled.', val, self.varName)
            while val in self.val:
                self.val.remove(val)

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

Definition at line 221 of file Variable.py.

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

def EnvConfig.Variable.List.search	(		self,
			expr,
			regExp
	)

Searches in List's values for a match

Use string value or set regExp to True.
In the first case search is done only for an exact match for one of List`s value ('^' and '$' added).

Definition at line 253 of file Variable.py.

    def search(self, expr, regExp):
        '''Searches in List's values for a match

        Use string value or set regExp to True.
        In the first case search is done only for an exact match for one of List`s value ('^' and '$' added).
        '''
        if not regExp:
            expr = '^' + expr + '$'
        v = re.compile(expr)
        res = []
        for val in self.val:
            if v.search(val):
                res.append(val)

        return res

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

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

Definition at line 203 of file Variable.py.

    def set(self, value, separator=':', environment=None):
        '''Sets the value of the List. Any previous value is overwritten.'''
        if isinstance(value, str):
            value = value.split(separator)
        self.val = self.process(value, environment)

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

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

Definition at line 209 of file Variable.py.

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

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

Returns values of the List. Either as a list or string with desired separator.

Definition at line 213 of file Variable.py.

    def value(self, asString=False, separator=':'):
        '''Returns values of the List. Either as a list or string with desired separator.'''
        if asString:
            return separator.join(self.val)
        else:
            # clone the list
            return list(self.val)

Member Data Documentation

EnvConfig.Variable.List.val

Definition at line 197 of file Variable.py.

---

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

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