TypeDAL 3.17.2__py3-none-any.whl → 4.0.0__py3-none-any.whl

typedal/types.py

@@ -2,10 +2,18 @@
 Stuff to make mypy happy.
 """
 
-import typing
-from datetime import datetime
-from typing import Any, Callable, Optional, TypedDict
+# ---------------------------------------------------------------------------
+# Imports
+# ---------------------------------------------------------------------------
 
+# Standard library
+import datetime as dt
+import types
+import typing as t
+
+import pydal.objects
+
+# Third-party
 from pydal.adapters.base import BaseAdapter
 from pydal.helpers.classes import OpRow as _OpRow
 from pydal.helpers.classes import Reference as _Reference
@@ -13,126 +21,157 @@ from pydal.helpers.classes import SQLCustomType
 from pydal.objects import Expression as _Expression
 from pydal.objects import Field as _Field
 from pydal.objects import Query as _Query
+from pydal.objects import Row as _Row
 from pydal.objects import Rows as _Rows
 from pydal.objects import Set as _Set
 from pydal.objects import Table as _Table
 from pydal.validators import Validator as _Validator
-from typing_extensions import NotRequired
 
-if typing.TYPE_CHECKING:
-    from .core import TypedField
+try:
+    from string.templatelib import Template
+except ImportError:
+    Template: t.TypeAlias = str  # type: ignore
 
-AnyDict: typing.TypeAlias = dict[str, Any]
+# Internal references
+if t.TYPE_CHECKING:
+    from .fields import TypedField
+    from .tables import TypedTable
 
+# ---------------------------------------------------------------------------
+# Aliases
+# ---------------------------------------------------------------------------
 
-class Query(_Query):  # type: ignore
-    """
-    Pydal Query object.
+AnyCallable: t.TypeAlias = t.Callable[..., t.Any]
+AnyDict: t.TypeAlias = dict[str, t.Any]
 
-    Makes mypy happy.
-    """
 
+# ---------------------------------------------------------------------------
+# Protocols
+# ---------------------------------------------------------------------------
 
-class Expression(_Expression):  # type: ignore
-    """
-    Pydal Expression object.
 
-    Make mypy happy.
-    """
+class TableProtocol(t.Protocol):  # pragma: no cover
+    """Protocol to make mypy happy for Tables."""
 
+    id: "TypedField[int]"
+
+    def __getitem__(self, item: str) -> "Field":
+        """
+        Tables have table[field] syntax.
+        """
 
-class Set(_Set):  # type: ignore
-    """
-    Pydal Set object.
 
-    Make mypy happy.
+class CacheFn(t.Protocol):
     """
+    The cache model (e.g. cache.ram) accepts these parameters (all filled by default).
+    """
+
+    def __call__(
+        self: BaseAdapter,
+        sql: str = "",
+        fields: t.Iterable[str] = (),
+        attributes: t.Iterable[str] = (),
+        colnames: t.Iterable[str] = (),
+    ) -> "Rows":
+        """Signature for calling this object."""
+
+
+class FileSystemLike(t.Protocol):  # pragma: no cover
+    """Protocol for any class that has an 'open' function (e.g. OSFS)."""
+
+    def open(self, file: str, mode: str = "r") -> t.IO[t.Any]:
+        """We assume every object with an open function this shape, is basically a file."""
+
+
+# ---------------------------------------------------------------------------
+# pydal Wrappers (to help mypy understand these classes)
+# ---------------------------------------------------------------------------
+
+
+class Query(_Query):  # type: ignore
+    """Pydal Query object. Makes mypy happy."""
+
+
+class Expression(_Expression):  # type: ignore
+    """Pydal Expression object. Make mypy happy."""
+
+
+class Set(_Set):  # type: ignore
+    """Pydal Set object. Make mypy happy."""
 
 
-if typing.TYPE_CHECKING:
+if t.TYPE_CHECKING:
 
     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 __getitem__(self, item: str) -> t.Any:
