Skip to main content

A utility to trim Python traceback information.

Project description

tbtrim

PyPI - Downloads PyPI - Version PyPI - Format PyPI - Python Version PyPI - Status Travis CI - Status License

tbtrim is a utility to trim Python traceback information. By assigning user-refined sys.excepthook, one can easily customize the behavior after an exception is raise and uncaught, and just before the interpreter prints out the given traceback and exception to sys.stderr.

In a more human-readable way, tbtrim is to let you handle the last words of a program when it exits because of an exception.

Installation

Simply run the following to install the current version from PyPI:

$ pip install tbtrim

Or install the latest version from the git repository:

git clone https://github.com/gousaiyang/tbtrim.git
cd tbtrim
pip install -e .
# and to update at any time
git pull

Usage

set_trim_rule(predicate, target=BaseException, exclude=None, strict=False, exception=None)

Set the rule for trimming traceback (will set sys.excepthook and threading.excepthook if available).

You can determine whether to start trimming traceback items based on the filename (using predicate), and can choose to trim traceback only for some certain exceptions (using target and exclude).

Args:

  • predicate (function): a function which takes one str parameter (the filename of a traceback item) and returns bool (returning True indicates that this traceback item and the following items should be trimmed)
  • target (class_or_tuple): an exception or a tuple of exceptions may be given to trim traceback only for those exceptions
  • exclude (class_or_tuple): an exception or a tuple of exceptions may be given to exclude them from traceback trimming
  • strict (bool): indicate whether to check an exception against target and exclude in a strict mode (setting True uses is to check, False uses issubclass to check)
  • exception (class_or_tuple): this is a deprecated alias of exclude, retained for backward compatibility

clear_trim_rule()

Clear the rule for trimming traceback (restore the excepthooks).

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for tbtrim, version 0.3.1
Filename, size File type Python version Upload date Hashes
Filename, size tbtrim-0.3.1-py2.py3-none-any.whl (4.4 kB) File type Wheel Python version py2.py3 Upload date Hashes View
Filename, size tbtrim-0.3.1.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page