error-links 0.2.0

Adds helpful links to the REPL when an exception happens.

error-links

error-links adds Google and Python documentation links to the bottom of exceptions.

In most terminals, you will need to hold Cmd or Ctrl to allow clicking the link.

This works really well alongside Rich's traceback handler, which is what enabled the highlighting and coloured output in the screenshot above.

Usage

To use this package, simply install it with python -m pip install error_links. Then, install the error links with

from error_links import install
install()

You can control whether to show the emoji or the text with the install keyword arguments use_emoji and show_text, respectively.

For example, install(show_text=False) will use only the emoji for the link.

Install automatically

You can install the error links automatically if you modify the file sitecustomize.py in your directory site-packages. The command error-links install should install error links automatically, so that you get error links when you run other files and scripts with the command python. Use the command error-links where to figure out what the installation file is.

If you want error links in the REPL automatically as well, you can read this article on how to run custom Python code on REPL startup.