+            """row.item syntax."""
 
-        def __setitem__(self, key: str, value: typing.Any) -> None:
-            """
-            Dict [] set notation.
-            """
+        def __setitem__(self, key: str, value: t.Any) -> None:
+            """row.item = key syntax."""
 
-        # ... and more methods
+        # more methods could be added
 
 else:
 
     class OpRow(_OpRow):  # type: ignore
-        """
-        Pydal OpRow object at runtime just uses pydal's version.
-
-        Make mypy happy.
-        """
+        """Runtime OpRow, using pydal's version."""
 
 
 class Reference(_Reference):  # type: ignore
-    """
-    Pydal Reference object.
-
-    Make mypy happy.
-    """
+    """Pydal Reference object. Make mypy happy."""
 
 
 class Field(_Field):  # type: ignore
-    """
-    Pydal Field object.
-
-    Make mypy happy.
-    """
+    """Pydal Field object. Make mypy happy."""
 
 
 class Rows(_Rows):  # type: ignore
-    """
-    Pydal Rows object.
-
-    Make mypy happy.
-    """
+    """Pydal Rows object. Make mypy happy."""
 
-    def column(self, column: typing.Any = None) -> list[typing.Any]:
+    def column(self, column: t.Any = None) -> list[t.Any]:
         """
         Get a list of all values in a specific column.
 
         Example:
-                rows.column('name') -> ['Name 1', 'Name 2', ...]
+            rows.column('name') -> ['Name 1', 'Name 2', ...]
         """
         return [r[str(column) if column else self.colnames[0]] for r in self]
 
 
+class Row(_Row):
+    """Pydal Row object. Make mypy happy."""
+
+
 class Validator(_Validator):  # type: ignore
-    """
-    Pydal Validator object.
+    """Pydal Validator object. Make mypy happy."""
+
+
+class Table(_Table, TableProtocol):  # type: ignore
+    """Table with protocol support. Make mypy happy."""
 
-    Make mypy happy.
-    """
+
+# ---------------------------------------------------------------------------
+# Utility Types
+# ---------------------------------------------------------------------------
 
 
 class _Types:
-    """
-    Internal type storage for stuff that mypy otherwise won't understand.
-    """
+    """Internal type storage for stuff mypy otherwise won't understand."""
 
     NONETYPE = type(None)
 
 
-class Pagination(TypedDict):
-    """
-    Pagination key of a paginate dict has these items.
-    """
+# ---------------------------------------------------------------------------
+# TypedDicts
+# ---------------------------------------------------------------------------
+
+
+class Pagination(t.TypedDict):
+    """Pagination key of a paginate dict has these items."""
 
     total_items: int
     current_page: int
@@ -140,36 +179,30 @@ class Pagination(TypedDict):
     total_pages: int
     has_next_page: bool
     has_prev_page: bool
-    next_page: Optional[int]
-    prev_page: Optional[int]
+    next_page: t.Optional[int]
+    prev_page: t.Optional[int]
 
 
-class PaginateDict(TypedDict):
-    """
-    Result of PaginatedRows.as_dict().
-    """
+class PaginateDict(t.TypedDict):
+    """Result of PaginatedRows.as_dict()."""
 
     data: dict[int, AnyDict]
     pagination: Pagination
 
 
-class CacheMetadata(TypedDict):
-    """
-    Used by query builder metadata in the 'cache' key.
-    """
+class CacheMetadata(t.TypedDict):
+    """Used by query builder metadata in the 'cache' key."""
 
     enabled: bool
