py4web-debug-tools 1.3.3__tar.gz → 1.3.4__tar.gz

{py4web_debug_tools-1.3.3 → py4web_debug_tools-1.3.4}/CHANGELOG.md

@@ -2,8 +2,18 @@
 
 <!--next-version-placeholder-->
 
+## v1.3.4 (2026-08-06)
+
+### Fix
+
+* Improved error message if json failed to `dump()` ([`920b786`](https://github.com/trialandsuccess/py4web-debug-tools/commit/920b78685cfc89cf27269972326562da7c4d05f6))
+
 ## v1.3.3 (2026-08-06)
 
+### Fix
+
+* Fix JSON dumping for TypeDAL model classes and DotMap-like objects whose dynamic attribute lookup makes hasattr()
+  return misleading results. ([PR 2](https://github.com/trialandsuccess/py4web-debug-tools/pull/2))
 
 
 ## v1.3.2 (2025-12-12)

{py4web_debug_tools-1.3.3 → py4web_debug_tools-1.3.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py4web-debug-tools
-Version: 1.3.3
+Version: 1.3.4
 Summary: Debug Tools for py4web
 Project-URL: Documentation, https://github.com/trialandsuccess/py4web-debug-tools#readme
 Project-URL: Issues, https://github.com/trialandsuccess/py4web-debug-tools/issues

py4web_debug_tools-1.3.4/src/py4web_debug/__about__.py

@@ -0,0 +1 @@
+__version__ = "1.3.4"

{py4web_debug_tools-1.3.3 → py4web_debug_tools-1.3.4}/src/py4web_debug/dumping.py

@@ -102,8 +102,30 @@ def dump(data: typing.Iterable[typing.Any], with_headers: bool = True) -> str:
     if with_headers:
         response.headers["Content-Type"] = "application/json"
 
-    return json.dumps(data, indent=2, cls=DDJsonEncoder)
-    # return json.dumps(data, indent=2, default=DDJsonEncoder._default)
+    try:
+        return json.dumps(data, indent=2, cls=DDJsonEncoder)
+        # return json.dumps(data, indent=2, default=DDJsonEncoder._default)
+    except Exception as e:
+        raise DumpSerializationError(data, e) from e
+
+
+class DumpSerializationError(TypeError):
+    """
+    Raised by dump() when the data (or something nested inside it) could not be
+    JSON-serialized, even with DDJsonEncoder's custom object-to-dict fallback rules.
+
+    Wraps the original error (still available via `__cause__`/`.original`) with
+    context about what was being dumped, so this is actionable instead of a bare
+    stdlib error surfacing from deep inside json.dumps()/DDJsonEncoder internals.
+    """
+
+    def __init__(self, data: typing.Any, original: Exception) -> None:
+        self.data = data
+        self.original = original
+        super().__init__(
+            f"dump() could not JSON-serialize this data (top-level type: {type(data).__name__}): "
+            f"{original.__class__.__name__}: {original}"
+        )
 
 
 class DumpDieError(Exception):

{py4web_debug_tools-1.3.3 → py4web_debug_tools-1.3.4}/tests/test_dumping.py

@@ -1,9 +1,10 @@
 from types import SimpleNamespace
 
+import pytest
 from dotmap import DotMap
 from pytest import MonkeyPatch
 
-from src.py4web_debug.dumping import DDJsonEncoder, DumpDieError, dd, dump
+from src.py4web_debug.dumping import DDJsonEncoder, DumpDieError, DumpSerializationError, dd, dump
 
 
 def _sample_dotmap() -> DotMap:
@@ -97,3 +98,23 @@ def test_dump_reproduces_as_list_crash_without_dotmap():
 
     entry2 = SimpleNamespace(label="Aanbod beheren", model=Offering)
     dump(entry2, with_headers=False)
+
+
+def test_dump_wraps_unexpected_errors_with_context():
+    """
+    Force *some other* JSON-serialization failure (a plain circular reference,
+    nothing to do with DotMap/permissive __getattr__) to prove dump() wraps
+    whatever goes wrong with a nicer, actionable error instead of leaking a
+    bare exception from deep inside json.dumps()/DDJsonEncoder.
+    """
+    circular: dict = {}
+    circular["self"] = circular
+
+    with pytest.raises(DumpSerializationError) as exc_info:
+        dump(circular, with_headers=False)
+
+    err = exc_info.value
+    assert "could not JSON-serialize" in str(err)
+    assert "dict" in str(err)  # names the top-level type that was being dumped
+    assert isinstance(err.__cause__, ValueError)  # original error is preserved/chained
+    assert "circular" in str(err.__cause__).lower()

py4web_debug_tools-1.3.3/src/py4web_debug/__about__.py

@@ -1 +0,0 @@
-__version__ = "1.3.3"