Human readable stacktraces for Python.
MIT License
Human readable stacktraces for Python.
Project/Repo:
Code Quality/CI:
Pretty Traceback groups together what belongs together, adds coloring and alignment. All of this makes it easier for you to see patterns and filter out the signal from the noise. This tabular format is best viewed in a wide terminal.
In other words, get this 😍
Instead of this 🤮
Traceback (most recent call last):
File "test/test_formatting.py", line 199, in <module>
main()
File "test/test_formatting.py", line 190, in main
run_pingpong()
File "test/test_formatting.py", line 161, in run_pingpong
sched3.run()
File "/home/mbarkhau/miniconda3/envs/pretty-traceback_py38/lib/python3.8/sched.py", line 151, in run
action(*argument, **kwargs)
File "/home/mbarkhau/miniconda3/envs/pretty-traceback_py38/lib/python3.8/sched.py", line 151, in run
action(*argument, **kwargs)
File "/home/mbarkhau/miniconda3/envs/pretty-traceback_py38/lib/python3.8/sched.py", line 151, in run
action(*argument, **kwargs)
File "test/test_formatting.py", line 151, in _ping
_pong(depth + 1)
File "test/test_formatting.py", line 129, in _pong
_ping(depth + 1)
File "test/test_formatting.py", line 136, in _ping
sp.check_output(["command_that", "doesnt", "exist"])
File "/home/mbarkhau/miniconda3/envs/pretty-traceback_py38/lib/python3.8/subprocess.py", line 411, in check_output
return run(*popenargs, stdout=PIPE, timeout=timeout, check=True,
File "/home/mbarkhau/miniconda3/envs/pretty-traceback_py38/lib/python3.8/subprocess.py", line 489, in run
with Popen(*popenargs, **kwargs) as process:
File "/home/mbarkhau/miniconda3/envs/pretty-traceback_py38/lib/python3.8/subprocess.py", line 854, in __init__
self._execute_child(args, executable, preexec_fn, close_fds,
File "/home/mbarkhau/miniconda3/envs/pretty-traceback_py38/lib/python3.8/subprocess.py", line 1702, in _execute_child
raise child_exception_type(errno_num, err_msg, err_filename)
FileNotFoundError: [Errno 2] No such file or directory: 'command_that'
If your terminal is wide enough, the long paths are preserved.
Add the following to your __main__.py
or the equivalent module which is your entry point.
try:
import pretty_traceback
pretty_traceback.install()
except ImportError:
pass # no need to fail because of missing dev dependency
Please do not add this code e.g. to your __init__.py
or any other module that your users may import. They may not want you to mess with how their tracebacks are printed.
If you do feel the overwhelming desire to import the pretty_traceback
in code that others might import, consider using the envvar
argument, which will cause the install function to effectively be a noop unless you set ENABLE_PRETTY_TRACEBACK=1
.
try:
import pretty_traceback
pretty_traceback.install(envvar='ENABLE_PRETTY_TRACEBACK')
except ImportError:
pass # no need to fail because of missing dev dependency
Note, that the hook is only installed if the existing hook is the default. Any existing hooks that were installed before the call of pretty_traceback.install
will be left in place.
A logging.Formatter
subclass is also available (e.g. for integration with flask
).
import os
from flask.logging import default_handler
try:
if os.getenv('FLASK_DEBUG') == "1":
import pretty_traceback
default_handler.setFormatter(pretty_traceback.LoggingFormatter())
except ImportError:
pass # no need to fail because of missing dev dependency
Pretty Traceback is heavily inspired by the backtrace module by nir0s but there are many others (sorted by github stars):
Name | role | since | until |
---|---|---|---|
Manuel Barkhau ([email protected]) | author/maintainer | 2020-08 | - |