Utility Classes. More...

Public Member Functions
def	__init__

def	__setitem__ (self, key, value)

def	__getitem__ (self, key)

def	__delitem__ (self, key)

def	keys (self)

def	items (self)

def	__contains__ (self, key)

def	restore (self)

def	__del__ (self)

def	gen_script (self, shell_type)

def	__init__

def	__setitem__ (self, key, value)

def	__getitem__ (self, key)

def	__delitem__ (self, key)

def	keys (self)

def	items (self)

def	__contains__ (self, key)

def	restore (self)

def	__del__ (self)

def	gen_script (self, shell_type)

Public Attributes
	old_values

	env

Private Attributes
	_keep_same

Detailed Description

Utility Classes.

Class to changes the environment temporarily.

Definition at line 71 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 75 of file GaudiTest.py.

     def __init__(self, orig = os.environ, keep_same = False):
         """
         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 146 of file GaudiTest.py.

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

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 75 of file GaudiTest.py.

     def __init__(self, orig = os.environ, keep_same = False):
         """
         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 146 of file GaudiTest.py.

     def __del__(self):
         """
         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 128 of file GaudiTest.py.

     def __contains__(self,key):
         """
         Operator 'in'.
         Needed to provide the same interface as os.environ.
         """
         return key in self.env
 

def GaudiTest.TemporaryEnvironment.__contains__	(	self,
		key
	)

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

Definition at line 128 of file GaudiTest.py.

     def __contains__(self,key):
         """
         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 104 of file GaudiTest.py.

     def __delitem__(self,key):
         """
         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.__delitem__	(	self,
		key
	)

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

Definition at line 104 of file GaudiTest.py.

     def __delitem__(self,key):
         """
         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 97 of file GaudiTest.py.

     def __getitem__(self,key):
         """
         Get an environment variable.
         Needed to provide the same interface as os.environ.
         """
         return 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 97 of file GaudiTest.py.

     def __getitem__(self,key):
         """
         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 85 of file GaudiTest.py.

     def __setitem__(self,key,value):
         """
         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.__setitem__	(	self,
		key,
		value
	)

Set an environment variable recording the previous value.

Definition at line 85 of file GaudiTest.py.

     def __setitem__(self,key,value):
         """
         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 153 of file GaudiTest.py.

     def gen_script(self,shell_type):
         """
         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.gen_script	(	self,
		shell_type
	)

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

Definition at line 153 of file GaudiTest.py.

     def gen_script(self,shell_type):
         """
         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 121 of file GaudiTest.py.

     def items(self):
         """
         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.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 121 of file GaudiTest.py.

     def items(self):
         """
         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 114 of file GaudiTest.py.

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

def GaudiTest.TemporaryEnvironment.keys ( self )

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

Definition at line 114 of file GaudiTest.py.

     def keys(self):
         """
         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 original environment.

Definition at line 135 of file GaudiTest.py.

     def restore(self):
         """
         Revert all the changes done to the original 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 = {}
 

def GaudiTest.TemporaryEnvironment.restore ( self )

Revert all the changes done to the original environment.

Definition at line 135 of file GaudiTest.py.

     def restore(self):
         """
         Revert all the changes done to the original 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 83 of file GaudiTest.py.

GaudiTest.TemporaryEnvironment.env

Definition at line 82 of file GaudiTest.py.

GaudiTest.TemporaryEnvironment.old_values

Definition at line 81 of file GaudiTest.py.

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

InstallArea/x86_64-slc6-gcc49-opt/qmtest_classes/GaudiTest.py

Public Member Functions

Public Attributes

Private Attributes

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation

Member Data Documentation