All Classes Namespaces Files Functions Variables Typedefs Enumerations Enumerator Properties Friends Macros Groups Pages
validate_patch.TempDir Class Reference
Inheritance diagram for validate_patch.TempDir:
Collaboration diagram for validate_patch.TempDir:

Public Member Functions

def __init__
 
def getName
 
def __str__
 
def __del__
 

Private Attributes

 _keep_var
 
 _name
 

Detailed Description

Class to create a temporary directory.

Definition at line 111 of file validate_patch.py.

Constructor & Destructor Documentation

def validate_patch.TempDir.__init__ (   self,
  suffix = "",
  prefix = "tmp",
  dir = None,
  keep_var = "KEEPTEMPDIR" 
)
Constructor.

'keep_var' is used to define which environment variable will prevent the
deletion of the directory.

The other arguments are the same as tempfile.mkdtemp.

Definition at line 113 of file validate_patch.py.

114  def __init__(self, suffix="", prefix="tmp", dir=None, keep_var="KEEPTEMPDIR"):
115  """Constructor.
116 
117  'keep_var' is used to define which environment variable will prevent the
118  deletion of the directory.
119 
120  The other arguments are the same as tempfile.mkdtemp.
121  """
122  self._keep_var = keep_var
123  self._name = mkdtemp(suffix, prefix, dir)
def validate_patch.TempDir.__del__ (   self)
Destructor.

Remove the temporary directory.

Definition at line 132 of file validate_patch.py.

133  def __del__(self):
134  """Destructor.
135 
136  Remove the temporary directory.
137  """
138  if self._name:
139  if self._keep_var in os.environ:
140  logging.info("%s set: I do not remove the temporary directory '%s'",
141  self._keep_var, self._name)
142  return
143  rmtree(self._name)

Member Function Documentation

def validate_patch.TempDir.__str__ (   self)
Convert to string.

Definition at line 128 of file validate_patch.py.

129  def __str__(self):
130  """Convert to string."""
131  return self.getName()
def validate_patch.TempDir.getName (   self)
Returns the name of the temporary directory

Definition at line 124 of file validate_patch.py.

125  def getName(self):
126  """Returns the name of the temporary directory"""
127  return self._name

Member Data Documentation

validate_patch.TempDir._keep_var
private

Definition at line 121 of file validate_patch.py.

validate_patch.TempDir._name
private

Definition at line 122 of file validate_patch.py.


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