temporary 1.1.0

Context managers for managing temporary files and directories.

Context managers for managing temporary files and directories.

with temporary.temp_dir() as d:
    ...

with temporary.temp_file(content='hello') as f:
    ...

Installation:

$ pip install temporary

Temporary Directory Examples

The temporary directory is created when entering the context manager, and deleted when exiting it:

>>> import os.path
>>> import temporary
>>> with temporary.temp_dir() as d:
...     assert os.path.isdir(d)
>>> assert not os.path.exists(d)

This time let’s make the temporary directory our working directory:

>>> import os
>>> with temporary.temp_dir(make_cwd=True) as d:
...     assert d == os.getcwd()
>>> assert d != os.getcwd()

The suffix, prefix, and parent_dir options are passed to the standard tempfile.mkdtemp() function:

>>> with temporary.temp_dir() as p:
...     with temporary.temp_dir(suffix='suf', prefix='pre', parent_dir=p) as d:
...         assert os.path.dirname(d) == p
...         assert os.path.basename(d).startswith('pre')
...         assert os.path.basename(d).endswith('suf')

This function can also be used as a decorator, with the in_temp_dir alias:

>>> @temporary.in_temp_dir()
... def my_function():
...     assert old_cwd != os.getcwd()
...
>>> old_cwd = os.getcwd()
>>> my_function()
>>> assert old_cwd == os.getcwd()

Temporary Files Examples

The temporary file is created when entering the context manager and deleted when exiting it.

>>> import os.path
>>> import temporary
>>> with temporary.temp_file() as f_name:
...     assert os.path.isfile(f_name)
>>> assert not os.path.exists(f_name)

The user may also supply some content for the file to be populated with:

>>> with temporary.temp_file('hello!') as f_name:
...     with open(f_name) as f:
...         assert f.read() == 'hello!'

The temporary file can be placed in a custom directory:

>>> with temporary.temp_dir() as d_name:
...     with temporary.temp_file(parent_dir=d_name) as f_name:
...         assert os.path.dirname(f_name) == d_name

If, for some reason, the user wants to delete the temporary file before exiting the context, that’s okay too:

>>> import os
>>> with temporary.temp_file() as f_name:
...     os.remove(f_name)