jaraco.context

6.1.2 · active · verified Sat Mar 28

jaraco.context is a Python library providing useful decorators and context managers for common programming patterns. It offers tools like `ExceptionTrap` for exception handling, `pushd` for temporary directory changes, `tarball` for extracting archives, and `temp_dir` for managing temporary file system resources. The current version is 6.1.2, and it maintains an active release schedule with several updates in the past year.

Warnings

deprecated The `null` context manager, which provides a no-op context, has been deprecated. While still available, users should consider refactoring to avoid its use or using `contextlib.nullcontext` for newer Python versions (3.7+) as an alternative if truly needed for symmetry.
Fix: Migrate to `contextlib.nullcontext` (Python 3.7+) or refactor code to remove the need for a no-op context.
gotcha When using the `tarball` context manager, a conditional dependency on `backports.tarfile` exists for Python versions prior to 3.12. If you target Python 3.10 or 3.11 and use `tarball`, ensure `backports-tarfile` is installed.
Fix: For Python 3.10-3.11, explicitly install `pip install backports-tarfile`. For Python 3.12+, it's part of the standard library.
gotcha Older versions of `jaraco.context` (prior to unspecified fixes) had a vulnerability related to handling certain archive file paths in `tarball`, which could lead to directory traversal and overwriting files outside the intended extraction directory.
Fix: Always use the latest stable version of `jaraco.context` to ensure security patches are applied. As of 6.1.2, this issue should be addressed.

Install

pip install jaraco-context Install stable version

Imports

ExceptionTrap

from jaraco.context import ExceptionTrap

pushd
```
from jaraco.context import pushd
```
temp_dir
```
from jaraco.context import temp_dir
```
tarball
```
from jaraco.context import tarball
```
on_interrupt
```
from jaraco.context import on_interrupt
```
suppress
```
from jaraco.context import suppress
```
A decorator version of contextlib.suppress.
null
```
from jaraco.context import null
```
While directly importable, it's generally preferred to import specific symbols. The `null` context manager is also deprecated.

Quickstart

This quickstart demonstrates the `temp_dir` context manager to create and automatically clean up a temporary directory, and the `pushd` context manager to temporarily change and restore the current working directory.

import os
from jaraco.context import temp_dir, pushd

with temp_dir() as tmp_dir_path:
    print(f"Temporary directory created at: {tmp_dir_path}")
    assert os.path.isdir(tmp_dir_path)

    # The temporary directory is automatically removed here
    assert not os.path.exists(tmp_dir_path)

# Example with pushd
current_cwd = os.getcwd()
with temp_dir() as tmp_path_for_pushd:
    with pushd(tmp_path_for_pushd):
        print(f"Current working directory changed to: {os.getcwd()}")
        assert os.getcwd() == os.fspath(tmp_path_for_pushd)
    print(f"Current working directory restored to: {os.getcwd()}")
    assert os.getcwd() == current_cwd

view raw JSON →