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
Metadata
1 maintainer
Release files for oaknut-exception 12.18.2
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| oaknut_exception-12.18.2.tar.gz | 9.8 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| oaknut_exception-12.18.2-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 16.9 kB
Release files / oaknut_exception-12.18.2.tar.gz
| Download URL | oaknut_exception-12.18.2.tar.gz |
|---|---|
| Size | 9.8 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
dda96c9adb111ba42a485ca0e8c4934cd5371a12e29576dd110fddd1c348ed8a
|
|
BLAKE2b-256 checksum How to use checksums |
7c57e009d3e4c10c0beb3cdfc9e456554026f137cf8de44b0de151063ed889e5
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.16 {"installer":{"name":"uv","version":"0.12.16","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}
|
Release files / oaknut_exception-12.18.2-py3-none-any.whl
| Download URL | oaknut_exception-12.18.2-py3-none-any.whl |
|---|---|
| Size | 7.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
a33ec84234f952d7b4356b346b6e913872f36ed4061f4f77f8e6333c1100aae3
|
|
BLAKE2b-256 checksum How to use checksums |
028e0d80d604d10b99509e903b3a092895e6ca305ccb401066d312b3e72dd983
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
uv/0.12.16 {"installer":{"name":"uv","version":"0.12.16","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}
|
