TypeDAL 4.1.0__tar.gz → 4.2.1__tar.gz

{typedal-4.1.0 → typedal-4.2.1}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 <!--next-version-placeholder-->
 
+## v4.2.1 (2025-12-10)
+
+### Fix
+
+* Improved type hints for relationships (non-list) ([`3fb53bc`](https://github.com/trialandsuccess/TypeDAL/commit/3fb53bc7a9b4c53c1bc533124ed205c5ec46fa92))
+
+## v4.2.0 (2025-11-28)
+
+### Feature
+
+* Minimal support for using querybuilder on old-style pydal tables ([`ec8baeb`](https://github.com/trialandsuccess/TypeDAL/commit/ec8baebbbaae5a2cb5d48254997a6322a0670d7d))
+
 ## v4.1.0 (2025-11-26)
 
 ### Feature

{typedal-4.1.0 → typedal-4.2.1}/PKG-INFO

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

{typedal-4.1.0 → typedal-4.2.1}/example_old.py

@@ -1,5 +1,3 @@
-import datetime
-
 from pydal import DAL, Field
 
 from typedal.helpers import utcnow

{typedal-4.1.0 → typedal-4.2.1}/src/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__ = "4.1.0"
+__version__ = "4.2.1"

{typedal-4.1.0 → typedal-4.2.1}/src/typedal/query_builder.py

@@ -22,7 +22,7 @@ from .helpers import (
     normalize_table_keys,
     throw,
 )
-from .tables import TypedTable
+from .tables import TableMeta, TypedTable
 from .types import (
     CacheMetadata,
     Condition,
@@ -36,6 +36,7 @@ from .types import (
     SelectKwargs,
     T,
     T_MetaInstance,
+    Table,
 )
 
 
@@ -67,7 +68,8 @@ class QueryBuilder(t.Generic[T_MetaInstance]):
             MyTable.where(...) -> QueryBuilder[MyTable]
         """
         self.model = model
-        table = model._ensure_table_defined()
+        table = self._ensure_table_defined()
+
         default_query = table.id > 0
         self.query = add_query or default_query
         self.select_args = select_args or []
@@ -75,6 +77,14 @@ class QueryBuilder(t.Generic[T_MetaInstance]):
         self.relationships = relationships or {}
         self.metadata = metadata or {}
 
+    def _ensure_table_defined(self) -> Table:
+        model = self.model
+        if hasattr(model, "_ensure_table_defined"):
+            return model._ensure_table_defined()
+        else:
+            # already a pydal table
+            return t.cast(Table, model)
+
     def __str__(self) -> str:
         """
         Simple string representation for the query builder.
@@ -99,7 +109,7 @@ class QueryBuilder(t.Generic[T_MetaInstance]):
         """
         Querybuilder is truthy if it has t.Any conditions.
         """
-        table = self.model._ensure_table_defined()
+        table = self._ensure_table_defined()
         default_query = table.id > 0
         return any(
             [
@@ -191,7 +201,7 @@ class QueryBuilder(t.Generic[T_MetaInstance]):
             .where(lambda table: table.id == 5, lambda table: table.id == 6) == (table.id == 5) | (table.id=6)
         """
         new_query = self.query
-        table = self.model._ensure_table_defined()
+        table = self._ensure_table_defined()
 
         queries_or_lambdas = (
             *queries_or_lambdas,
@@ -531,6 +541,11 @@ class QueryBuilder(t.Generic[T_MetaInstance]):
         if _to is None:
             _to = TypedRows
 
+        if not isinstance(self.model, TableMeta):
+            # tried to use querybuilder with a non-typedal table,
+            # fallback to execute:
+            return self.execute(add_id=add_id)
+
         db = self._get_db()
         metadata = self.metadata.copy()
 
@@ -792,7 +807,7 @@ class QueryBuilder(t.Generic[T_MetaInstance]):
         Transform the raw rows into Typed Table model instances with nested relationships.
         """
         db = self._get_db()
-        main_table = self.model._ensure_table_defined()
+        main_table = self._ensure_table_defined()
 
         # id: Model
         records: dict[t.Any, T_MetaInstance] = {}

{typedal-4.1.0 → typedal-4.2.1}/src/typedal/relationships.py

@@ -257,6 +257,27 @@ class Relationship(t.Generic[To_Type]):
             return fallback_value
 
 
+@t.overload
+def relationship(
+    _type: type[list[To_Type]],
+    condition: Condition = None,
+    join: JOIN_OPTIONS = None,
+    on: OnQuery = None,
+    lazy: LazyPolicy | None = None,
+    explicit: bool = False,
+) -> list[To_Type]:
+    """
+    Define a relationship that returns a list of related instances.
+
+    Args:
+        _type: A list type hint like list[Office] to indicate multiple related records.
+
+    Returns:
+        A list of related instances.
+    """
+
+
+@t.overload
 def relationship(
     _type: t.Type[To_Type] | str,
     condition: Condition = None,
@@ -264,7 +285,26 @@ def relationship(
     on: OnQuery = None,
     lazy: LazyPolicy | None = None,
     explicit: bool = False,
-) -> To_Type:
+) -> To_Type | None:
+    """
+    Define a relationship that returns a single optional related instance.
+
+    Args:
+        _type: A type or string reference like City to indicate a single related record.
+
+    Returns:
+        A single related instance or None.
+    """
+
+
+def relationship(
+    _type: type[list[To_Type]] | t.Type[To_Type] | str,
+    condition: Condition = None,
+    join: JOIN_OPTIONS = None,
+    on: OnQuery = None,
+    lazy: LazyPolicy | None = None,
+    explicit: bool = False,
+) -> list[To_Type] | To_Type | None:
     """
     Define a relationship to another table, when its id is not stored in the current table.
 

{typedal-4.1.0 → typedal-4.2.1}/tests/test_config.py

@@ -6,10 +6,7 @@ import uuid
 from pathlib import Path
 
 import pytest
-
-# from contextlib import chdir
 from contextlib_chdir import chdir
-from pydal2sql import generate_sql
 from testcontainers.postgres import PostgresContainer
 
 from src.typedal import TypeDAL, TypedField, TypedTable

{typedal-4.1.0 → typedal-4.2.1}/tests/test_mypy.py

@@ -1,4 +1,3 @@
-import sys
 import typing
 
 import pydal.objects

{typedal-4.1.0 → typedal-4.2.1}/tests/test_query_builder.py

@@ -1,11 +1,8 @@
-import inspect
-import typing
-
 import pytest
 from pydal.objects import Query
 
 from src.typedal import TypeDAL, TypedField, TypedTable, relationship
-from typedal.types import CacheFn, CacheModel, CacheTuple, Rows
+from typedal import QueryBuilder
 
 db = TypeDAL("sqlite:memory")
 
@@ -17,7 +14,9 @@ class TestQueryTable(TypedTable):
     yet_another = TypedField(list[str], default=["something", "and", "other", "things"])
 
     relations = relationship(
-        list["TestRelationship"], condition=lambda self, other: self.id == other.querytable, join="left"
+        list["TestRelationship"],
+        condition=lambda self, other: self.id == other.querytable,
+        join="left",
     )
 
 
@@ -47,21 +46,21 @@ def test_query_type():
 
 
 """
-SELECT "test_query_table"."id",
-       "test_query_table"."number",
-       "relations_8106139955393"."id",
-       "relations_8106139955393"."name",
-       "relations_8106139955393"."value",
-       "relations_8106139955393"."querytable"
-FROM "test_query_table"
-         LEFT JOIN "test_relationship" AS "relations_8106139955393"
-                   ON ("relations_8106139955393"."querytable" = "test_query_table"."id")
-WHERE ("test_query_table"."id" IN (SELECT "test_query_table"."id"
-                                   FROM "test_query_table"
-                                   WHERE ("test_query_table"."id" > 0)
-                                   ORDER BY "test_query_table"."id"
-                                   LIMIT 3 OFFSET 0))
-ORDER BY "test_query_table"."number" DESC;
+SELECT "test_query_table"."id"
+     , "test_query_table"."number"
+     , "relations_8106139955393"."id"
+     , "relations_8106139955393"."name"
+     , "relations_8106139955393"."value"
+     , "relations_8106139955393"."querytable"
+    FROM "test_query_table"
+             LEFT JOIN "test_relationship" AS "relations_8106139955393"
+                       ON ("relations_8106139955393"."querytable" = "test_query_table"."id")
+    WHERE ("test_query_table"."id" IN (SELECT "test_query_table"."id"
+                                           FROM "test_query_table"
+                                           WHERE ("test_query_table"."id" > 0)
+                                           ORDER BY "test_query_table"."id"
+                                           LIMIT 3 OFFSET 0))
+    ORDER BY "test_query_table"."number" DESC;
 """
 
 
@@ -532,3 +531,16 @@ def test_collect_with_extra_fields():
 
     with pytest.raises(HTTP):
         TestRelationship.where(TestRelationship.id == 3245892384).first_or_fail(HTTP(404))
+
+
+def test_minimal_functionality_on_pydal_style_tables():
+    _setup_data()
+
+    qb1 = TestQueryTable.where(number=2).collect()
+    qb2 = QueryBuilder(db.test_query_table).where(number=2).collect()
+
+    assert len(qb1) == len(qb2)
+    assert qb1.first().id == qb2.first().id
+
+    assert qb2
+    assert len(qb2) == 1

{typedal-4.1.0 → typedal-4.2.1}/tests/test_relationships.py

@@ -1,5 +1,4 @@
 import contextlib
-import json
 import time
 import types
 import typing
@@ -102,8 +101,7 @@ class Tagged(TypedTable):  # pivot table
 
 
 @db.define()
-class Empty(TypedTable):
-    ...
+class Empty(TypedTable): ...
 
 
 def _setup_data():
@@ -314,8 +312,7 @@ def test_typedal_way():
     author1 = User.where(id=4).join("articles").first()
 
     assert (
-            len(author1.as_dict()["articles"]) == len(author1.__dict__["articles"]) == len(
-        dict(author1)["articles"]) == 2
+        len(author1.as_dict()["articles"]) == len(author1.__dict__["articles"]) == len(dict(author1)["articles"]) == 2
     )
 
 
@@ -483,12 +480,12 @@ def test_caching():
     cached_user_only2 = User.join().cache(User.id).collect_or_fail()
 
     assert (
-            len(uncached2)
-            == len(uncached)
-            == len(cached2)
-            == len(cached)
-            == len(cached_user_only2)
-            == len(cached_user_only)
+        len(uncached2)
+        == len(uncached)
+        == len(cached2)
+        == len(cached)
+        == len(cached_user_only2)
+        == len(cached_user_only)
     )
 
     assert uncached.as_json() == uncached2.as_json() == cached.as_json() == cached2.as_json()
@@ -496,9 +493,9 @@ def test_caching():
     assert cached.first().gid == cached2.first().gid
 
     assert (
-            [_.name for _ in uncached2.first().roles]
-            == [_.name for _ in cached.first().roles]
-            == [_.name for _ in cached2.first().roles]
+        [_.name for _ in uncached2.first().roles]
+        == [_.name for _ in cached.first().roles]
+        == [_.name for _ in cached2.first().roles]
     )
 
     assert not uncached2.metadata.get("cache", {}).get("enabled")
@@ -636,27 +633,31 @@ def test_caching_dependencies():
 
 def test_illegal():
     with pytest.raises(ValueError), pytest.warns(UserWarning):
+
         class HasRelationship:
             something = relationship("...", condition=lambda: 1, on=lambda: 2)
 
     with pytest.raises(ValueError), pytest.warns(UserWarning):
         Tag.join(Tag.articles, condition=lambda: 1, on=lambda: 2)
 
+
 def test_join_relationship_custom_on():
     _setup_data()
 
-    rows1 = Tag.join(Tag.articles,
-                     condition=lambda tag, article: (Tagged.tag == tag.id) & (article.gid == Tagged.entity) & (article.author == 3),
-                     method="inner",
-                     )
-
-    rows2 = Tag.join(Tag.articles,
-                     on=lambda tag, article: [
-                         tagged := Tagged.unique_alias(),
-                         (tagged.tag == tag.id) & (article.gid == tagged.entity) & (article.author == 3)
-                     ],
-                     method="inner",
-                     )
+    rows1 = Tag.join(
+        Tag.articles,
+        condition=lambda tag, article: (Tagged.tag == tag.id) & (article.gid == Tagged.entity) & (article.author == 3),
+        method="inner",
+    )
+
+    rows2 = Tag.join(
+        Tag.articles,
+        on=lambda tag, article: [
+            tagged := Tagged.unique_alias(),
+            (tagged.tag == tag.id) & (article.gid == tagged.entity) & (article.author == 3),
+        ],
+        method="inner",
+    )
 
     assert all([row.articles for row in rows1])
     assert all([row.articles for row in rows2])