Manage error codes, 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.
docs |
|
---|---|
tests |
|
package |
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
1.3.2 (2023-10-23)
Added support for python 3.12
1.3.1 (2023-10-20)
Refactored setup.cfg and pyproject.toml
1.3.0 (2022-11-01)
Added type annotations
1.2.4 (2022-10-26)
Added support for python 3.11
1.2.2 (2022-05-09)
Added ReturnValueWithErrorStatus to __init__ for easy import.
1.2.1 (2022-05-08)
Added a class ReturnValueWithErrorStatus to easily create ReturnValueWithStatus with a error attached to it.
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.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.1.0 (2021-11-05)
Added is_error method to check if an object is an instance of (sub)class ErrorCode
1.0.0 (2021-10-12)
Added Documentation and removed more default but redundant Documentation
Added reference documentation for ListErrors and base module
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
0.1.0 (2021-10-08)
First release on PyPI.
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.3.5-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5ac62eef35e690e823fda98ea101a6d54197bd5ef6ec50284a4ec9aa118b9266 |
|
MD5 | cbdc1b8a71ab59dc031dd17db9709fd2 |
|
BLAKE2b-256 | d7f3286e1c685392cd38c8a930f2604321980000a9dbeda276de01551c9b6325 |