GaudiTest::TemporaryEnvironment Class Reference

Utility Classes. More...

List of all members.

Public Member Functions
def	__init__
def	__setitem__
def	__getitem__
def	__delitem__
def	keys
def	items
def	__contains__
def	restore
def	__del__
def	gen_script
Public Attributes
	old_values
	env
Private Attributes
	_keep_same

---

Detailed Description

Utility Classes.

Class to changes the environment temporarily.

Definition at line 46 of file GaudiTest.py.

---

Constructor & Destructor Documentation

def GaudiTest::TemporaryEnvironment::__init__	(		self,
			orig = os.environ,
			keep_same = False
	)

Create a temporary environment on top of the one specified
(it can be another TemporaryEnvironment instance).

Definition at line 50 of file GaudiTest.py.

                                                            :
        """
        Create a temporary environment on top of the one specified
        (it can be another TemporaryEnvironment instance).
        """
        #print "New environment"
        self.old_values = {}
        self.env = orig
        self._keep_same = keep_same

def GaudiTest::TemporaryEnvironment::__del__

(

self )

Revert the changes on destruction.

Definition at line 121 of file GaudiTest.py.

                     :
        """
        Revert the changes on destruction.
        """
        #print "Restoring the environment"
        self.restore()

---

Member Function Documentation

def GaudiTest::TemporaryEnvironment::__contains__	(		self,
			key
	)

Operator 'in'.
Needed to provide the same interface as os.environ.

Definition at line 103 of file GaudiTest.py.

                              :
        """
        Operator 'in'.
        Needed to provide the same interface as os.environ.
        """
        return key in self.env

def GaudiTest::TemporaryEnvironment::__delitem__	(		self,
			key
	)

Unset an environment variable.
Needed to provide the same interface as os.environ.

Definition at line 79 of file GaudiTest.py.

                             :
        """
        Unset an environment variable.
        Needed to provide the same interface as os.environ.
        """
        if key not in self.env :
            raise KeyError(key)
        self.old_values[key] = self.env[key]
        del self.env[key]

def GaudiTest::TemporaryEnvironment::__getitem__	(		self,
			key
	)

Get an environment variable.
Needed to provide the same interface as os.environ.

Definition at line 72 of file GaudiTest.py.

                             :
        """
        Get an environment variable.
        Needed to provide the same interface as os.environ.
        """
        return self.env[key]

def GaudiTest::TemporaryEnvironment::__setitem__	(		self,
			key,
			value
	)

Set an environment variable recording the previous value.

Definition at line 60 of file GaudiTest.py.

                                   :
        """
        Set an environment variable recording the previous value.
        """
        if key not in self.old_values :
            if key in self.env :
                if not self._keep_same or self.env[key] != value:
                    self.old_values[key] = self.env[key]
            else:
                self.old_values[key] = None
        self.env[key] = value

def GaudiTest::TemporaryEnvironment::gen_script	(		self,
			shell_type
	)

Generate a shell script to reproduce the changes in the environment.

Definition at line 128 of file GaudiTest.py.

                                   :
        """
        Generate a shell script to reproduce the changes in the environment.
        """
        shells = [ 'csh', 'sh', 'bat' ]
        if shell_type not in shells:
            raise RuntimeError("Shell type '%s' unknown. Available: %s"%(shell_type,shells))
        out = ""
        for key,value in self.old_values.items():
            if key not in self.env:
                # unset variable
                if shell_type == 'csh':
                    out += 'unsetenv %s\n'%key
                elif shell_type == 'sh':
                    out += 'unset %s\n'%key
                elif shell_type == 'bat':
                    out += 'set %s=\n'%key
            else:
                # set variable
                if shell_type == 'csh':
                    out += 'setenv %s "%s"\n'%(key,self.env[key])
                elif shell_type == 'sh':
                    out += 'export %s="%s"\n'%(key,self.env[key])
                elif shell_type == 'bat':
                    out += 'set %s=%s\n'%(key,self.env[key])
        return out

def GaudiTest::TemporaryEnvironment::items

(

self )

Return the list of (name,value) pairs for the defined environment variables.
Needed to provide the same interface as os.environ.

Definition at line 96 of file GaudiTest.py.

                   :
        """
        Return the list of (name,value) pairs for the defined environment variables.
        Needed to provide the same interface as os.environ.
        """
        return self.env.items()

def GaudiTest::TemporaryEnvironment::keys

(

self )

Return the list of defined environment variables.
Needed to provide the same interface as os.environ.

Definition at line 89 of file GaudiTest.py.

                  :
        """
        Return the list of defined environment variables.
        Needed to provide the same interface as os.environ.
        """
        return self.env.keys()

def GaudiTest::TemporaryEnvironment::restore

(

self )

Revert all the changes done to the orignal environment.

Definition at line 110 of file GaudiTest.py.

                     :
        """
        Revert all the changes done to the orignal environment.
        """
        for key,value in self.old_values.items():
            if value is None:
                del self.env[key]
            else:
                self.env[key] = value
        self.old_values = {}

---

Member Data Documentation

GaudiTest::TemporaryEnvironment::_keep_same [private]

Definition at line 53 of file GaudiTest.py.

GaudiTest::TemporaryEnvironment::env

Definition at line 53 of file GaudiTest.py.

GaudiTest::TemporaryEnvironment::old_values

Definition at line 53 of file GaudiTest.py.

---

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

• /afs/cern.ch/sw/Gaudi/releases/GAUDI/GAUDI_v23r0/GaudiPolicy/qmtest_classes/GaudiTest.py