Exasol Error Reporting
This project contains a Python library for describing Exasol error messages. This library lets you define errors with a uniform set of attributes. Furthermore, the error message is implemented to be parseable, so that you can extract an error catalog from the code.
In a Nutshell
Install the library
pip install exasol-error-reporting
Create a Simple Error
from exasol import error
error1 = error.ExaError(
"E-TEST-1", "A trivial error", "No mitigation available", {}
)
Specify Multiple Mitigations
from exasol import error
error2 = error.ExaError(
"E-TEST-2",
message="Fire in the server room",
mitigations=[
"Use the fire extinguisher",
"Flood the room with halon gas (Attention: make sure no humans are in the room!)"
],
parameters={}
)
Error Parameter(s) without description
from exasol import error
error3 = error.ExaError(
"E-TEST-2",
"Not enough space on device {{device}}.",
"Delete something from {{device}}.",
{"device": "/dev/sda1"},
)
Error with detailed Parameter(s)
from exasol import error
from exasol.error import Parameter
error4 = error.ExaError(
"E-TEST-2",
"Not enough space on device {{device}}.",
"Delete something from {{device}}.",
{"device": Parameter("/dev/sda1", "name of the device")},
)
Check out the user guide for more details.
Tooling
The exasol-error-reporting library comes with a command line tool (ec) which also can be invoked
by using its package/module entry point (python -m exasol.error).
For detailed information about the usage consider consulting the help ec --help or python -m exasol.error --help.
Parsing the error definitions in a python file(s)
ec parse some-python-file.py
ec parse < some-python-file.py
Generating an error-code data file
In order to generate a error-code-report compliant data file, you can use the generate subcommand.
ec generate NAME VERSION PACKAGE_ROOT > error-codes.json
Links and References
For further details check out the project documentation.
Metadata
Release files for exasol-error-reporting 1.1.0
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | Provenance | Actions |
|---|---|---|---|---|
| exasol_error_reporting-1.1.0.tar.gz | 14.0 kB | Without provenance | Details for exasol_error_reporting-1.1.0.tar.gz |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Actions Reset |
|---|---|---|---|---|
| exasol_error_reporting-1.1.0-py3-none-any.whl | Python 3 | none | any | Details for exasol_error_reporting-1.1.0-py3-none-any.whl |
Total release size: 32.1 kB
Release files / exasol_error_reporting-1.1.0.tar.gz
| Download URL | exasol_error_reporting-1.1.0.tar.gz |
|---|---|
| Size | 14.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
a1e3273fddfac11b91beb75be7c79aaa5143f0ceb522b489aac426fc207ee6a5
|
|
BLAKE2b-256 checksum How to use checksums |
ec01f0c196eb63aa959de8a77827d61b8e79c389bc4df75eb93c36beac452fbd
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.0 CPython/3.10.19 Linux/6.11.0-1018-azure
|
Release files / exasol_error_reporting-1.1.0-py3-none-any.whl
| Download URL | exasol_error_reporting-1.1.0-py3-none-any.whl |
|---|---|
| Size | 18.2 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1534d30aaf0fe9c66a5d5b49f28bb8ece909e660b616ba6df41384404fd936ad
|
|
BLAKE2b-256 checksum How to use checksums |
6424bc7427fb95732e9dab17b728c7083be998cabee42691d3287a60b69c9652
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.0 CPython/3.10.19 Linux/6.11.0-1018-azure
|
Security for exasol-error-reporting 1.1.0
Provenance
Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.
No provenance found
None of the files in this release were uploaded with provenance metadata.
A note on package security
PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.
To learn more about protecting yourself from malicious actors, visit our package security documentation.