A nicer drop-in-replacement for Python sys.excepthook, i.e. it prints stack traces with extended information. It will add some useful information for each frame, like printing the relevant variables (relevant = referenced in the code line). Also see Python source and comments for further details.
Features
Shows locals/globals per frame, but only those used in the current statement. It does this by a simple Python code parser.
Multi-line Python statements in the stack trace output, in case the statement goes over multiple lines.
Shows full function qualified name (not just co_name).
Colored/formatted output of each frame.
Syntax highlighting for the Python source code.
Support for DomTerm, where it folds all the details of each stack frame away by default, and thus provides a much more comprehensive overview, while still providing all the details when needed.
Installation
You can just copy over the single file better_exchook.py to your project.
Or alternatively, it is also available on PyPI and can be installed via:
pip install better_exchookUsage
import better_exchook
better_exchook.install() # will just do: sys.excepthook = better_exchookExamples
Python example code:
try:
x = {1:2, "a":"b"}
def f():
y = "foo"
x, 42, sys.stdin.__class__, sys.exc_info, y, z
f()
except Exception:
better_exchook.better_exchook(*sys.exc_info())Output:
EXCEPTION
Traceback (most recent call last):
File "better_exchook.py", line 478, in <module>
line: f()
locals:
f = <local> <function f at 0x107f1de60>
File "better_exchook.py", line 477, in f
line: x, 42, sys.stdin.__class__, sys.exc_info, y, z
locals:
x = <global> {'a': 'b', 1: 2}
sys = <global> <module 'sys' (built-in)>
sys.stdin = <global> <open file '<stdin>', mode 'r' at 0x107d9f0c0>
sys.stdin.__class__ = <global> <type 'file'>
sys.exc_info = <global> <built-in function exc_info>
y = <local> 'foo'
z = <not found>
NameError: global name 'z' is not definedPython example code:
try:
f = lambda x: None
f(x, y)
except Exception:
better_exchook.better_exchook(*sys.exc_info())Output:
EXCEPTION
Traceback (most recent call last):
File "better_exchook.py", line 484, in <module>
line: f(x, y)
locals:
f = <local> <function <lambda> at 0x107f1df50>
x = <local> {'a': 'b', 1: 2}
y = <not found>
NameError: name 'y' is not definedPython example code:
try:
(lambda x: None)(__name__,
42) # multiline
except Exception:
better_exchook.better_exchook(*sys.exc_info())Output:
EXCEPTION
Traceback (most recent call last):
File "better_exchook.py", line 490, in <module>
line: (lambda x: None)(__name__,
42) # multiline
locals:
x = <local> {'a': 'b', 1: 2}
__name__ = <local> '__main__', len = 8
TypeError: <lambda>() takes exactly 1 argument (2 given)Python example code:
# use this to overwrite the global exception handler
sys.excepthook = better_exchook.better_exchook
# and fail
finalfail(sys)Output:
EXCEPTION
Traceback (most recent call last):
File "better_exchook.py", line 497, in <module>
line: finalfail(sys)
locals:
finalfail = <not found>
sys = <local> <module 'sys' (built-in)>
NameError: name 'finalfail' is not definedScreenshot:
Screencast with DomTerm:
Similar projects
IPython has something similar (ultratb). Do this: from IPython.core import ultratb; sys.excepthook = ultratb.VerboseTB(). Shows more source code context (but not necessarily all relevant parts).
Ka-Ping Yee’s “cgitb.py”, which is part of Python, see here, code here.
Rich Python library. Syntax highlighting but without locals.
andy-landy / traceback_with_variables. Python Traceback (Error Message) Printing Variables. Very similar, but less advanced. Only shows locals, not globals, and also just all locals, not only those used in current statement. Also does not expand statement if it goes over multiple lines.
cknd / stackprinter. Similar as IPython ultratb.
See this related StackOverflow question.
– Albert Zeyer, <http://www.az2000.de>
1 maintainer
Metadata
1 maintainer
Release files for better-exchook 1.20210525.141005
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | |
|---|---|---|---|---|
| better_exchook-1.20210525.141005.tar.gz | 21.6 kB | Without provenance | Details |
Release files / better_exchook-1.20210525.141005.tar.gz
| Download URL | better_exchook-1.20210525.141005.tar.gz |
|---|---|
| Size | 21.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
8ab6d73993deb204ea0554b345f36cd434acd1bd856ad6bb6f376e3a4d663c65
|
|
BLAKE2b-256 checksum How to use checksums |
ac0c17284829273fdfcb7d9fb3d3ec1866f80bbfa07bd1eec3c4592e7b536324
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.0 CPython/3.9.5
|
Security for better-exchook 1.20210525.141005
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.
