Prettifies Python exception output to make it legible.
Prettifies Python exception output to make it legible. Install it with
python -m pip install pretty-errors
Use it simply by importing it:
Note you need to be running in a terminal capable of colour output in order to get colour output: in Windows this means powershell, cmder, etc.
If you want to configure the output then use
pretty_errors.configure(). For example:
import pretty_errors pretty_errors.configure( seperator_character = 'â€”', line_length = 54, filename_display = pretty_errors.FILENAME_FULL )
It is possible to have the interactive interpreter always use
pretty_errors, instead of including it in your projects, by using the
PYTHONSTARTUP environment variable. Set it to a python file and that file will be run every time python is. If you don't already have one then create a file with the above code block and set
PYTHONSTARTUP to its path. Whenever you run python interactively,
pretty_errors will be automatically imported and configured (though this will not be true when your python code is run outwith the interactive interpreter.)
Output will be wrapped at this point. If this matches your console width you may want to disable
full_line_newlinein order to prevent apparent double newlines.
Insert a hard newline even if the line is full. Disable if the console automatically inserts its own newline at this point.
How the filename is displayed: may be
When enabled a timestamp is written in the traceback header.
When enabled a link is written below the error location, which VSCode will allow you to click on.
Character used to create the header line. Hyphen is used by default.
Escape sequence to set header color.
Escape sequence to set timestamp color.
Escape sequence to set default color.
Escape sequence to set filename color.
Escape sequence to set line number color.
Escape sequence to set function color.
Escape sequence to set link color.
When enabled the reset escape sequence will be written to stdout as well as stderr; turn this on if your console is being left with the wrong color.
If you want to customize the output more than
configure provides then you can replace the output functions
sys.stderr after importing
pretty_errors. These are:
Is called at the start of a traceback.
Returns a string timestamp used in the header if
write_location(self, path, line_number, function)
Is called with details on the exception's location.
Is called with any other text sent to stderr (i.e. the code in question).
bodywill never contain
\n, though it may be longer than the defined maximum line length.
You may replace as many of these functions as you wish, or for maximum control of output you may replace the main method called with all stderr output:
You may use these helper functions to make this easier (see
pretty_errors/__init__.py for examples, especially
output_text(self, text, newline = False)
Outputs text while trying to only insert 1 newline when outputing a line of maximum length.
textshould be a list of strings: colour escape codes and text data.
Extracts location of exception. If it returns
Nonethen text was not a location identifier.
Checks if text is the start of a traceback.
For example, to change the header:
def write_header(self): self.output_text([self.header_color, "\nERROR!!!!!!!!!!"], newline = True) sys.stderr.write_header = write_header
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
|Filename, size & hash||File type||Python version||Upload date|
|pretty_errors-1.0.10-py3-none-any.whl (5.7 kB) View hashes||Wheel||py3|
|pretty_errors-1.0.10.tar.gz (4.7 kB) View hashes||Source||None|
Hashes for pretty_errors-1.0.10-py3-none-any.whl