hardbyte / hardbyte/python-common-expression-language

Common base class for CEL exceptions, without breaking the existing builtin mappings

Open
#49 0 comments 0 reactions 0 assignees View on GitHub
enhancement
Dominant language
Python
Stars
43
Forks
4
Avg merge
9h 57m
Merged PRs (30d)
14

Description

Follow-up promised when closing #23. Execution errors are mapped to the idiomatic builtin (`RuntimeError`, `TypeError`, `KeyError`, `IndexError`, `ZeroDivisionError`, `OverflowError`) and parse errors to `ValueError`, which is right for each case but means "did the rule run and fail" needs a five-clause `except`:

```python
except (RuntimeError, TypeError, KeyError, IndexError, ArithmeticError):
```

## Proposal

Add a `cel.CelError` hierarchy whose members also inherit from the builtin they replace, so nothing existing breaks:

```python
class CelError(Exception): ...
class CelParseError(CelError, ValueError): ...
class CelRuntimeError(CelError, RuntimeError): ...
class CelTypeError(CelError, TypeError): ...
class CelKeyError(CelError, KeyError): ...
class CelIndexError(CelError, IndexError): ...
class CelZeroDivisionError(CelError, ZeroDivisionError): ...
class CelOverflowError(CelError, OverflowError): ...
```

`except TypeError` keeps working; `except cel.CelError` catches everything CEL raised; `except cel.CelParseError` separates a bad rule from a failed check.

## Implementation notes

PyO3's `create_exception!` only takes a single base, so define the classes in a small `python/cel/exceptions.py` and have `map_execution_error_to_python` look them up from the module once (a `GILOnceCell>` per class) and raise with `PyErr::from_type`. Add them to `cel.pyi` and to the error-handling how-to, whose current table becomes the mapping between the two hierarchies.

Contributor guide

Open the contributing guide

Research direction

Start by inspecting python/cel/exceptions.py, map_execution_error_to_python, cel.pyi, and the error-handling how-to. Trace the existing execution and parse error mappings, then verify that the new hierarchy preserves builtin exception handling, supports catching cel.CelError, and is documented in the stub and how-to table.

Written by the indexing model from the issue text.

Assessment

Tech stack
python, rust
Domain
backend-api-design, documentation
Issue type
Feature
Difficulty
4/5
Estimated time
3-5 days
Activity status
Active
Clarity
Clearly specified
Newbie friendliness
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.