TypeDAL 2.3.0__py3-none-any.whl → 2.3.2__py3-none-any.whl

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__ = "2.3.0"
+__version__ = "2.3.2"

typedal/core.py

@@ -39,6 +39,7 @@ from .helpers import (
     to_snake,
     unwrap_type,
 )
+from .serializers import as_json
 from .types import (
     AfterDeleteCallable,
     AfterInsertCallable,
@@ -485,7 +486,9 @@ class TypeDAL(pydal.DAL):  # type: ignore
         # ! dont' use full_dict here:
         other_kwargs = kwargs | {
             k: v for k, v in cls.__dict__.items() if k not in annotations and not k.startswith("_")
-        }
+        }  # other_kwargs was previously used to pass kwargs to typedal, but use @define(**kwargs) for that.
+        #    now it's only used to extract relationships from the object.
+        #    other properties of the class (incl methods) should not be touched
 
         for key in typedfields.keys() - full_dict.keys():
             # typed fields that don't haven't been added to the object yet
@@ -512,9 +515,9 @@ class TypeDAL(pydal.DAL):  # type: ignore
             if k not in relationships and (new_relationship := to_relationship(cls, k, annotations[k]))
         }
 
-        cache_dependency = other_kwargs.pop("cache_dependency", True)
+        cache_dependency = kwargs.pop("cache_dependency", True)
 
-        table: Table = self.define_table(tablename, *fields.values(), **other_kwargs)
+        table: Table = self.define_table(tablename, *fields.values(), **kwargs)
 
         for name, typed_field in typedfields.items():
             field = fields[name]
@@ -1495,7 +1498,7 @@ class TypedTable(metaclass=TableMeta):
         return typing.cast(dict[str, Any], result)
 
     @classmethod
-    def as_json(cls, sanitize: bool = True) -> str:
+    def as_json(cls, sanitize: bool = True, indent: Optional[int] = None, **kwargs: Any) -> str:
         """
         Dump the object to json.
 
@@ -1503,8 +1506,8 @@ class TypedTable(metaclass=TableMeta):
         - dumps the table info if it's a class
         - dumps the row info if it's an instance (see _as_json)
         """
-        table = cls._ensure_table_defined()
-        return typing.cast(str, table.as_json(sanitize))
+        data = cls.as_dict(sanitize=sanitize)
+        return as_json.encode(data, indent=indent, **kwargs)
 
     @classmethod
     def as_xml(cls, sanitize: bool = True) -> str:  # pragma: no cover
@@ -1534,15 +1537,25 @@ class TypedTable(metaclass=TableMeta):
         self, datetime_to_str: bool = False, custom_types: typing.Iterable[type] | type | None = None
     ) -> dict[str, Any]:
         row = self._ensure_matching_row()
+
         result = row.as_dict(datetime_to_str=datetime_to_str, custom_types=custom_types)
 
+        def asdict_method(obj: Any) -> Any:  # pragma: no cover
+            if hasattr(obj, "_as_dict"):  # typedal
+                return obj._as_dict()
+            elif hasattr(obj, "as_dict"):  # pydal
+                return obj.as_dict()
+            else:  # something else??
+                return obj.__dict__
+
         if _with := getattr(self, "_with", None):
             for relationship in _with:
                 data = self.get(relationship)
+
                 if isinstance(data, list):
-                    data = [_.as_dict() if getattr(_, "as_dict", None) else _ for _ in data]
+                    data = [asdict_method(_) for _ in data]
                 elif data:
-                    data = data.as_dict()
+                    data = asdict_method(data)
 
                 result[relationship] = data
 
@@ -1550,14 +1563,12 @@ class TypedTable(metaclass=TableMeta):
 
     def _as_json(
         self,
-        mode: str = "object",
         default: typing.Callable[[Any], Any] = None,
-        colnames: list[str] = None,
-        serialize: bool = True,
+        indent: Optional[int] = None,
         **kwargs: Any,
     ) -> str:
-        row = self._ensure_matching_row()
-        return typing.cast(str, row.as_json(mode, default, colnames, serialize, *kwargs))
+        data = self._as_dict()
+        return as_json.encode(data, default=default, indent=indent, **kwargs)
 
     def _as_xml(self, sanitize: bool = True) -> str:  # pragma: no cover
         row = self._ensure_matching_row()
@@ -1635,14 +1646,6 @@ class TypedTable(metaclass=TableMeta):
     # __del__ is also called on the end of a scope so don't remove records on every del!!
 
     # pickling:
