My friendly error base class - for Python.
Project description
mybad
![Coverage Status](https://pypi-camo.freetls.fastly.net/bea08036aa3e758ff2a2c077bc3263cadcc522b4/68747470733a2f2f636f6465636f762e696f2f67682f6772696d656e2f707974686f6e2d6d796261642f6272616e63682f6d61737465722f67726170682f62616467652e737667)
My friendly error base class - for Python.
Introduction
One in general always needs a application/library specific error base class, but the native errors are very limited in what meta/debugging information they can hold at time they are raised. For better debugging and error reporting/inspection this error base class allows to attach some additonal error context information that can be used to better understand the issue - without having to create custom error formatters, or run debugger.
Install
Install using pip:
$ pip install mybad
Use
Very basic example:
from mybad import Error
class ToMuchError(Error):
pass
def print_money(stash):
try:
if isinstance(stash, str) and len(stash) > 13:
raise Exception('Too much money to print: {0}'.format(stash))
print('PRINT {0}'.format(stash))
except Exception as error:
raise ToMuchError(error,
message = 'Out of money printing ink...',
id = hash(stash),
key = 'too_much',
code = 400,
details = dict(
stash = stash,
)
)
amount = ''
for dollar in range(42):
amount += '$'
print_money(amount)
Run this with optional environment variables COLORS
/ ERROR_COLORS
and/or VERBOSE
/ ERROR_VERBOSE
set too truthy or falsy values, so see various error info formatting in terminal.
Something like this (imagine some colorized formatting):
PRINT $
PRINT $$
PRINT $$$
PRINT $$$$
PRINT $$$$$
PRINT $$$$$$
PRINT $$$$$$$
PRINT $$$$$$$$
PRINT $$$$$$$$$
PRINT $$$$$$$$$$
PRINT $$$$$$$$$$$
PRINT $$$$$$$$$$$$
PRINT $$$$$$$$$$$$$
Out of money printing ink... - { stash: '$$$$$$$$$$$$$$' }
Traceback (most recent call last):
File "examples/basic.py", line 25, in print_money
raise Exception('Too much money to print: {0}'.format(stash))
Exception: Too much money to print: $$$$$$$$$$$$$$
During handling of the above exception, another exception occurred:
Traceback (most recent call last):
File "examples/basic.py", line 45, in <module>
print_money(amount)
File "examples/basic.py", line 36, in print_money
stash = stash,
__main__.ToMuchError: Out of money printing ink... - {'stash': '$$$$$$$$$$$$$$'}
Test
Clone down source code:
$ make install
Run colorful tests, with only native environment (dependency sandboxing up to you):
$ make test
Run less colorful tests, with multi-environment (using tox):
$ make test-tox
Related
mybase
- "My friendly library base class - for Python"
About
This project was mainly initiated - in lack of solid existing alternatives - to be used at our work at Markable.ai to have common code conventions between various programming environments where Python (research, CV, AI) is heavily used.
License
Released under the MIT license.
Project details
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.