oaknut-exception
Categorised exceptions and a CLI error-reporting boundary for the
oaknut-* family of packages.
The package defines a small exception hierarchy that every other
oaknut-* package's domain errors slot into:
OaknutException— root of the hierarchy. Carries anexit_codeproperty derived from the BSDsysexits.hset (via theexit-codespackage).DataError— the operation failed because of the data it was given (a user-supplied path, a corrupted on-disc structure, an unsupported filetype). No traceback at the CLI boundary.ConfigurationError— the operation failed because of a runtime environment / configuration issue. No traceback at the CLI boundary.InternalError— the operation failed because something went wrong inside the library. Traceback retained at the CLI boundary so the report-an-issue path is obvious.
Plus a single error-handling boundary helper:
handled_errors— a context manager (also usable as a decorator) that catchesDataErrorandConfigurationError, prints them via a caller-supplied printer, and exits with the most appropriateExitCode.InternalErrorand unexpected exceptions propagate so their tracebacks reach the user.KeyboardInterruptexits with the conventional128 + SIGINTstatus.
This package is what every oaknut-disc-like CLI uses to map library
errors onto stable exit codes without dropping into try/except in every
command.
See the oaknut documentation for the full API reference.
Part of the oaknut monorepo.
Installation
uv add oaknut-exception # or: pip install oaknut-exception
License
MIT — see LICENSE.
1 maintainer
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file oaknut_exception-12.15.1.tar.gz.
File metadata
- Download URL: oaknut_exception-12.15.1.tar.gz
- Upload date:
- Size: 9.8 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
9a8b2a3764935c859c1df4bb62a2768d9cfd9d6f88016957184a35fd64024e1c
|
|
| MD5 |
93b8dbdc43537c86b36ee0f6bc5bcfa8
|
|
| BLAKE2b-256 |
b1fb05d4d07087647b025c27e315952a607b99d928293bf883c96ed553d0da47
|
File details
Details for the file oaknut_exception-12.15.1-py3-none-any.whl.
File metadata
- Download URL: oaknut_exception-12.15.1-py3-none-any.whl
- Upload date:
- Size: 7.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via:
uv/0.12.5 {"installer":{"name":"uv","version":"0.12.5","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4dd7fc0d5ed0fc5e1035a73b4ea97a7d857094235ad751bea683e198e4ed7aa9
|
|
| MD5 |
9dc86dd370dbcdf6ba66a1184cd67cfd
|
|
| BLAKE2b-256 |
97f92191c07f439306f8623612277be40b262d627d324c4fa7fa9062b1c012a5
|
