with-err 1.0.0__py3-none-any.whl

with_err/__init__.py

@@ -0,0 +1,7 @@
+from .utils import get_err_strs as get_err_strs
+from .with_err import with_err as with_err
+
+all = [
+    'with_err',
+    'get_err_strs'
+]

with_err/utils.py

@@ -0,0 +1,11 @@
+# https://share.gemini.google/BDvazjX2RWsE
+
+import traceback
+
+
+def get_err_strs(err: Exception | None) -> list[str]:
+    """Accepts an exception instance and returns the full traceback as list[str]."""
+    if err is None:
+        return []
+
+    return traceback.format_exception(err)

with_err/with_err.py

@@ -0,0 +1,65 @@
+# https://share.gemini.google/BDvazjX2RWsE
+
+import sys
+import types
+from collections.abc import Callable
+from functools import wraps
+from typing import Protocol
+
+
+# @type_check_only
+class RetWithErr[**P, R](Protocol):
+    def __call__(self, *args: P.args, **kwargs: P.kwargs) -> tuple[R | None, Exception | None]:
+        ...
+
+
+def with_err[**P, R](*exceptions: type[Exception]) -> Callable[[Callable[P, R]], RetWithErr[P, R]]:
+    """
+    Wraps a function to return (result, Exception) instead of raising.
+
+    XXX Reason repeating exceptions and Exception:
+        We don't want to create another layer of function tracestack.
+    """
+
+    def decorator(func: Callable[P, R]) -> Callable[P, tuple[R | None, Exception | None]]:
+        @wraps(func)
+        def wrapper(*args: P.args, **kwargs: P.kwargs) -> tuple[R | None, Exception | None]:
+            try:
+                result = func(*args, **kwargs)
+                return result, None
+            except exceptions as e:
+                # 1. Fetch exception's original internal traceback.
+                tb = sys.exc_info()[2]
+
+                # 2. Capture the caller frame executing func.
+                caller_frame = sys._getframe(1)
+
+                # 3. Create a parent traceback frame and link it above 'tb'.
+                combined_tb = types.TracebackType(
+                    tb_next=tb,
+                    tb_frame=caller_frame,
+                    tb_lasti=caller_frame.f_lasti,
+                    tb_lineno=caller_frame.f_lineno
+                )
+
+                # 4. Attach the combined traceback back to the error instance
+                return None, e.with_traceback(combined_tb)
+            except Exception as e:  # ruff: ignore[blind-except]
+                # 1. Fetch exception's original internal traceback.
+                tb = sys.exc_info()[2]
+
+                # 2. Capture the caller frame executing func.
+                caller_frame = sys._getframe(1)
+
+                # 3. Create a parent traceback frame and link it above 'tb'.
+                combined_tb = types.TracebackType(
+                    tb_next=tb,
+                    tb_frame=caller_frame,
+                    tb_lasti=caller_frame.f_lasti,
+                    tb_lineno=caller_frame.f_lineno
+                )
+
+                # 4. Attach the combined traceback back to the error instance
+                return None, e.with_traceback(combined_tb)
+        return wrapper
+    return decorator

with_err-1.0.0.dist-info/METADATA

@@ -0,0 +1,117 @@
+Metadata-Version: 2.4
+Name: with-err
+Version: 1.0.0
+Summary: converting `try-except` pattern to Go-like `result, err` pattern.
+Keywords: 
+Author: Chuan-Heng Hsiao
+Author-email: Chuan-Heng Hsiao <hsiao.chuanheng@gmail.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.12
+Project-URL: Repository, https://github.com/chhsiao1981/with-err
+Description-Content-Type: text/markdown
+
+# with-err
+
+`with-err` is a python library that converts `try-except` pattern into Go-like `result, err` pattern. I feel `result, err` pattern easier to maintain in large projects.
+
+## Getting Started
+
+### Install
+
+```sh
+pip install with-err
+```
+
+(with [`uv`](https://docs.astral.sh/uv/))
+```sh
+uv pip install with-err
+```
+
+### Use as Function
+
+```python
+import json
+from with_err import with_err
+
+json_loads_e = with_err()(json.loads)
+
+data, err = json_loads_e('{"a": 1}')
+assert err is None
+assert data = {"a": 1}
+
+data, err = json_loads_e('{"a": }')
+assert err is not None
+assert data is None
+```
+
+### Use as Decorator
+
+```python
+import json
+from with_err import with_err
+
+@with_err()
+def json_loads_e(a: str | bytes | bytearray):
+    return json.loads(a)
+
+data, err = json_loads_e('{"a": 1}')
+assert err is None
+assert data = {"a": 1}
+
+data, err = json_loads_e('{"a": }')
+assert err is not None
+assert data is None
+```
+
+### `with_err` with Specified Exceptions
+
+```python
+import json
+from with_err import with_err
+
+@with_err(json.decoder.JSONDecodeError)
+def json_loads_e(a: str | bytes | bytearray):
+    return json.loads(a)
+
+data, err = json_loads_e('{"a": 1}')
+assert err is None
+assert data = {"a": 1}
+
+data, err = json_loads_e('{"a": }')
+assert err is not None
+assert data is None
+```
+
+### Get `err` Traceback Stack
+
+```python
+import json
+from with_err import with_err, get_err_strs
+
+def json_loads_e(a: str | bytes | bytearray):
+    return json.loads(a)
+
+_data, err = json_loads_e('{"a": 1}')
+err_stack = get_err_strs(err)
+assert err is None
+assert err_stack == []
+```
+
+```python
+import json
+import re
+from with_err import with_err, get_err_strs
+
+def json_loads_e(a: str | bytes | bytearray):
+    return json.loads(a)
+
+_data, err = json_loads_e('{"a": }')
+err_stack = get_err_strs(err)
+err_str = '\n'.join(err_stack)
+assert err is not None
+assert len(err_stack) > 0
+assert re.search(r'json/__init__.py", line \d+, in loads', err_str)
+assert re.search(r', line \d+, in json_loads_e', err_str)
+```

with_err-1.0.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+with_err/__init__.py,sha256=430ZmzuYzLEyGMGFFI-U21DuPG76yvo-8IwKQAPGY_E,137
+with_err/utils.py,sha256=39OxLBB-rUOYgCrm9nmzyhsOV4AVhTusATC-dXM3NXE,284
+with_err/with_err.py,sha256=xyLbgmhUewopFQVUFX5H_5V3jr1kSXmJyiczikJPcdY,2450
+with_err-1.0.0.dist-info/WHEEL,sha256=4OL6Foqnnp3xRY5wMkjgc25_i5YJC6dKsC6LPcjqEoU,80
+with_err-1.0.0.dist-info/entry_points.txt,sha256=i2oN8Ae25gU-XoxtDndkB7we3AiSvh8-LPe0e6_tgrM,19
+with_err-1.0.0.dist-info/METADATA,sha256=fljLZz_FK4rU2G3NIe-DdkKiyGujOqkdpnrhnGppDmE,2477
+with_err-1.0.0.dist-info/RECORD,,

with_err-1.0.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: uv 0.12.5
+Root-Is-Purelib: true
+Tag: py3-none-any

with_err-1.0.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+