Traceback2

1.4.0 · maintenance · verified Sat Apr 11

Traceback2 is a Python library that provides a backport of the standard library's `traceback` module to older supported Python versions. Its primary goal was to offer modern traceback formatting and functionality to environments where the native `traceback` module lacked these features. The current version is 1.4.0, released in March 2015, indicating a very slow release cadence and minimal, if any, active development for new features or modern Python versions.

Warnings

gotcha Traceback2 is a backport primarily for older Python versions (e.g., Python 2.x). For modern Python 3.x installations, the built-in `traceback` module provides all equivalent functionality and should be used instead.
Fix: For Python 3.x, use `import traceback` directly. Only install and use `traceback2` if targeting specific older Python environments that lack the desired traceback features.
gotcha When used in Python 2.x, `traceback2` produces unicode output, which differs from the standard library `traceback` module's byte string output in Python 2. This behavior is due to its dependency on `linecache2`.
Fix: Be aware of potential encoding issues or unexpected string types if your Python 2.x application expects byte strings from traceback output.
gotcha Exception frame clearing (a feature for memory management by breaking reference cycles) might silently do nothing if the underlying Python interpreter does not support it.
Fix: Do not rely on frame clearing from `traceback2` for critical memory management, especially in older or non-standard Python interpreters. Verify its effect if it's a critical component of your memory strategy.
deprecated The `traceback2._some_str` (an unofficial API) behaves like the Python 3 version: objects where `unicode(obj)` fails but `str(obj)` works will be shown as `b'thestrvaluerepr'`. Relying on this internal API is not recommended and its behavior could be considered a breaking change if an application implicitly depended on Python 2's `_some_str` behavior.
Fix: Avoid using internal, unofficial APIs like `_some_str`. If similar functionality is needed, implement it explicitly or find a stable public API.
gotcha The library is not actively maintained, with the last release (1.4.0) being from March 2015. This means there will be no updates for new Python features, bug fixes, or security patches. It also dropped support for Python 2.6 and 3.2.
Fix: For new development, strongly prefer the standard library `traceback` module. `traceback2` should only be used in legacy projects requiring its specific backported functionality on older Python runtimes where the standard library is insufficient.

Install

pip install traceback2 Install traceback2

Imports

traceback
```
import traceback2 as traceback
```
The library is intended to be aliased as 'traceback' to mimic the standard library module.

Quickstart

This quickstart demonstrates how to import `traceback2` and use its `print_exc` function within an exception handler to print the current exception's traceback. It is typically aliased as `traceback` to match the standard library module it backports.

import traceback2 as traceback

def problematic_function():
    raise ValueError("Something went wrong in the function!")

try:
    problematic_function()
except ValueError as e:
    print(f"Caught an exception: {e}")
    print("\n--- Traceback (formatted by traceback2) ---")
    traceback.print_exc()

view raw JSON →