TypeDAL 4.6.0__tar.gz → 4.6.1__tar.gz

{typedal-4.6.0 → typedal-4.6.1}/CHANGELOG.md

@@ -2,6 +2,12 @@
 
 <!--next-version-placeholder-->
 
+## v4.6.1 (2026-03-13)
+
+### Fix
+
+* **pydantic:** Exclude fields with 'readable=False' similar to pydal/py4web/web2py behavior ([`e47cc44`](https://github.com/trialandsuccess/TypeDAL/commit/e47cc442aa7736ba1177bc32a7dc6de58c2551aa))
+
 ## v4.6.0 (2026-03-13)
 
 ### Documentation

{typedal-4.6.0 → typedal-4.6.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypeDAL
-Version: 4.6.0
+Version: 4.6.1
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues

{typedal-4.6.0 → typedal-4.6.1}/docs/8_mixins.md

@@ -56,7 +56,7 @@ or use them with `pydantic.TypeAdapter`.
 Add the mixin to enable `model_dump()` for serialization, including support for relationships and computed properties:
 
 ```python
-from typedal import TypedTable
+from typedal import TypedField, TypedTable
 from typedal.mixins import PydanticMixin
 
 
@@ -67,6 +67,7 @@ class Author(TypedTable, PydanticMixin):
 class Book(TypedTable, PydanticMixin):
     title: str
     author: Author
+    private_notes = TypedField(str, readable=False)
 
     @property
     def display_title(self) -> str:
@@ -79,6 +80,12 @@ book = Book.where(id=1).join("author").first()
 # model_dump() serializes the full object graph
 data = book.model_dump()
 # -> {"id": 1, "title": "...", "author": {"id": 1, "name": "..."}, "display_title": "..."}
+# (private_notes is omitted because readable=False)
+
+# Runtime readability flags are also respected by model_dump()
+Book.title.readable = False
+data = book.model_dump()
+# -> {"id": 1, "author": {"id": 1, "name": "..."}, "display_title": "..."}
 
 # Use mode="json" for JSON-serializable output (dates as ISO strings, etc.)
 data = book.model_dump(mode="json")

{typedal-4.6.0 → typedal-4.6.1}/src/typedal/__about__.py

@@ -5,4 +5,4 @@ This file contains the Version info for this package.
 # SPDX-FileCopyrightText: 2023-present Robin van der Noord <robinvandernoord@gmail.com>
 #
 # SPDX-License-Identifier: MIT
-__version__ = "4.6.0"
+__version__ = "4.6.1"

{typedal-4.6.0 → typedal-4.6.1}/src/typedal/caching.py

@@ -203,6 +203,7 @@ def _remove_cache(s: Set, tablename: str) -> None:
     indeces = s.select("id").column("id")
     remove_cache(indeces, tablename)
 
+
 def get_expire(
     expires_at: t.Optional[dt.datetime] = None,
     ttl: t.Optional[int | dt.timedelta] = None,
@@ -419,6 +420,7 @@ class Stats[T](t.TypedDict):
     valid: T
     expired: T
 
+
 RowStats = t.TypedDict(
     "RowStats",
     {

{typedal-4.6.0 → typedal-4.6.1}/src/typedal/mixins.py

@@ -585,13 +585,18 @@ class PydanticMixin(Mixin):
 
     def model_dump(self, mode: str = "python", *, _shallow: bool = False) -> dict[str, t.Any]:
         """Serialize this model to a dict, with optional shallow nested output."""
-        data = {
-            field_name: getattr(self, field_name, None)
-            for field_name in self._pydantic_fields(
-                include_relationships=not _shallow,
-                include_properties=not _shallow,
-            )
-        }
+        cls = type(self)
+        data: dict[str, t.Any] = {}
+        for field_name in self._pydantic_fields(
+            include_relationships=not _shallow,
+            include_properties=not _shallow,
+        ):
+            # Match web2py/pyDAL behavior: unreadable db fields are excluded from serialized output.
+            model_attr = getattr(cls, field_name, None)
+            if hasattr(model_attr, "readable") and not getattr(model_attr, "readable"):
+                continue
+
+            data[field_name] = getattr(self, field_name, None)
 
         if mode == "json":
             return dump_pydantic(data, _shallow_nested=True)

{typedal-4.6.0 → typedal-4.6.1}/tests/test_mixins.py

@@ -232,6 +232,11 @@ class PydanticTupleAndLiteralSchema(TypedTable, PydanticMixin):
     status: typing.Literal["draft", "published"]
 
 
+class PydanticHiddenTypedField(TypedTable, PydanticMixin):
+    visible = TypedField(str)
+    hidden = TypedField(str, readable=False)
+
+
 @pytest.fixture
 def pydantic_db():
     db = TypeDAL("sqlite:memory")
@@ -241,6 +246,7 @@ def pydantic_db():
     db.define(PydanticStringRelationship)
     db.define(PydanticGenericResolvedRelationship)
     db.define(PydanticGenericUnresolvedRelationship)
+    db.define(PydanticHiddenTypedField)
     db.define(NonPydanticAuthor)
     yield db
 
@@ -443,6 +449,17 @@ def test_pydantic_fields_include_typedfield_and_skip_no_getter_property(pydantic
     assert "empty_prop" not in property_fields
 
 
+def test_pydantic_skips_unreadable_typedfield_in_model_dump(pydantic_db):
+    row = PydanticHiddenTypedField.insert(visible="show", hidden="hide")
+    data = row.model_dump()
+    assert data == {"id": row.id, "visible": "show"}
+
+    PydanticHiddenTypedField.visible.readable = False
+    row = PydanticHiddenTypedField.insert(visible="show-2", hidden="hide-2")
+    data = row.model_dump()
+    assert data == {"id": row.id}
+
+
 def test_pydantic_compatibility_non_type_and_missing_relationship_type():
     # ForwardRef is not a runtime type; this should be a no-op, not a crash.
     PydanticMixin._ensure_pydantic_compatible_type("x", typing.ForwardRef("Anything"))