TypeDAL 3.4.0__py3-none-any.whl → 3.6.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.4.0"
+__version__ = "3.6.0"

typedal/cli.py

@@ -40,7 +40,7 @@ from pydal2sql.types import (
     OutputFormat_Option,
     Tables_Option,
 )
-from pydal2sql_core import core_alter, core_create
+from pydal2sql_core import core_alter, core_create, core_stub
 from typing_extensions import Never
 
 from . import caching
@@ -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})
@@ -417,6 +417,38 @@ def fake_migrations(
     return 0
 
 
+@app.command(name="migrations.stub")
+@with_exit_code(hide_tb=IS_DEBUG)
+def migrations_stub(
+    migration_name: typing.Annotated[str, typer.Argument()] = "stub_migration",
+    connection: typing.Annotated[str, typer.Option("--connection", "-c")] = None,
+    output_format: OutputFormat_Option = None,
+    output_file: Optional[str] = None,
+    dry_run: typing.Annotated[bool, typer.Option("--dry", "--dry-run")] = False,
+    is_pydal: typing.Annotated[bool, typer.Option("--pydal", "-p")] = False,
+    # defaults to is_typedal of course
+) -> int:
+    """
+    Create an empty migration via pydal2sql.
+    """
+    generic_config = load_config(connection)
+    pydal2sql_config = generic_config.to_pydal2sql()
+    pydal2sql_config.update(
+        format=output_format,
+        output=output_file,
+        _skip_none=True,
+    )
+
+    core_stub(
+        migration_name,  # raw, without date or number
+        output_format=pydal2sql_config.format,
+        output_file=pydal2sql_config.output or None,
+        dry_run=dry_run,
+        is_typedal=not is_pydal,
+    )
+    return 0
+
+
 AnyNestedDict: typing.TypeAlias = dict[str, AnyDict]
 
 

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:

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
@@ -105,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.4.0.dist-info → typedal-3.6.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: TypeDAL
-Version: 3.4.0
+Version: 3.6.0
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues
@@ -23,7 +23,7 @@ Requires-Dist: python-slugify
 Provides-Extra: all
 Requires-Dist: edwh-migrate>=0.8.0; extra == 'all'
 Requires-Dist: py4web; extra == 'all'
-Requires-Dist: pydal2sql[all]>=1.1.4; extra == 'all'
+Requires-Dist: pydal2sql[all]>=1.2.0; extra == 'all'
 Requires-Dist: questionary; extra == 'all'
 Requires-Dist: tabulate; extra == 'all'
 Requires-Dist: tomlkit; extra == 'all'
@@ -43,7 +43,7 @@ Requires-Dist: types-requests; extra == 'dev'
 Requires-Dist: types-tabulate; extra == 'dev'
 Provides-Extra: migrations
 Requires-Dist: edwh-migrate>=0.8.0; extra == 'migrations'
-Requires-Dist: pydal2sql>=1.1.4; extra == 'migrations'
+Requires-Dist: pydal2sql>=1.2.0; extra == 'migrations'
 Requires-Dist: questionary; extra == 'migrations'
 Requires-Dist: tabulate; extra == 'migrations'
 Requires-Dist: tomlkit; extra == 'migrations'

{typedal-3.4.0.dist-info → typedal-3.6.0.dist-info}/RECORD

@@ -1,19 +1,19 @@
-typedal/__about__.py,sha256=4H4aYxAonMoSZ4TwJQKsDojr3VmwSW8DHN3jahxVVsA,206
+typedal/__about__.py,sha256=6BHlKIfFsDoanUXT6U-wyOOCusiaMl22UUFAVmE4Clg,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=wzyId6YwRyqfuJ2byxvl6YecDNaKpkLmo-R5HvRuTok,19265
 typedal/config.py,sha256=0qy1zrTUdtmXPM9jHzFnSR1DJsqGJqcdG6pvhzKQHe0,11625
-typedal/core.py,sha256=b8pFiaORXEC0PWaBSmPkQuPtJfk0mwqUiAqxSmX4ZtM,96318
+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=fyTOAhORFufZsAKnf1dMcWJxLK-UMX6UFl-JbiqFmSk,5161
+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.4.0.dist-info/METADATA,sha256=onWL5IwfJALWrdfIPUQNYrmFdIcMNZqRAlGixK88Tv0,9462
-typedal-3.4.0.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-typedal-3.4.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.4.0.dist-info/RECORD,,
+typedal-3.6.0.dist-info/METADATA,sha256=yZpPjMmR24Kzh0QRmMrTihEHGNCJFgX4NtyfOIqMf-A,9462
+typedal-3.6.0.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+typedal-3.6.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-3.6.0.dist-info/RECORD,,

{typedal-3.4.0.dist-info → typedal-3.6.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.17.1
+Generator: hatchling 1.25.0
 Root-Is-Purelib: true
 Tag: py3-none-any