TypeDAL 3.3.1__py3-none-any.whl → 3.5.0__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__ = "3.3.1"
+__version__ = "3.5.0"

typedal/cli.py

@@ -122,7 +122,7 @@ def get_question(prop: str, annotation: typing.Type[T], default: T | None) -> Op
     question["message"] = question.get("message", f"{prop}? ")
     default = typing.cast(T, default or question.get("default") or "")
 
-    if annotation == int:
+    if annotation is int:
         default = typing.cast(T, str(default))
 
     response = questionary.unsafe_prompt([question], default=default)[prop]
@@ -197,9 +197,9 @@ def setup(
         if isinstance(answer, str):
             answer = answer.strip()
 
-        if annotation == bool:
+        if annotation is bool:
             answer = bool(answer)
-        elif annotation == int:
+        elif annotation is int:
             answer = int(answer)
 
         config.update(**{prop: answer})

typedal/core.py

@@ -43,22 +43,19 @@ from .helpers import (
 )
 from .serializers import as_json
 from .types import (
-    AfterDeleteCallable,
-    AfterInsertCallable,
-    AfterUpdateCallable,
     AnyDict,
-    BeforeDeleteCallable,
-    BeforeInsertCallable,
-    BeforeUpdateCallable,
     CacheMetadata,
     Expression,
     Field,
     Metadata,
+    OpRow,
     PaginateDict,
     Pagination,
     Query,
+    Reference,
     Rows,
     SelectKwargs,
+    Set,
     Table,
     Validator,
     _Types,
@@ -286,7 +283,7 @@ def _generate_relationship_condition(
     origin = typing.get_origin(field)
     # else: generic
 
-    if origin == list:
+    if origin is list:
         # field = typing.get_args(field)[0]  # actual field
         # return lambda _self, _other: cls[key].contains(field)
 
@@ -337,7 +334,7 @@ def to_relationship(
         warnings.warn(f"Invalid relationship for {cls.__name__}.{key}: {field}")
         return None
 
-    join = "left" if optional or typing.get_origin(field) == list else "inner"
+    join = "left" if optional or typing.get_origin(field) is list else "inner"
 
     return Relationship(typing.cast(type[TypedTable], field), condition, typing.cast(JOIN_OPTIONS, join))
 
@@ -1139,7 +1136,63 @@ class TableMeta(type):
         table = self._ensure_table_defined()
         return typing.cast(Type[T_MetaInstance], table.with_alias(alias))
 
-    # @typing.dataclass_transform()
+    # hooks:
+    def before_insert(
+        cls: Type[T_MetaInstance],
+        fn: typing.Callable[[T_MetaInstance], Optional[bool]] | typing.Callable[[OpRow], Optional[bool]],
+    ) -> Type[T_MetaInstance]:
+        """
+        Add a before insert hook.
+        """
+        cls._before_insert.append(fn)  # type: ignore
+        return cls
+
+    def after_insert(
+        cls: Type[T_MetaInstance],
+        fn: (
+            typing.Callable[[T_MetaInstance, Reference], Optional[bool]]
+            | typing.Callable[[OpRow, Reference], Optional[bool]]
+        ),
+    ) -> Type[T_MetaInstance]:
+        """
+        Add an after insert hook.
+        """
+        cls._after_insert.append(fn)  # type: ignore
+        return cls
+
+    def before_update(
+        cls: Type[T_MetaInstance],
+        fn: typing.Callable[[Set, T_MetaInstance], Optional[bool]] | typing.Callable[[Set, OpRow], Optional[bool]],
+    ) -> Type[T_MetaInstance]:
+        """
+        Add a before update hook.
+        """
+        cls._before_update.append(fn)  # type: ignore
+        return cls
+
+    def after_update(
+        cls: Type[T_MetaInstance],
+        fn: typing.Callable[[Set, T_MetaInstance], Optional[bool]] | typing.Callable[[Set, OpRow], Optional[bool]],
+    ) -> Type[T_MetaInstance]:
+        """
+        Add an after update hook.
+        """
+        cls._after_update.append(fn)  # type: ignore
+        return cls
+
+    def before_delete(cls: Type[T_MetaInstance], fn: typing.Callable[[Set], Optional[bool]]) -> Type[T_MetaInstance]:
+        """
+        Add a before delete hook.
+        """
+        cls._before_delete.append(fn)
+        return cls
+
+    def after_delete(cls: Type[T_MetaInstance], fn: typing.Callable[[Set], Optional[bool]]) -> Type[T_MetaInstance]:
+        """
+        Add an after delete hook.
+        """
+        cls._after_delete.append(fn)
+        return cls
 
 
 class TypedField(Expression, typing.Generic[T_Value]):  # pragma: no cover
@@ -1334,12 +1387,14 @@ class _TypedTable:
 
     id: "TypedField[int]"
 
-    _before_insert: list[BeforeInsertCallable]
-    _after_insert: list[AfterInsertCallable]
-    _before_update: list[BeforeUpdateCallable]
-    _after_update: list[AfterUpdateCallable]
-    _before_delete: list[BeforeDeleteCallable]
-    _after_delete: list[AfterDeleteCallable]
+    _before_insert: list[typing.Callable[[Self], Optional[bool]] | typing.Callable[[OpRow], Optional[bool]]]
+    _after_insert: list[
+        typing.Callable[[Self, Reference], Optional[bool]] | typing.Callable[[OpRow, Reference], Optional[bool]]
+    ]
+    _before_update: list[typing.Callable[[Set, Self], Optional[bool]] | typing.Callable[[Set, OpRow], Optional[bool]]]
+    _after_update: list[typing.Callable[[Set, Self], Optional[bool]] | typing.Callable[[Set, OpRow], Optional[bool]]]
+    _before_delete: list[typing.Callable[[Set], Optional[bool]]]
+    _after_delete: list[typing.Callable[[Set], Optional[bool]]]
 
     @classmethod
     def __on_define__(cls, db: TypeDAL) -> None:
@@ -1841,15 +1896,6 @@ class TypedRows(typing.Collection[T_MetaInstance], Rows):
         result = super().group_by_value(*fields, **kwargs)
         return typing.cast(dict[T, list[T_MetaInstance]], result)
 
-    def column(self, column: str = None) -> list[Any]:
-        """
-        Get a list of all values in a specific column.
-
-        Example:
-                rows.column('name') -> ['Name 1', 'Name 2', ...]
-        """
-        return typing.cast(list[Any], super().column(column))
-
     def as_csv(self) -> str:
         """
         Dump the data to csv.
@@ -2426,6 +2472,26 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
         # only saves if requested in metadata:
         return save_to_cache(typed_rows, rows)
 
+    @typing.overload
+    def column(self, field: TypedField[T]) -> list[T]:
+        """
+        If a typedfield is passed, the output type can be safely determined.
+        """
+
+    @typing.overload
+    def column(self, field: T) -> list[T]:
+        """
+        Otherwise, the output type is loosely determined (assumes `field: type` or Any).
+        """
+
+    def column(self, field: TypedField[T] | T) -> list[T]:
+        """
+        Get all values in a specific column.
+
+        Shortcut for `.select(field).execute().column(field)`.
+        """
+        return self.select(field).execute().column(field)
+
     def _handle_relationships_pre_select(
         self,
         query: Query,

typedal/types.py

@@ -48,12 +48,35 @@ class Set(_Set):  # type: ignore
     """
 
 
-class OpRow(_OpRow):  # type: ignore
-    """
-    Pydal OpRow object.
+if typing.TYPE_CHECKING:
 
-    Make mypy happy.
-    """
+    class OpRow:
+        """
+        Pydal OpRow object for typing (otherwise mypy thinks it's Any).
+
+        Make mypy happy.
+        """
+
+        def __getitem__(self, item: str) -> typing.Any:
+            """
+            Dict [] get notation.
+            """
+
+        def __setitem__(self, key: str, value: typing.Any) -> None:
+            """
+            Dict [] set notation.
+            """
+
+        # ... and more methods
+
+else:
+
+    class OpRow(_OpRow):  # type: ignore
+        """
+        Pydal OpRow object at runtime just uses pydal's version.
+
+        Make mypy happy.
+        """
 
 
 class Reference(_Reference):  # type: ignore
@@ -79,6 +102,15 @@ class Rows(_Rows):  # type: ignore
     Make mypy happy.
     """
 
+    def column(self, column: typing.Any = None) -> list[typing.Any]:
+        """
+        Get a list of all values in a specific column.
+
+        Example:
+                rows.column('name') -> ['Name 1', 'Name 2', ...]
+        """
+        return [r[str(column) if column else self.colnames[0]] for r in self]
+
 
 class Validator(_Validator):  # type: ignore
     """
@@ -96,14 +128,6 @@ class _Types:
     NONETYPE = type(None)
 
 
-BeforeInsertCallable: typing.TypeAlias = typing.Callable[[OpRow], Any]
-AfterInsertCallable: typing.TypeAlias = typing.Callable[[OpRow, Reference], Any]
-BeforeUpdateCallable: typing.TypeAlias = typing.Callable[[Set, OpRow], Any]
-AfterUpdateCallable: typing.TypeAlias = typing.Callable[[Set, OpRow], Any]
-BeforeDeleteCallable: typing.TypeAlias = typing.Callable[[Set], Any]
-AfterDeleteCallable: typing.TypeAlias = typing.Callable[[Set], Any]
-
-
 class Pagination(TypedDict):
     """
     Pagination key of a paginate dict has these items.

{typedal-3.3.1.dist-info → typedal-3.5.0.dist-info}/METADATA

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

{typedal-3.3.1.dist-info → typedal-3.5.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
-typedal/__about__.py,sha256=Wu5Lv4Jglqs8h2_AjyrHv-m67Gz9cmuGT7s5MPNnAFs,206
+typedal/__about__.py,sha256=AjgocyPCjgkgwSg0cozJLLzDEJz3aZN-Ze0xcPDV5pc,206
 typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
 typedal/caching.py,sha256=SMcJsahLlZ79yykWCveERFx1ZJUNEKhA9SPmCTIuLp8,11798
-typedal/cli.py,sha256=BXXu1w9WRRK9GA82xh_JLvvfpNDFWICXKCAWNg4a3-Y,18180
+typedal/cli.py,sha256=n2TKQGOryck91ByFEcLqwPgh6_kMtoBr3UBIDwU_8n8,18180
 typedal/config.py,sha256=0qy1zrTUdtmXPM9jHzFnSR1DJsqGJqcdG6pvhzKQHe0,11625
-typedal/core.py,sha256=ScUZkDzHGULNTcrW9Jq4Anf4axUfha-CXWmm7SWrn90,95991
+typedal/core.py,sha256=mbNFMv3NJ2QRDuohs03LCGhVVnffsxjsoe-m887U6c8,98367
 typedal/fields.py,sha256=z2PD9vLWqBR_zXtiY0DthqTG4AeF3yxKoeuVfGXnSdg,5197
 typedal/for_py4web.py,sha256=d07b8hL_PvNDUS26Z5fDH2OxWb-IETBuAFPSzrRwm04,1285
 typedal/for_web2py.py,sha256=4RHgzGXgKIO_BYB-7adC5e35u52rX-p1t4tPEz-NK24,1867
 typedal/helpers.py,sha256=KbgP4ZRW7KCroyHwTwdErPqylOX4dsqVnKJeZ5TtTFY,7363
 typedal/mixins.py,sha256=OHhVYLBGTzPSJKgp1uovBs1Y6NJa0d-DxHTOk9LyOXA,5414
 typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-typedal/types.py,sha256=AsUHrAXk058zmdqDbZlpf6sE85ID1Q2vofsGgCXni1s,4851
+typedal/types.py,sha256=W2zsmJSPYbIvhjb5Df_ZANH8riCIJhOOHjI8UCQINls,5239
 typedal/web2py_py4web_shared.py,sha256=VK9T8P5UwVLvfNBsY4q79ANcABv-jX76YKADt1Zz_co,1539
 typedal/serializers/as_json.py,sha256=ffo152W-sARYXym4BzwX709rrO2-QwKk2KunWY8RNl4,2229
-typedal-3.3.1.dist-info/METADATA,sha256=8sBC0FTFEy7qE17mgnL5sj06hkl3LQc_tRP8_j2-kbU,9462
-typedal-3.3.1.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-typedal-3.3.1.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.3.1.dist-info/RECORD,,
+typedal-3.5.0.dist-info/METADATA,sha256=pffl-arVDPP0CBg3EcVhlze5mxypyCH-Ds_iZ6sZY6s,9462
+typedal-3.5.0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
+typedal-3.5.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-3.5.0.dist-info/RECORD,,