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

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

@@ -2,6 +2,20 @@
 
 <!--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)
 
 ### Fix

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: py4web-debug-tools
-Version: 1.3.2
+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
@@ -21,7 +21,9 @@ Requires-Dist: pydal
 Requires-Dist: typing-extensions
 Requires-Dist: yatl
 Provides-Extra: dev
+Requires-Dist: dotmap; extra == 'dev'
 Requires-Dist: hatch; extra == 'dev'
+Requires-Dist: pytest; extra == 'dev'
 Requires-Dist: su6[all]; extra == 'dev'
 Description-Content-Type: text/markdown
 

{py4web_debug_tools-1.3.2 → py4web_debug_tools-1.3.4}/pyproject.toml

@@ -54,6 +54,8 @@ Source = "https://github.com/trialandsuccess/py4web-debug-tools"
 dev = [
     "su6[all]",
     "hatch",
+    "pytest",
+    "dotmap",
 ]
 
 
@@ -69,6 +71,10 @@ upload_to_release = false
 build_command = "hatch build"
 
 
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+pythonpath = ["."]
+
 [tool.su6]
 directory = "src"
 include = []

py4web_debug_tools-1.3.4/src/py4web_debug/__about__.py

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

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

@@ -37,31 +37,30 @@ class PossiblyAsDict(typing.Protocol):
 class DDJsonEncoder(ConfigurableJsonEncoder):
     @staticmethod
     def _default(o: PossiblyAsDict) -> dict[str, typing.Any] | list[typing.Any] | str:
-        if hasattr(o, "as_list"):
+        # note: getattr with default rather than setattr because setattr might lie and produce None
+        if getattr(o, "as_list", None):
             # note: prefer as_list now as not every Rows may have an id (= default key of as_dict)
             return o.as_list()
-        # more as list stuff?
-
-        if hasattr(o, "as_dict"):
+        elif getattr(o, "as_dict", None):
             return o.as_dict()
-        elif hasattr(o, "asdict"):
+        elif getattr(o, "asdict", None):
             return o.asdict()
-        elif hasattr(o, "_asdict"):
+        elif getattr(o, "_asdict", None):
             return o._asdict()
-        elif hasattr(o, "_as_dict"):
+        elif getattr(o, "_as_dict", None):
             return o._as_dict()
-        elif hasattr(o, "to_dict"):
+        elif getattr(o, "to_dict", None):
             return o.to_dict()
-        elif hasattr(o, "todict"):
+        elif getattr(o, "todict", None):
             return o.todict()
-        elif hasattr(o, "_todict"):
+        elif getattr(o, "_todict", None):
             return o._todict()
-        elif hasattr(o, "_to_dict"):
+        elif getattr(o, "_to_dict", None):
             return o._to_dict()
-        elif hasattr(o, "__json__"):
+        elif getattr(o, "__json__", None):
             return o.__json__()
-
-        return str(o)
+        else:
+            return str(o)
 
     @staticmethod
     def is_probably_namedtuple(o: typing.Any) -> bool:
@@ -103,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.4/tests/test_dumping.py

@@ -0,0 +1,120 @@
+from types import SimpleNamespace
+
+import pytest
+from dotmap import DotMap
+from pytest import MonkeyPatch
+
+from src.py4web_debug.dumping import DDJsonEncoder, DumpDieError, DumpSerializationError, dd, dump
+
+
+def _sample_dotmap() -> DotMap:
+    data = DotMap()
+    data.a = 1
+    data.b.c = "nested"
+    return data
+
+
+def test_dump_handles_dotmap():
+    # dump() should serialize a DotMap without crashing.
+    result = dump(_sample_dotmap(), with_headers=False)
+
+    assert '"a": 1' in result
+    assert '"c": "nested"' in result
+
+
+def test_dd_handles_dotmap(monkeypatch: MonkeyPatch):
+    # dd() should not crash on a DotMap; in debug mode it raises a DumpDieError
+    # (by design) instead of letting json serialization blow up.
+    monkeypatch.setenv("PY4WEB_DEBUG_MODE", "1")
+
+    try:
+        dd(_sample_dotmap(), fancy=False)
+    except DumpDieError as e:
+        assert '"a": 1' in str(e)
+    else:
+        raise AssertionError("dd() should raise DumpDieError in debug mode")
+
+
+def test_default_crashes_on_bare_dotmap():
+    """
+    DotMap's __getattr__ returns an empty DotMap for ANY missing attribute
+    instead of raising AttributeError, so hasattr(dotmap, "as_list") is
+    always True even though `as_list` isn't a real method on it.
+
+    Note: dump()/dd() never hit this for a *bare* DotMap in practice, because
+    DotMap is a dict subclass and gets recognized (and recursed into) by
+    configurablejson's encoder before _default() is ever called - see
+    test_dump_handles_dotmap above, which passes fine. This test instead
+    calls DDJsonEncoder._default() directly, to pin the underlying flaw that
+    both this and the TypeDAL-model-class crash below share.
+
+    FAILS until DDJsonEncoder._default() is fixed:
+    TypeError: 'DotMap' object is not callable
+    """
+    d = DotMap({"label": "Dashboard"})
+
+    DDJsonEncoder._default(d)
+
+
+class _TableMetaLike(type):
+    """
+    Reproduces TypeDAL's `TableMeta.__getattr__`: for an unbound model class,
+    any attribute that isn't a real column falls through to `return None`
+    instead of raising AttributeError (see typedal/tables.py TableMeta.__getattr__).
+    """
+
+    def __getattr__(cls, name: str) -> None:
+        return None
+
+
+class Offering(metaclass=_TableMetaLike):
+    """Stand-in for a real TypeDAL model class, e.g. used as menu["model"]."""
+
+
+def test_dump_reproduces_as_list_crash_on_model_class_value():
+    """
+    Real-world crash reproduction (whitelabel AdminMenuFixture):
+    admin nav menu entries are plain dicts that carry a `"model"` key holding
+    the *model class itself* (e.g. `Offering`, not an instance). Wrapping such
+    an entry in a DotMap (for dot-access in templates) doesn't cause this —
+    a plain dict crashes identically, see test below.
+
+    FAILS until DDJsonEncoder._default() is fixed: it does
+    `if hasattr(o, "as_list"): o.as_list()` without checking it's callable.
+    TypeDAL's TableMeta.__getattr__ returns None for unknown attributes on a
+    model class instead of raising AttributeError, so hasattr() lies and
+    `o.as_list()` becomes `None()`. Matches production traceback exactly:
+    dumping.py:42 in _default -> TypeError: 'NoneType' object is not callable.
+    """
+    entry = DotMap({"label": "Aanbod beheren", "icon": "fas fa-masks-theater", "model": Offering})
+
+    dump(entry, with_headers=False)
+
+
+def test_dump_reproduces_as_list_crash_without_dotmap():
+    # Same crash with a plain dict: DotMap is incidental, not the cause.
+    entry1 = {"label": "Aanbod beheren", "model": Offering}
+    dump(entry1, with_headers=False)
+
+    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.2/src/py4web_debug/__about__.py

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