Module to manage error code, descriptions and data in a unified way throughout a project
Project description
A lightweight implementation of a manager for error messages throughout your project. Allows you to easily define and register error codes and messages. Enable easy access to a single list of registerd error codes and messages throughout your project.
Free software: GNU Lesser General Public License v3 or later (LGPLv3+)
Installation
pip install error-manager
You can also install the in-development version with:
pip install https://github.com/MaartendeRuyter/errors/archive/master.zip
Main usecases
Error manager provides you with a ListErrors class to retrieve your custom error codes and descriptions throughout your project:
# retrieve customer defined ErrorCode object form ``ListErrors`` class >>> from errors import ListErrors >>> error = ListErrors.COULD_NOT_FIND_ERROR_CODE >>> error ErrorCode(code='ER_GETERROR_00001', description='Could not find requested error code', error_data=<class 'dict'>) # add custom error data to error message when you want to persist or log # the error >>> from errors import add_error_data >>> error_with_data = add_error_data(error, {'key': 'Example error data'}) >>> error_with_data ErrorCode(code='ER_GETERROR_00001', description='Could not find requested error code', error_data={'key': 'Example error data'})
Documentation
Changelog
0.1.0 (2021-10-08)
First release on PyPI.
0.9.0 (2021-10-11)
added error codes as attribut to ListErrors class. After registration of an ErrorCode the errorcode is accessible in ListErrors via:
ListErrors.ERROR_CODE_KEY
Added Documentation and removed default redundant Documentation
1.0.0 (2021-10-12)
Added Documentation and removed more default but redundant Documentation
Added reference documentation for ListErrors and base module
1.1.0 (2021-11-05)
Added is_error method to check if an object is an instance of (sub)class ErrorCode
1.1.1 (2021-11-06)
Import ListErrors, ErrorCode, add_error_data() and is_error() in errors __init__.py so that they can be directly imported from errors module
1.2.0 (2022-05-06)
Added a dataclass ReturnValueWithStatus to allow consuming classes and methods to return a single return type with result, status and errors collected in one Object
1.2.1 (2022-05-08)
Added a class ReturnValueWithErrorStatus to easily create ReturnValueWithStatus with a error attached to it.
1.2.2 (2022-05-09)
Added ReturnValueWithErrorStatus to __init__ for easy import.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for error_manager-1.2.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 828be53dd5daaab68bb54658c8c0d3566b8f12b0c211e6f6d5029ea436455187 |
|
MD5 | 9ce2b359bfa8db3b3369275a6319322b |
|
BLAKE2b-256 | 8938e4c189d123210c682ef111066a068ee887affcff5189228be9bacd097a1a |