Gaudi Framework, version v24r2
Home   Generated: Wed Dec 4 2013
 All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
Public Member Functions | Public Attributes | Private Attributes | List of all members
GaudiTest.TemporaryEnvironment Class Reference

Utility Classes. More...

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

53 
54  def __init__(self, orig = os.environ, keep_same = False):
55  """
56  Create a temporary environment on top of the one specified
57  (it can be another TemporaryEnvironment instance).
58  """
59  #print "New environment"
60  self.old_values = {}
61  self.env = orig
62  self._keep_same = keep_same
def GaudiTest.TemporaryEnvironment.__del__ (   self) 
Revert the changes on destruction.

Definition at line 124 of file GaudiTest.py.

124 
125  def __del__(self):
126  """
127  Revert the changes on destruction.
128  """
129  #print "Restoring the environment"
130  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 106 of file GaudiTest.py.

106 
107  def __contains__(self,key):
108  """
109  Operator 'in'.
110  Needed to provide the same interface as os.environ.
111  """
112  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 82 of file GaudiTest.py.

82 
83  def __delitem__(self,key):
84  """
85  Unset an environment variable.
86  Needed to provide the same interface as os.environ.
87  """
88  if key not in self.env :
89  raise KeyError(key)
90  self.old_values[key] = self.env[key]
91  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 75 of file GaudiTest.py.

75 
76  def __getitem__(self,key):
77  """
78  Get an environment variable.
79  Needed to provide the same interface as os.environ.
80  """
81  return self.env[key]
def GaudiTest.TemporaryEnvironment.__setitem__ (   self,
  key,
  value 
) 
Set an environment variable recording the previous value.

Definition at line 63 of file GaudiTest.py.

63 
64  def __setitem__(self,key,value):
65  """
66  Set an environment variable recording the previous value.
67  """
68  if key not in self.old_values :
69  if key in self.env :
70  if not self._keep_same or self.env[key] != value:
71  self.old_values[key] = self.env[key]
72  else:
73  self.old_values[key] = None
74  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 131 of file GaudiTest.py.

131 
132  def gen_script(self,shell_type):
133  """
134  Generate a shell script to reproduce the changes in the environment.
135  """
136  shells = [ 'csh', 'sh', 'bat' ]
137  if shell_type not in shells:
138  raise RuntimeError("Shell type '%s' unknown. Available: %s"%(shell_type,shells))
139  out = ""
140  for key,value in self.old_values.items():
141  if key not in self.env:
142  # unset variable
143  if shell_type == 'csh':
144  out += 'unsetenv %s\n'%key
145  elif shell_type == 'sh':
146  out += 'unset %s\n'%key
147  elif shell_type == 'bat':
148  out += 'set %s=\n'%key
149  else:
150  # set variable
151  if shell_type == 'csh':
152  out += 'setenv %s "%s"\n'%(key,self.env[key])
153  elif shell_type == 'sh':
154  out += 'export %s="%s"\n'%(key,self.env[key])
155  elif shell_type == 'bat':
156  out += 'set %s=%s\n'%(key,self.env[key])
157  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 99 of file GaudiTest.py.

99 
100  def items(self):
101  """
102  Return the list of (name,value) pairs for the defined environment variables.
103  Needed to provide the same interface as os.environ.
104  """
105  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 92 of file GaudiTest.py.

92 
93  def keys(self):
94  """
95  Return the list of defined environment variables.
96  Needed to provide the same interface as os.environ.
97  """
98  return self.env.keys()
def GaudiTest.TemporaryEnvironment.restore (   self) 
Revert all the changes done to the orignal environment.

Definition at line 113 of file GaudiTest.py.

113 
114  def restore(self):
115  """
116  Revert all the changes done to the orignal environment.
117  """
118  for key,value in self.old_values.items():
119  if value is None:
120  del self.env[key]
121  else:
122  self.env[key] = value
123  self.old_values = {}

Member Data Documentation

GaudiTest.TemporaryEnvironment._keep_same
private

Definition at line 61 of file GaudiTest.py.

GaudiTest.TemporaryEnvironment.env

Definition at line 60 of file GaudiTest.py.

GaudiTest.TemporaryEnvironment.old_values

Definition at line 59 of file GaudiTest.py.

The documentation for this class was generated from the following file:
Generated at Wed Dec 4 2013 14:33:23 for Gaudi Framework, version v24r2 by Doxygen version 1.8.2 written by Dimitri van Heesch, © 1997-2004