TypeDAL 5.1.0__tar.gz → 5.1.2__tar.gz

{typedal-5.1.0 → typedal-5.1.2}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: TypeDAL
-Version: 5.1.0
+Version: 5.1.2
 Summary: Typing support for PyDAL
 Keywords: 
 Author: Robin van der Noord

{typedal-5.1.0 → typedal-5.1.2}/pyproject.toml

@@ -6,7 +6,7 @@ build-backend = "uv_build"
 name = "TypeDAL"
 description = "Typing support for PyDAL"
 readme = "README.md"
-version = "5.1.0"
+version = "5.1.2"
 requires-python = ">=3.12"
 license-expression = "MIT"
 keywords = []
@@ -164,7 +164,7 @@ badge = true
 mypy = "--disable-error-code misc"
 
 [tool.black]
-target-version = ["py314"]
+target-version = ["py312"]
 line-length = 120
 extend-exclude = '''
 # A regex preceded with ^/ will apply only to files and directories
@@ -199,7 +199,7 @@ exclude = [
 ]
 
 [tool.ruff]
-target-version = "py314"
+target-version = "py312"
 line-length = 120
 extend-exclude = [
     "*.bak/",

{typedal-5.1.0 → typedal-5.1.2}/pyproject.toml.orig

@@ -6,7 +6,7 @@ build-backend = "uv_build"
 name = "TypeDAL"
 description = 'Typing support for PyDAL'
 readme = "README.md"
-version = "5.1.0"
+version = "5.1.2"
 requires-python = ">=3.12"
 license-expression = "MIT"
 keywords = []
@@ -181,7 +181,7 @@ badge = true
 mypy = "--disable-error-code misc"
 
 [tool.black]
-target-version = ["py314"]
+target-version = ["py312"]
 line-length = 120
 # 'extend-exclude' excludes files or directories in addition to the defaults
 extend-exclude = '''
@@ -229,7 +229,7 @@ strict = true
 exclude = ["venv", ".bak"]
 
 [tool.ruff]
-target-version = "py314"
+target-version = "py312"
 line-length = 120
 
 extend-exclude = ["*.bak/", "venv*/", "tests/", "example_*.py"]

{typedal-5.1.0 → typedal-5.1.2}/src/typedal/cli.py

