"""
Autotest tempfile wrapper for mkstemp (known as tempfile here) and
mkdtemp (known as tempdir).
This wrapper provides a mechanism to clean up temporary files/dirs once they
are no longer need.
Files/Dirs will have a unique_id prepended to the suffix and a
_autotmp_ tag appended to the prefix.
It is required that the unique_id param is supplied when a temp dir/file is
created.
"""
import logging
import os
import tempfile as module_tempfile
from autotest.client import utils
_TEMPLATE = '_autotmp_'
[docs]class tempfile(object):
"""
A wrapper for tempfile.mkstemp
:param unique_id: required, a unique string to help identify what
part of code created the tempfile.
@var name: The name of the temporary file.
@var fd: the file descriptor of the temporary file that was created.
:return: a tempfile object
example usage:
t = autotemp.tempfile(unique_id='fig')
t.name # name of file
t.fd # file descriptor
t.fo # file object
t.clean() # clean up after yourself
"""
def __init__(self, unique_id, suffix='', prefix='', dir=None,
text=False):
suffix = unique_id + suffix
prefix = prefix + _TEMPLATE
self.fd, self.name = module_tempfile.mkstemp(suffix=suffix,
prefix=prefix,
dir=dir, text=text)
self.fo = os.fdopen(self.fd)
[docs] def clean(self):
"""
Remove the temporary file that was created.
This is also called by the destructor.
"""
if self.fo:
self.fo.close()
if self.name and os.path.exists(self.name):
os.remove(self.name)
self.fd = self.fo = self.name = None
def __del__(self):
try:
if self.name is not None:
logging.debug('Clean was not called for ' + self.name)
self.clean()
except Exception:
try:
msg = 'An exception occurred while calling the destructor'
logging.exception(msg)
except Exception:
pass
[docs]class tempdir(object):
"""
A wrapper for tempfile.mkdtemp
@var name: The name of the temporary dir.
:return: A tempdir object
example usage:
b = autotemp.tempdir(unique_id='exemdir')
b.name # your directory
b.clean() # clean up after yourself
"""
def __init__(self, suffix='', unique_id=None, prefix='', dir=None):
suffix = unique_id + suffix
prefix = prefix + _TEMPLATE
self.name = module_tempfile.mkdtemp(suffix=suffix,
prefix=prefix, dir=dir)
[docs] def clean(self):
"""
Remove the temporary dir that was created.
This is also called by the destructor.
"""
if self.name and os.path.exists(self.name):
utils.safe_rmdir(self.name)
self.name = None
def __del__(self):
try:
if self.name:
logging.debug('Clean was not called for ' + self.name)
self.clean()
except Exception:
try:
msg = 'An exception occurred while calling the destructor'
logging.exception(msg)
except Exception:
pass