validate_patch.TempDir Class Reference

Inheritance diagram for validate_patch.TempDir:

Collaboration diagram for validate_patch.TempDir:

Public Member Functions
def	__init__
def	getName (self)
def	__str__ (self)
def	__del__ (self)

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.

    def __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.
        """
        self._keep_var = keep_var 
        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.

    def __del__(self):
        """Destructor.
        
        Remove the temporary directory.
        """
        if self._name:
            if self._keep_var in os.environ:
                logging.info("%s set: I do not remove the temporary directory '%s'",
                             self._keep_var, self._name)
                return
            rmtree(self._name)

Member Function Documentation

def validate_patch.TempDir.__str__

(

self

)

Convert to string.

Definition at line 128 of file validate_patch.py.

    def __str__(self):
        """Convert to string."""
        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.

    def getName(self):
        """Returns the name of the temporary directory"""
        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:

• GaudiRelease/cmt/validate_patch.py