-    depends_on: list[Any]
-    key: NotRequired[str | None]
-    status: NotRequired[str | None]
-    expires_at: NotRequired[datetime | None]
-    cached_at: NotRequired[datetime | None]
+    depends_on: list[t.Any]
+    key: t.NotRequired[str | None]
+    status: t.NotRequired[str | None]
+    expires_at: t.NotRequired[dt.datetime | None]
+    cached_at: t.NotRequired[dt.datetime | None]
 
 
-class PaginationMetadata(TypedDict):
-    """
-    Used by query builder metadata in the 'pagination' key.
-    """
+class PaginationMetadata(t.TypedDict):
+    """Used by query builder metadata in the 'pagination' key."""
 
     limit: int
     current_page: int
@@ -178,101 +211,34 @@ class PaginationMetadata(TypedDict):
     min_max: tuple[int, int]
 
 
-class TableProtocol(typing.Protocol):  # pragma: no cover
-    """
-    Make mypy happy.
-    """
-
-    id: "TypedField[int]"
-
-    def __getitem__(self, item: str) -> Field:
-        """
-        Tell mypy a Table supports dictionary notation for columns.
-        """
-
-
-class Table(_Table, TableProtocol):  # type: ignore
-    """
-    Make mypy happy.
-    """
-
-
-class CacheFn(typing.Protocol):
-    """
-    The cache model (e.g. cache.ram) accepts these parameters (all filled by dfeault).
-    """
-
-    def __call__(
-        self: BaseAdapter,
-        sql: str = "",
-        fields: typing.Iterable[str] = (),
-        attributes: typing.Iterable[str] = (),
-        colnames: typing.Iterable[str] = (),
-    ) -> Rows:
-        """
-        Only used for type-hinting.
-        """
-
-
-# CacheFn = typing.Callable[[], Rows]
-CacheModel = typing.Callable[[str, CacheFn, int], Rows]
-CacheTuple = tuple[CacheModel, int]
-
-OrderBy: typing.TypeAlias = Expression | str
-
+class SelectKwargs(t.TypedDict, total=False):
+    """Possible keyword arguments for .select()."""
 
-class SelectKwargs(TypedDict, total=False):
-    """
-    Possible keyword arguments for .select().
-    """
-
-    join: Optional[list[Expression]]
-    left: Optional[list[Expression]]
-    orderby: OrderBy | typing.Iterable[OrderBy] | None
-    limitby: Optional[tuple[int, int]]
+    join: t.Optional[list[Expression]]
+    left: t.Optional[list[Expression]]
+    orderby: "OrderBy | t.Iterable[OrderBy] | None"
+    limitby: t.Optional[tuple[int, int]]
     distinct: bool | Field | Expression
     orderby_on_limitby: bool
     cacheable: bool
-    cache: CacheTuple
-
-
-class Metadata(TypedDict):
-    """
-    Loosely structured metadata used by Query Builder.
-    """
-
-    cache: NotRequired[CacheMetadata]
-    pagination: NotRequired[PaginationMetadata]
+    cache: "CacheTuple"
 
-    query: NotRequired[Query | str | None]
-    ids: NotRequired[str]
 
-    final_query: NotRequired[Query | str | None]
-    final_args: NotRequired[list[Any]]
-    final_kwargs: NotRequired[SelectKwargs]
-    relationships: NotRequired[set[str]]
+class Metadata(t.TypedDict):
+    """Loosely structured metadata used by Query Builder."""
 
