EnvConfig.Control.Environment Class Reference

Public Member Functions
def	__init__
def	vars
def	var
def	search
def	declare
def	append
def	prepend
def	set
def	default
def	unset
def	remove
def	remove_regexp
def	searchFile
def	loadXML
def	startXMLinput
def	finishXMLinput
def	writeToFile
def	writeToXMLFile
def	presetFromSystem
def	process
def	__getitem__
def	__setitem__
def	__delitem__
def	__iter__
def	__contains__
def	__len__

Public Attributes
	report
	separator
	searchPath
	actions
	variables
	loadFromSystem
	asWriter
	writer
	loadedFiles

Private Member Functions
def	_locate
def	_guessType
def	_concatenate
def	_writeVarToXML

Private Attributes
	_fileDirStack

Detailed Description

object to hold settings of environment

Definition at line 11 of file Control.py.

Constructor & Destructor Documentation

def EnvConfig.Control.Environment.__init__	(		self,
			loadFromSystem = True,
			useAsWriter = False,
			reportLevel = 1,
			searchPath = None
	)

Initial variables to be pushed and setup

append switch between append and prepend for initial variables.
loadFromSystem causes variable`s system value to be loaded on first encounter.
If useAsWriter == True than every change to variables is recorded to XML file.
reportLevel sets the level of messaging.

Definition at line 14 of file Control.py.

    def __init__(self, loadFromSystem=True, useAsWriter=False, reportLevel=1, searchPath=None):
        '''Initial variables to be pushed and setup

        append switch between append and prepend for initial variables.
        loadFromSystem causes variable`s system value to be loaded on first encounter.
        If useAsWriter == True than every change to variables is recorded to XML file.
        reportLevel sets the level of messaging.
        '''
        self.report = xmlModule.Report(reportLevel)

        self.separator = ':'

        # Prepeare the internal search path for xml files (used by 'include' elements)
        self.searchPath = ['.']
        if searchPath is not None:
            self.searchPath.extend(searchPath)
        try:
            self.searchPath.extend(os.environ['ENVXMLPATH'].split(os.pathsep))
        except KeyError:
            # ignore if the env variable is not there
            pass

        self.actions = {}
        self.actions['include'] = lambda n, c, h: self.loadXML(self._locate(n, c, h))
        self.actions['append'] = lambda n, v, _: self.append(n, v)
        self.actions['prepend'] = lambda n, v, _: self.prepend(n, v)
        self.actions['set'] = lambda n, v, _: self.set(n, v)
        self.actions['unset'] = lambda n, v, _: self.unset(n, v)
        self.actions['default'] = lambda n, v, _: self.default(n, v)
        self.actions['remove'] = lambda n, v, _: self.remove(n, v)
        self.actions['remove-regexp'] = lambda n, v, _: self.remove_regexp(n, v)
        self.actions['declare'] = self.declare

        self.variables = {}

        self.loadFromSystem = loadFromSystem
        self.asWriter = useAsWriter
        if useAsWriter:
            self.writer = xmlModule.XMLFile()
            self.startXMLinput()

        self.loadedFiles = set()

        # Prepare the stack for the directory of the loaded file(s)
        self._fileDirStack = []
        # Note: cannot use self.declare() because we do not want to write out
        #       the changes to ${.}
        dot = Variable.Scalar('.', local=True, report=self.report)
        dot.expandVars = False
        dot.set('')
        self.variables['.'] = dot