EnvConfig.TestEnvOps.TemporaryDir Class Reference

Inheritance diagram for EnvConfig.TestEnvOps.TemporaryDir:

Collaboration diagram for EnvConfig.TestEnvOps.TemporaryDir:

Public Member Functions
def	__init__
def	join (self, args)
def	__str__ (self)
def	remove (self)
def	__enter__ (self)
def	__exit__ (self, exc_type, exc_val, exc_tb)

Public Attributes
	chdir
	keep
	path
	old_dir

Detailed Description

Helper class to create a temporary directory and manage its lifetime.

An instance of this class can be used inside the 'with' statement and
returns the path to the temporary directory.

Definition at line 69 of file TestEnvOps.py.

Constructor & Destructor Documentation

def EnvConfig.TestEnvOps.TemporaryDir.__init__	(		self,
			chdir = False,
			keep = False
	)

Constructor.

Definition at line 76 of file TestEnvOps.py.

    def __init__(self, chdir=False, keep=False):
        '''Constructor.'''
        self.chdir = chdir
        self.keep = keep
        self.path = mkdtemp()
        self.old_dir = None

Member Function Documentation

def EnvConfig.TestEnvOps.TemporaryDir.__enter__

(

self

)

Context Manager protocol 'enter' function.

Definition at line 98 of file TestEnvOps.py.

    def __enter__(self):
        '''
        Context Manager protocol 'enter' function.
        '''
        if self.chdir:
            self.old_dir = os.getcwd()
            os.chdir(self.path)
        return self.path

def EnvConfig.TestEnvOps.TemporaryDir.__exit__	(		self,
			exc_type,
			exc_val,
			exc_tb
	)

Context Manager protocol 'exit' function.
Remove the temporary directory and let the exceptions propagate.

Definition at line 106 of file TestEnvOps.py.

    def __exit__(self, exc_type, exc_val, exc_tb):
        '''
        Context Manager protocol 'exit' function.
        Remove the temporary directory and let the exceptions propagate.
        '''
        if self.old_dir:
            os.chdir(self.old_dir)
            self.old_dir = None
        if not self.keep:
            self.remove()
        else:
            print "WARNING: not removing temporary directory", self.path
        return False

def EnvConfig.TestEnvOps.TemporaryDir.__str__

(

self

)

String representation (path to the temporary directory).

Definition at line 87 of file TestEnvOps.py.

    def __str__(self):
        '''String representation (path to the temporary directory).'''
        return self.path

def EnvConfig.TestEnvOps.TemporaryDir.join	(		self,
			args
	)

Equivalent to os.path.join(self.path, *args).

Definition at line 82 of file TestEnvOps.py.

    def join(self, *args):
        '''
        Equivalent to os.path.join(self.path, *args).
        '''
        return os.path.join(self.path, *args)

def EnvConfig.TestEnvOps.TemporaryDir.remove

(

self

)

Remove the temporary directory.
After a call to this method, the object is not usable anymore.

Definition at line 90 of file TestEnvOps.py.

    def remove(self):
        '''
        Remove the temporary directory.
        After a call to this method, the object is not usable anymore.
        '''
        if self.path: # allow multiple calls to the remove method
            shutil.rmtree(self.path, ignore_errors=True)
            self.path = None

Member Data Documentation

EnvConfig.TestEnvOps.TemporaryDir.chdir

Definition at line 78 of file TestEnvOps.py.

EnvConfig.TestEnvOps.TemporaryDir.keep

Definition at line 79 of file TestEnvOps.py.

EnvConfig.TestEnvOps.TemporaryDir.old_dir

Definition at line 81 of file TestEnvOps.py.

EnvConfig.TestEnvOps.TemporaryDir.path

Definition at line 80 of file TestEnvOps.py.

---

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

• InstallArea/x86_64-slc6-gcc48-opt/scripts/EnvConfig/TestEnvOps.py