-    sql: NotRequired[str]
+    cache: t.NotRequired[CacheMetadata]
+    pagination: t.NotRequired[PaginationMetadata]
+    query: t.NotRequired[Query | str | None]
+    ids: t.NotRequired[str]
+    final_query: t.NotRequired[Query | str | None]
+    final_args: t.NotRequired[list[t.Any]]
+    final_kwargs: t.NotRequired[SelectKwargs]
+    relationships: t.NotRequired[set[str]]
+    sql: t.NotRequired[str]
 
 
-class FileSystemLike(typing.Protocol):  # pragma: no cover
-    """
-    Protocol for any class that has an 'open' function.
-
-    An example of this is OSFS from PyFilesystem2.
-    """
-
-    def open(self, file: str, mode: str = "r") -> typing.IO[typing.Any]:
-        """
-        Opens a file for reading, writing or other modes.
-        """
-        ...
-
-
-AnyCallable: typing.TypeAlias = Callable[..., Any]
-
-
-class FieldSettings(TypedDict, total=False):
+class FieldSettings(t.TypedDict, total=False):
     """
     The supported keyword arguments for `pydal.Field()`.
 
@@ -281,9 +247,9 @@ class FieldSettings(TypedDict, total=False):
 
     type: str | type | SQLCustomType
     length: int
-    default: Any
+    default: t.Any
     required: bool
-    requires: list[AnyCallable | Any | Validator] | Validator | AnyCallable
+    requires: list[AnyCallable | t.Any | Validator] | Validator | AnyCallable
     ondelete: str
     onupdate: str
     notnull: bool
@@ -297,8 +263,8 @@ class FieldSettings(TypedDict, total=False):
     searchable: bool
     listable: bool
     regex: str
-    options: list[Any] | AnyCallable
-    update: Any
+    options: list[t.Any] | AnyCallable
+    update: t.Any
     authorize: AnyCallable
     autodelete: bool
     represent: AnyCallable
@@ -312,6 +278,46 @@ class FieldSettings(TypedDict, total=False):
     custom_delete: AnyCallable
     filter_in: AnyCallable
     filter_out: AnyCallable
-    custom_qualifier: Any
-    map_none: Any
+    custom_qualifier: t.Any
+    map_none: t.Any
     rname: str
+
+
+# ---------------------------------------------------------------------------
+# Generics & Query Helpers
+# ---------------------------------------------------------------------------
+
+T = t.TypeVar("T", bound=t.Any)
+P = t.ParamSpec("P")
+R = t.TypeVar("R")
+
+T_MetaInstance = t.TypeVar("T_MetaInstance", bound="TypedTable")
+T_Query = t.Union[
+    "Table",
+    Query,
+    bool,
+    None,
+    "TypedTable",
+    t.Type["TypedTable"],
+    Expression,
+]
+
+T_subclass = t.TypeVar("T_subclass", "TypedTable", Table)
+T_Field: t.TypeAlias = t.Union["TypedField[t.Any]", "Table", t.Type["TypedTable"]]
+
+# use typing.cast(type, ...) to make mypy happy with unions
+T_Value = t.TypeVar("T_Value")  # actual type of the Field (via Generic)
+
+# table-ish parameter:
+P_Table = t.Union[t.Type["TypedTable"], pydal.objects.Table]
+
+Condition: t.TypeAlias = t.Optional[t.Callable[[P_Table, P_Table], Query | bool]]
+
+OnQuery: t.TypeAlias = t.Optional[t.Callable[[P_Table, P_Table], list[Expression]]]
+
+CacheModel = t.Callable[[str, CacheFn, int], Rows]
+CacheTuple = tuple[CacheModel, int]
+
+OrderBy: t.TypeAlias = str | Expression
+
+T_annotation = t.Type[t.Any] | types.UnionType

typedal/web2py_py4web_shared.py

@@ -6,7 +6,7 @@ import datetime as dt
 
 from pydal.validators import CRYPT, IS_EMAIL, IS_NOT_EMPTY, IS_NOT_IN_DB, IS_STRONG
 
-from .core import TypeDAL, TypedField, TypedTable
+from . import TypeDAL, TypedField, TypedTable
 from .fields import PasswordField
 
 

{typedal-3.17.2.dist-info → typedal-4.0.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: TypeDAL
-Version: 3.17.2
+Version: 4.0.0
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues
@@ -8,18 +8,19 @@ Project-URL: Source, https://github.com/trialandsuccess/TypeDAL
 Author-email: Robin van der Noord <contact@trialandsuccess.nl>
 Classifier: Development Status :: 4 - Beta
 Classifier: Programming Language :: Python
-Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Programming Language :: Python :: Implementation :: CPython
 Classifier: Programming Language :: Python :: Implementation :: PyPy
-Requires-Python: >=3.10
+Requires-Python: >=3.11
 Requires-Dist: configurable-json<2
-Requires-Dist: configuraptor<2,>=1.26.2
+Requires-Dist: configuraptor<2,>=1.27.1
 Requires-Dist: dill<1
 Requires-Dist: legacy-cgi; python_version >= '3.13'
-Requires-Dist: pydal<=20250228.1
+Requires-Dist: pydal>=20251012.3
+Requires-Dist: python-dateutil<3
 Requires-Dist: python-slugify<9
 Provides-Extra: all
 Requires-Dist: edwh-migrate[full]>=0.8.0; extra == 'all'
@@ -28,7 +29,7 @@ Requires-Dist: pydal2sql[all]>=1.2.0; extra == 'all'
 Requires-Dist: questionary; extra == 'all'
 Requires-Dist: tabulate; extra == 'all'
 Requires-Dist: tomlkit; extra == 'all'
-Requires-Dist: typer; extra == 'all'
+Requires-Dist: typer<0.19,>=0.18; extra == 'all'
 Provides-Extra: dev
 Requires-Dist: contextlib-chdir; extra == 'dev'
 Requires-Dist: hatch; extra == 'dev'
@@ -48,7 +49,7 @@ Requires-Dist: pydal2sql>=1.2.0; extra == 'migrations'
 Requires-Dist: questionary; extra == 'migrations'
 Requires-Dist: tabulate; extra == 'migrations'
 Requires-Dist: tomlkit; extra == 'migrations'
-Requires-Dist: typer; extra == 'migrations'
+Requires-Dist: typer<0.19,>=0.18; extra == 'migrations'
 Provides-Extra: py4web
 Requires-Dist: py4web; extra == 'py4web'
 Description-Content-Type: text/markdown

typedal-4.0.0.dist-info/RECORD

@@ -0,0 +1,25 @@
+typedal/__about__.py,sha256=ktbRL0vibHktfZfFr8_laZbodaGwgv9JUaEjGT6aNT0,206
+typedal/__init__.py,sha256=RtdS7NRPB5LHHxRxq2r_48eXTrkTpEuqIvAEwSQKxuA,612
+typedal/caching.py,sha256=6QaPmqmRaUDjRUySjA1CwrA36TFZ50d5g5Rw-i7GQjg,11795
+typedal/cli.py,sha256=e08L8k6q1NGSzpKs7ywin0uwkK7Kz07I4REVjHdbyyE,19267
+typedal/config.py,sha256=9ZgPe5aYELMpiNwO8AFZpG2pLKcBPu_DKyWn6470PPs,11602
+typedal/constants.py,sha256=ahmryNsTBZVW0sHq8WbkZKQytWVZSIAZjZbZdod0iHY,489
+typedal/core.py,sha256=bFwCNEN36KaW99O86_uiWzLsWbZoPtw3hRwtOfwZfqk,15181
+typedal/define.py,sha256=v6mnnNrXuG4Fd-LnBgq7tETvWMYm1LH5_alS-rFfFvY,6946
+typedal/fields.py,sha256=4JQq-FXPMToMDpDFa2yuf1_I2V66tQ_f8bJpV23DtMU,15923
+typedal/for_py4web.py,sha256=KIIu8XgnAfRQCJfZCra79k8SInOHiFuLDKUv3hzTJng,1908
+typedal/for_web2py.py,sha256=Bvgicr19KNwjp1P_t9K1EmhaM3EfowPQyomUaO-2Wmo,1925
+typedal/helpers.py,sha256=kycTMZxT-H3AzPzLo67SgUZIS4PXtwTQ7RGRepSAP1g,19916
+typedal/mixins.py,sha256=V-l9eZtyIBocSKYQ-yk3oyHVk63F5XdzQe_OGspaviY,7910
+typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+typedal/query_builder.py,sha256=SHfRAFTexUa3YE1oSmat3xXwkYbzRKFlvt69KaNG-TA,39287
+typedal/relationships.py,sha256=l3iRthxkBxc4KaNhjE69UOhPq-OOEPUme1W4ofKFgM8,8897
+typedal/rows.py,sha256=xWFC-p-1AGI-uoYBoNNtaC35dDxqvBTw3DT5VH957iA,16369
+typedal/tables.py,sha256=Cc16DbQWxuVUNNnz5xZCt3h35TWJYTz1cjerQvIJj1o,36678
+typedal/types.py,sha256=_njB7W67MrMfeEWzNz-EMxm2DtE_H8rN__zrPx4Jepo,8710
+typedal/web2py_py4web_shared.py,sha256=jsDjC_K0P27od4B80q83nKJiL2KAgmzS-QpHChv0RjU,1535
+typedal/serializers/as_json.py,sha256=pdeFoQF5kouGonJC6z6JNe61XRsIMlQ94SRBJDKG_Ng,2219
+typedal-4.0.0.dist-info/METADATA,sha256=jfKWF11r3Xs5e54TJTD263LowlY245Uio1jqy92PPpQ,10517
+typedal-4.0.0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+typedal-4.0.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-4.0.0.dist-info/RECORD,,

typedal-3.17.2.dist-info/RECORD

@@ -1,19 +0,0 @@
-typedal/__about__.py,sha256=8QxLmIYG_8pjN9osMaqR9cgfFChPa8chMgVGeo0Jc4k,207
-typedal/__init__.py,sha256=mCU8C3xPYiGcai4PYIoZNJSkFa1jb0MHkV8s2XXqEeY,484
-typedal/caching.py,sha256=6YUzUMpan56nSy3D-Jl0FS-8V4LbTnpRSoDJHj6yPYo,11782
-typedal/cli.py,sha256=e08L8k6q1NGSzpKs7ywin0uwkK7Kz07I4REVjHdbyyE,19267
-typedal/config.py,sha256=0qy1zrTUdtmXPM9jHzFnSR1DJsqGJqcdG6pvhzKQHe0,11625
-typedal/core.py,sha256=P2mi-j3YLw135iTbTRMKlx8_9EhxcWjmrH15qisBKpU,118519
-typedal/fields.py,sha256=bZIgjl3Lj7eMqFCyt-bogsS_BqIs3cETEUH4W59qiXw,8425
-typedal/for_py4web.py,sha256=KIIu8XgnAfRQCJfZCra79k8SInOHiFuLDKUv3hzTJng,1908
-typedal/for_web2py.py,sha256=xn7zo6ImsmTkH6LacbjLQl2oqyBvP0zLqRxEJvMQk1w,1929
-typedal/helpers.py,sha256=fvej53MqWG1n78-uTuxUEfLDpKrXJDOaIysogBFT3ns,11298
-typedal/mixins.py,sha256=NiGp-3Lr1lllWjP-whUhc_2HXwCS_ROB0bs5N_s9wk4,7976
-typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-typedal/types.py,sha256=P5O0WMADoNm6eDBQZUs9eTK4Puzqz5ZDCFofCIl84Cg,6805
-typedal/web2py_py4web_shared.py,sha256=UYmD0_aK1bSVBt_f3j59Mxq-zOmQNkYkb8sPDUibq68,1539
-typedal/serializers/as_json.py,sha256=3JZlFhPrdvZVFAmH7P5DUAz8-TIk-br0F1CjKG3PFDM,2246
-typedal-3.17.2.dist-info/METADATA,sha256=GyezlYlNCyUG9Iw8fXLc8xo4e3LmAKho_FIVLNx1abc,10461
-typedal-3.17.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-typedal-3.17.2.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.17.2.dist-info/RECORD,,