Last release Python version Documentation Test status Test coverage Last commit

TidyExc provides an exception base class that makes it easy to raise rich, helpful exceptions:

  • Rich: Instead of simply storing an error message, TidyExc exceptions separately store parameters and message templates. This separation makes it easier for exception handling code to access information describing the error and to respond accordingly.

  • Helpful: TidyExc is inspired by the error message conventions promoted by the tidyverse style guide. Briefly, these conventions state that an error message should consist of a brief statement of the problem, followed by a bullet-point list of relevant contextual information. The bullet-point format makes it easy to include lots of detail, without the detail becoming overwhelming.

The following example shows TidyExc in action:

>>> from tidyexc import Error
>>> class CheeseShopError(Error):
...     pass
>>> err = CheeseShopError(
...         product_name="Red Leicester",
...         num_requested=1,
...         num_available=0,
... )
>>> err.brief = "insufficient inventory to process request"
>>> err.info += "{num_requested} {product_name} requested"
>>> err.blame += "{num_available} available"
>>> raise err
Traceback (most recent call last):
CheeseShopError: insufficient inventory to process request
• 1 Red Leicester requested
✖ 0 available