-    def __setstate__(self, state: dict[str, Any]) -> None:
-        """
-        Used by dill when loading from a bytestring.
-        """
-        # as_dict also includes table info, so dump as json to only get the actual row data
-        # then create a new (more empty) row object:
-        state["_row"] = Row(json.loads(state["_row"]))
-        self.__dict__ |= state
 
     def __getstate__(self) -> dict[str, Any]:
         """
@@ -1655,6 +1658,7 @@ class TypedTable(metaclass=TableMeta):
         result: dict[str, Any] = row.as_dict()
 
         if _with := getattr(self, "_with", None):
+            result["_with"] = _with
             for relationship in _with:
                 data = self.get(relationship)
 
@@ -1663,6 +1667,15 @@ class TypedTable(metaclass=TableMeta):
         result["_row"] = self._row.as_json() if self._row else ""
         return result
 
+    def __setstate__(self, state: dict[str, Any]) -> None:
+        """
+        Used by dill when loading from a bytestring.
+        """
+        # as_dict also includes table info, so dump as json to only get the actual row data
+        # then create a new (more empty) row object:
+        state["_row"] = Row(json.loads(state["_row"]))
+        self.__dict__ |= state
+
 
 # backwards compat:
 TypedRow = TypedTable
@@ -1862,17 +1875,19 @@ class TypedRows(typing.Collection[T_MetaInstance], Rows):
 
         return {k: v.as_dict() for k, v in self.records.items()}
 
-    def as_json(self, mode: str = "object", default: typing.Callable[[Any], Any] = None) -> str:
+    def as_json(self, default: typing.Callable[[Any], Any] = None, indent: Optional[int] = None, **kwargs: Any) -> str:
         """
         Turn the data into a dict and then dump to JSON.
         """
-        return typing.cast(str, super().as_json(mode=mode, default=default))
+        data = self.as_list()
+
+        return as_json.encode(data, default=default, indent=indent, **kwargs)
 
-    def json(self, mode: str = "object", default: typing.Callable[[Any], Any] = None) -> str:
+    def json(self, default: typing.Callable[[Any], Any] = None, indent: Optional[int] = None, **kwargs: Any) -> str:
         """
         Turn the data into a dict and then dump to JSON.
         """
-        return typing.cast(str, super().as_json(mode=mode, default=default))
+        return self.as_json(default=default, indent=indent, **kwargs)
 
     def as_list(
         self,
@@ -1888,6 +1903,7 @@ class TypedRows(typing.Collection[T_MetaInstance], Rows):
             return typing.cast(
                 list[dict[str, Any]], super().as_list(compact, storage_to_dict, datetime_to_str, custom_types)
             )
+
         return [_.as_dict() for _ in self.records.values()]
 
     def __getitem__(self, item: int) -> T_MetaInstance:

typedal/serializers/as_json.py

@@ -0,0 +1,42 @@
+"""
+Replacement for pydal's json serializer.
+"""
+
+import datetime as dt
+import json
+from json import JSONEncoder
+from typing import Any
+
+
+class SerializedJson(JSONEncoder):
+    """
+    Custom encoder class with slightly improved defaults.
+    """
+
+    def default(self, o: Any) -> Any:
+        """
+        If no logic exists for a type yet, it is processed by this method.
+
+        It supports sets (turned into list), __json__ methods and will just str() otherwise.
+        """
+        if isinstance(o, set):
+            return list(o)
+        elif isinstance(o, dt.date):
+            return str(o)
+        elif hasattr(o, "__json__"):
+            if callable(o.__json__):
+                return o.__json__()
+            else:
+                return o.__json__
+        elif hasattr(o, "__dict__"):
+            return o.__dict__
+        else:
+            # warnings.warn(f"Unkown type {type(o)}")
+            return str(o)
+
+
+def encode(something: Any, indent: int = None, **kw: Any) -> str:
+    """
+    Encode anything to JSON with some improved defaults.
+    """
+    return json.dumps(something, indent=indent, cls=SerializedJson, **kw)

{typedal-2.3.0.dist-info → typedal-2.3.2.dist-info}/METADATA

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

{typedal-2.3.0.dist-info → typedal-2.3.2.dist-info}/RECORD

@@ -1,15 +1,16 @@
-typedal/__about__.py,sha256=PmuJ59D6ihUaOnWSryXIFc6p-q-9F-kjIa_42zL1oLs,206
+typedal/__about__.py,sha256=6-cBVRoxdWtgxVEjZ7nYfLXipTL1o9Jjywbqts994pk,206
 typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
 typedal/caching.py,sha256=cglkCphbg93Iy9-KHefQN9-JJxuA5-HjpzZAdw2BGvY,7709
 typedal/cli.py,sha256=F7M9D2pu2D-FoKZJrT3K9Wmbv5_ScUR8j5jNGoTgOfk,11800
 typedal/config.py,sha256=oDYSuPMm261hBoDBAXoq37Umf1Vw8rNx4BlP35WwCSY,11882
-typedal/core.py,sha256=B4GZMHE3PEP2fOPT97UOz0nIFJU5y3cc8BGcJWVaphI,94750
+typedal/core.py,sha256=wARmyKpwm-3ZGrt2ZdOUfBqfqbrWf_DgqWmaqAdmIow,95392
 typedal/fields.py,sha256=z2PD9vLWqBR_zXtiY0DthqTG4AeF3yxKoeuVfGXnSdg,5197
 typedal/for_py4web.py,sha256=kw44_55-dBWlYmepB7YEev5sj7tbYcgzvp-Ecc7K9_I,2230
 typedal/helpers.py,sha256=ZpHdwBMSANw-P9I5gs56Vf6GUbxGzFsIwbBvASKXX8s,6487
 typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 typedal/types.py,sha256=5qm3PgS8DXGCu9ZTUWQiIi2XXD8gz4_4Csg_vZlu_yo,3379
-typedal-2.3.0.dist-info/METADATA,sha256=5kiRyeukicOHgBdmfz-83VYEdXKkv4jHX8D_0jCPp2A,7623
-typedal-2.3.0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-typedal-2.3.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-2.3.0.dist-info/RECORD,,
+typedal/serializers/as_json.py,sha256=2sWSiU3yecPMhE-1jman227oLSfvSY-Iw-gbg3PnCKk,1138
+typedal-2.3.2.dist-info/METADATA,sha256=uMe7GkSU2AyP23eFObW278v5dUdN4yit7fsi-nvhu9w,7623
+typedal-2.3.2.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
+typedal-2.3.2.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-2.3.2.dist-info/RECORD,,