@@ -227,7 +227,7 @@ def setup(
     data.pop("connection", None)
 
     # ignore any None:
-    old_contents["tool"]["typedal"] = {k: v for k, v in data.items() if v is not None}  # type: ignore
+    old_contents["tool"]["typedal"] = {k: v for k, v in data.items() if v is not None}
 
     with toml_path.open("w") as f:
         tomlkit.dump(old_contents, f)

{typedal-5.1.0 → typedal-5.1.2}/src/typedal/core.py

@@ -34,7 +34,7 @@ from .helpers import (
 from .serializers.typescript import TypedDictRegistry
 
 # noinspection PyUnusedImports
-from .types import CacheStatus, Field, Template
+from .types import CacheStatus, Expression, Field, Template
 
 try:
     # python 3.14+
@@ -46,10 +46,10 @@ except ImportError:  # pragma: no cover
 if t.TYPE_CHECKING:
     from .fields import TypedField
     from .query_builder import QueryBuilder
-    from .types import AnyDict, DefineKwargs, Expression, Rows, Set, T_Query, Table
+    from .types import AnyDict, DefineKwargs, Rows, Set, T_Query, Table
 
 
-def _expression_subclasses() -> t.Iterator[type]:
+def _expression_subclasses() -> t.Iterator[type[Expression]]:
     """
     Yield Expression and every (nested) subclass currently loaded, e.g. Field and TypedField.
     """
@@ -100,7 +100,7 @@ def _purge_dialect_expressions(adapter: t.Any) -> None:
 #  because then they will have different globals and it breaks!
 
 
-def evaluate_forward_reference_312(fw_ref: ForwardRef, namespace: dict[str, type]) -> type:  # pragma: no cover
+def evaluate_forward_reference_312(fw_ref: ForwardRef, namespace: t.Mapping[str, type]) -> type:  # pragma: no cover
     """
     Extract the original type from a forward reference string.
 
@@ -110,13 +110,13 @@ def evaluate_forward_reference_312(fw_ref: ForwardRef, namespace: dict[str, type
         type,
         fw_ref._evaluate(  # ty: ignore[deprecated]
             localns=locals(),
-            globalns=globals() | namespace,
+            globalns=globals() | dict(namespace),
             recursive_guard=frozenset(),
         ),
     )
 
 
-def evaluate_forward_reference_313(fw_ref: ForwardRef, namespace: dict[str, type]) -> type:  # pragma: no cover
+def evaluate_forward_reference_313(fw_ref: ForwardRef, namespace: t.Mapping[str, type]) -> type:  # pragma: no cover
     """
     Extract the original type from a forward reference string.
 
@@ -126,14 +126,14 @@ def evaluate_forward_reference_313(fw_ref: ForwardRef, namespace: dict[str, type
         type,
         fw_ref._evaluate(  # ty: ignore[deprecated]
             localns=locals(),
-            globalns=globals() | namespace,
+            globalns=globals() | dict(namespace),
             recursive_guard=frozenset(),
             type_params=(),  # suggested since 3.13 (warning) and not supported before. Mandatory after 1.15!
         ),
     )
 
 
-def evaluate_forward_reference_314(fw_ref: ForwardRef, namespace: dict[str, type]) -> type:  # pragma: no cover
+def evaluate_forward_reference_314(fw_ref: ForwardRef, namespace: t.Mapping[str, type]) -> type:  # pragma: no cover
     """
     Extract the original type from a forward reference string.
 
@@ -143,7 +143,7 @@ def evaluate_forward_reference_314(fw_ref: ForwardRef, namespace: dict[str, type
         type,
         fw_ref.evaluate(
             locals=locals(),
-            globals=globals() | namespace,
+            globals=globals() | dict(namespace),
             type_params=(),
         ),
     )
@@ -151,7 +151,7 @@ def evaluate_forward_reference_314(fw_ref: ForwardRef, namespace: dict[str, type
 
 def evaluate_forward_reference(
     fw_ref: ForwardRef,
-    namespace: dict[str, type] | None = None,
+    namespace: t.Mapping[str, type] | None = None,
 ) -> type:  # pragma: no cover
     """
     Extract the original type from a forward reference string.
@@ -166,7 +166,7 @@ def evaluate_forward_reference(
         return evaluate_forward_reference_314(fw_ref, namespace=namespace or {})
 
 
-def resolve_annotation_313(ftype: str, namespace: dict[str, type] | None = None) -> type:  # pragma: no cover
+def resolve_annotation_313(ftype: str, namespace: t.Mapping[str, type] | None = None) -> type:  # pragma: no cover
     """
     Resolve an annotation that's in string representation.
 
@@ -176,7 +176,7 @@ def resolve_annotation_313(ftype: str, namespace: dict[str, type] | None = None)
     return evaluate_forward_reference(fw_ref, namespace=namespace)
 
 
-def resolve_annotation_314(ftype: str, namespace: dict[str, type] | None = None) -> type:  # pragma: no cover
+def resolve_annotation_314(ftype: str, namespace: t.Mapping[str, type] | None = None) -> type:  # pragma: no cover
     """
     Resolve an annotation that's in string representation.
 
@@ -186,7 +186,7 @@ def resolve_annotation_314(ftype: str, namespace: dict[str, type] | None = None)
     return evaluate_forward_reference(fw_ref, namespace=namespace)
 
 
-def resolve_annotation(ftype: str, namespace: dict[str, type] | None = None) -> type:  # pragma: no cover
+def resolve_annotation(ftype: str, namespace: t.Mapping[str, type] | None = None) -> type:  # pragma: no cover
     """
     Resolve an annotation that's in string representation.
 
@@ -220,6 +220,8 @@ if t.TYPE_CHECKING:
 
         def has_representer(self, field_type: str) -> bool: ...
 
+        def represent(self, name: str, *args: t.Any, **kwargs: t.Any) -> str: ...
+
         # pydal exposes dynamic table attributes like `db.my_table`.
         # this keeps type checkers from flagging these as missing attributes.
         def __getattr__(self, item: str) -> "Table": ...

{typedal-5.1.0 → typedal-5.1.2}/src/typedal/query_builder.py

@@ -46,7 +46,19 @@ from .types import (
     merge_permissions,
     require_permission,
 )
-from .warnings import UnusedWindowWarning
+from .warnings import NoopQueryWarning, UnusedWindowWarning
+
+
+def warn_noop(method: str) -> None:
+    """
+    Warn that `method` was called without arguments, which has no effect.
+    """
+    # stacklevel: 1 = here, 2 = the query builder method, 3 = the caller.
+    warnings.warn(
+        f"`.{method}()` without arguments does nothing. You can remove this call.",
+        stacklevel=3,
+        category=NoopQueryWarning,
+    )
 
 
 class QueryBuilder[T_MetaInstance: _TypedTable](Select):
@@ -175,6 +187,10 @@ class QueryBuilder[T_MetaInstance: _TypedTable](Select):
         """
         Return a clone of this builder with permission overrides merged in.
         """
+        if not permissions and self:  # ty: ignore[redundant-condition]
+            warn_noop("permissions")
+            return self
+
         return self._extend(permissions=permissions)
 
     def _normalize_select_option(
@@ -216,8 +232,15 @@ class QueryBuilder[T_MetaInstance: _TypedTable](Select):
             join: othertable.on(query) - do an INNER JOIN. Using TypeDAL relationships with .join() is recommended!
             left: othertable.on(query) - do a LEFT JOIN. Using TypeDAL relationships with .join() is recommended!
             cache: cache the query result to speed up repeated queries; e.g. (cache=(cache.ram, 3600), cacheable=True)
+
+        Calling this without any fields or options on a builder that already has settings
+        does nothing and emits a NoopQueryWarning.
         """
 
+        if not fields and not options and self:
+            warn_noop("select")
+            return self
+
         for key in ("distinct",):
             if options.get(key):
                 options[key] = self._normalize_select_option(options[key])
@@ -282,7 +305,15 @@ class QueryBuilder[T_MetaInstance: _TypedTable](Select):
             .where(lambda table: table.id == 5).where(lambda table: table.id == 6) == (table.id == 5) & (table.id=6)
         When passing multiple queries to a single .where, they will be ORed:
             .where(lambda table: table.id == 5, lambda table: table.id == 6) == (table.id == 5) | (table.id=6)
+
+        Calling this without any arguments on a builder that already has settings
+        does nothing and emits a NoopQueryWarning.
+        Starting an empty builder (e.g. `Model.where()`) is allowed and stays silent.
         """
+        if not queries_or_lambdas and not filters and self:
+            warn_noop("where")
+            return self
+
         new_query = self.query
         table = self._ensure_table_defined()
 
@@ -1268,7 +1299,8 @@ class QueryBuilder[T_MetaInstance: _TypedTable](Select):
     def __count(
         self,
         db: TypeDAL,
-        distinct: t.Optional[bool] = None,
+        distinct: bool | Field | TypedField[t.Any] = False,
+        *,
         include_left_for_distinct: bool = True,
     ) -> Query:
         # internal, shared logic between .count and ._count
@@ -1292,9 +1324,11 @@ class QueryBuilder[T_MetaInstance: _TypedTable](Select):
 
         return query
 
-    def count(self, distinct: t.Optional[bool] = None) -> int:
+    def count(self, distinct: bool | Field | TypedField[t.Any] = False) -> int:
         """
         Return the amount of rows matching the current query.
+
+        Passing a field counts its distinct values.
         """
         require_permission(self._permissions, "read")
         db = self._get_db()
@@ -1302,7 +1336,7 @@ class QueryBuilder[T_MetaInstance: _TypedTable](Select):
 
         return db(query).count(distinct)
 
-    def _count(self, distinct: t.Optional[bool] = None) -> str:
+    def _count(self, distinct: bool | Field | TypedField[t.Any] = False) -> str:
         """
         Return the SQL for .count().
         """
@@ -1328,8 +1362,9 @@ class QueryBuilder[T_MetaInstance: _TypedTable](Select):
             return self.count()
 
         db = self._get_db()
-        query = self.__count(db, distinct=self.model.id, include_left_for_distinct=False)  # ty: ignore[invalid-argument-type]
-        return db(query).count(self.model.id)
+        distinct = t.cast(TypedField[int], self.model.id)
+        query = self.__count(db, distinct=distinct, include_left_for_distinct=False)
+        return db(query).count(distinct)
 
     def __paginate(
         self,
@@ -1523,7 +1558,7 @@ class QueryBuilder[T_MetaInstance: _TypedTable](Select):
         column = t.cast(t.Callable[..., list[T]], self.column)
         return await run_async(self._get_db(), column, field, **options)
 
-    async def count_async(self, distinct: t.Optional[bool] = None) -> int:
+    async def count_async(self, distinct: bool | Field | TypedField[t.Any] = False) -> int:
         """
         Async twin of `count()`.
         """

{typedal-5.1.0 → typedal-5.1.2}/src/typedal/relationships.py

@@ -253,10 +253,12 @@ class Relationship[To_Type]:
             # relationship queried on class, that's allowed
             return self
 
+        db = instance._db
+
         # instance: TypedTable instance
         # owner: TypedTable class
 
-        if not self.name:  # pragma: no cover
+        if not (self.name and db):  # pragma: no cover
             raise ValueError("Relationship does not seem to be connected to a table field.")
 
         # Handle different lazy policies
@@ -284,7 +286,7 @@ class Relationship[To_Type]:
 
         # For "tolerate" and "allow", we fetch the data
         try:
-            resolved_table = self.get_table(instance._db)
+            resolved_table = self.get_table(db)
 
             builder = owner.where(id=instance.id).join(self.name)
             if issubclass(resolved_table, TypedTable) or isinstance(resolved_table, Table):

{typedal-5.1.0 → typedal-5.1.2}/src/typedal/rows.py

@@ -10,6 +10,7 @@ import typing as t
 
 from .asynchronous import run_async
 from .core import TypeDAL
+from .fields import TypedField
 from .helpers import mktable
 from .query_builder import QueryBuilder
 from .serializers import as_json
@@ -563,7 +564,7 @@ class TypedSet(Set):  # pragma: no cover
     This class is not actually used, only 'cast' by TypeDAL.__call__
     """
 
-    def count(self, distinct: bool | None = None, cache: AnyDict | None = None) -> int:
+    def count(self, distinct: bool | Field | TypedField[t.Any] = False, cache: AnyDict | None = None) -> int:
         """
         Count returns an int.
         """
@@ -585,5 +586,3 @@ class TypedSet(Set):  # pragma: no cover
 
 
 # note: these imports exist at the bottom of this file to prevent circular import issues:
-
-from .fields import TypedField  # noqa: E402

{typedal-5.1.0 → typedal-5.1.2}/src/typedal/serializers/typescript.py

@@ -31,7 +31,7 @@ class TypedDictRegistry(Singleton):
     def __init__(self) -> None:
         """Initialize the singleton registry and optional shared typtyp world."""
         self._types: dict[type, type[dict[str, t.Any]]] = {}
-        self._world = typtyp.World() if typtyp else None  # type: ignore
+        self._world = typtyp.World() if typtyp else None  # ty: ignore[redundant-condition]
         self._names: set[str] = set()
 
     @property

{typedal-5.1.0 → typedal-5.1.2}/src/typedal/tables.py

@@ -1152,7 +1152,7 @@ class TypedTable(_TypedTable, metaclass=TableMeta):
             "after_delete": cls._after_delete,
         }
 
-    def _setup_instance_methods(self) -> None:
+    def _setup_instance_methods(self: t.Self | type[t.Self]) -> None:
         # use setattr instead of self.x = y to make the typecheckers happier
         setattr(self, "as_dict", self._as_dict)
         setattr(self, "__json__", self._as_json)

{typedal-5.1.0 → typedal-5.1.2}/src/typedal/warnings.py

@@ -3,3 +3,7 @@
 
 class UnusedWindowWarning(RuntimeWarning):
     """Warn when a window size is configured but the query is collected directly."""
+
+
+class NoopQueryWarning(RuntimeWarning):
+    """Warn when a query builder method is called without arguments, so it does nothing."""