TypeDAL 4.0.0__tar.gz → 4.0.2__tar.gz

{typedal-4.0.0 → typedal-4.0.2}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 <!--next-version-placeholder-->
 
+## v4.0.2 (2025-10-14)
+
+### Fix
+
+* Resolve nested join bug where shared foreign key relationships weren't loaded correctly ([`b093454`](https://github.com/trialandsuccess/TypeDAL/commit/b09345410576cf0a61c0395d91b03d60d2c056a2))
+
+## v4.0.1 (2025-10-13)
+
+### Fix
+
+* Export 'PaginatedRows' ([`977a83b`](https://github.com/trialandsuccess/TypeDAL/commit/977a83b30e21412893fe24434b86d7f40ef77e87))
+
 ## v4.0.0 (2025-10-12)
 
 ### Feature

{typedal-4.0.0 → typedal-4.0.2}/PKG-INFO

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

{typedal-4.0.0 → typedal-4.0.2}/pyproject.toml

@@ -118,7 +118,7 @@ badge = true
 mypy = "--disable-error-code misc"
 
 [tool.black]
-target-version = ["py313"]
+target-version = ["py314"]
 line-length = 120
 # 'extend-exclude' excludes files or directories in addition to the defaults
 extend-exclude = '''
@@ -161,7 +161,7 @@ strict = true
 exclude = ["venv", ".bak"]
 
 [tool.ruff]
-target-version = "py313"
+target-version = "py314"
 line-length = 120
 
 extend-exclude = ["*.bak/", "venv*/"]

{typedal-4.0.0 → typedal-4.0.2}/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.0.0"
+__version__ = "4.0.2"

{typedal-4.0.0 → typedal-4.0.2}/src/typedal/__init__.py

@@ -7,7 +7,7 @@ from .fields import TypedField
 from .helpers import sql_expression
 from .query_builder import QueryBuilder
 from .relationships import Relationship, relationship
-from .rows import TypedRows
+from .rows import PaginatedRows, TypedRows
 from .tables import TypedTable
 
 from . import fields  # isort: skip
@@ -18,6 +18,7 @@ except ImportError:  # pragma: no cover
     P4W_DAL = None  # type: ignore
 
 __all__ = [
+    "PaginatedRows",
     "QueryBuilder",
     "Relationship",
     "TypeDAL",

{typedal-4.0.0 → typedal-4.0.2}/src/typedal/cli.py

@@ -392,8 +392,7 @@ def fake_migrations(
 
     previously_migrated = (
         db(
-            db.ewh_implemented_features.name.belongs(to_fake)
-            & (db.ewh_implemented_features.installed == True)  # noqa E712
+            db.ewh_implemented_features.name.belongs(to_fake) & (db.ewh_implemented_features.installed == True)  # noqa E712
         )
         .select(db.ewh_implemented_features.name)
         .column("name")

{typedal-4.0.0 → typedal-4.0.2}/src/typedal/query_builder.py

@@ -894,7 +894,7 @@ class QueryBuilder(t.Generic[T_MetaInstance]):
                 column=nested_col,
                 relation=nested_relation,
                 parent_record=instance,
-                parent_id=parent_id,
+                parent_id=instance.id,
                 seen_relations=seen_relations,
                 db=db,
                 path=path,

{typedal-4.0.0 → typedal-4.0.2}/tests/test_helpers.py

@@ -1,3 +1,4 @@
+import datetime as dt
 import sys
 import typing
 
@@ -27,7 +28,6 @@ from src.typedal.helpers import (
 )
 from src.typedal.types import Field
 
-import datetime as dt
 
 def test_is_union():
     assert is_union(int | str)
@@ -267,6 +267,7 @@ def test_sql_expression():
     assert str(database.sql_expression("LOWER(%s)", TestSqlExpression.value)) == 'LOWER("test_sql_expression"."value")'
     assert str(database.sql_expression("LOWER(%s.value)", TestSqlExpression)) == 'LOWER("test_sql_expression".value)'
 
+
 @pytest.mark.skipif(not SYSTEM_SUPPORTS_TEMPLATES, reason="t-strings contain breaking syntax!")
 def test_sql_expression_314():
     from .py314_tests import test_sql_expression_314

{typedal-4.0.0 → typedal-4.0.2}/tests/test_relationships.py

@@ -17,9 +17,6 @@ from src.typedal.caching import (
 db = TypeDAL("sqlite:memory")
 
 
-# db = TypeDAL("sqlite://debug.db")
-
-
 class TaggableMixin:
     tags = relationship(
         list["Tag"],
@@ -87,8 +84,7 @@ class Tagged(TypedTable):  # pivot table
 
 
 @db.define()
-class Empty(TypedTable):
-    ...
+class Empty(TypedTable): ...
 
 
 def _setup_data():
@@ -297,8 +293,7 @@ def test_typedal_way():
     author1 = User.where(id=4).join().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
     )
 
 
@@ -386,7 +381,9 @@ def test_join_with_different_condition():
     assert role_with_users.users[0].name == "Reader 1"
 
     role_with_users = Role.join(
-        "users", method="inner", condition_and=lambda role, user: ~user.name.like("Reader%"),
+        "users",
+        method="inner",
+        condition_and=lambda role, user: ~user.name.like("Reader%"),
     ).first()
 
     assert role_with_users.users
@@ -394,7 +391,9 @@ def test_join_with_different_condition():
 
     # left:
     role_with_users = Role.join(
-        "users", method="left", condition_and=lambda role, user: ~user.name.like("Reader%"),
+        "users",
+        method="left",
+        condition_and=lambda role, user: ~user.name.like("Reader%"),
     ).first()
 
     assert role_with_users.users
@@ -431,12 +430,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()
@@ -444,9 +443,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")
@@ -584,6 +583,7 @@ def test_caching_dependencies():
 
 def test_illegal():
     with pytest.raises(ValueError), pytest.warns(UserWarning):
+
         class HasRelationship:
             something = relationship("...", condition=lambda: 1, on=lambda: 2)
 
@@ -667,9 +667,10 @@ def test_nested_relationships():
 
     assert old_besties == new_besties == {"Editor 1": "-", "Reader 1": "Reader's Bestie", "Writer 1": "-"}
 
-
     # more complex:
-    role = Role.where(name="reader").join("users.bestie", "users.articles.final_editor", "users.articles.secondary_author")
+    role = Role.where(name="reader").join(
+        "users.bestie", "users.articles.final_editor", "users.articles.secondary_author"
+    )
 
     nested_article = role.first().users[2].articles[0]
 
@@ -679,7 +680,113 @@ def test_nested_relationships():
     assert not nested_article.final_editor
 
     # complex, inner:
-    role_inner = Role.where(name="reader").join("users.bestie", "users.articles.final_editor", "users.articles.secondary_author", method="inner")
+    role_inner = Role.where(name="reader").join(
+        "users.bestie", "users.articles.final_editor", "users.articles.secondary_author", method="inner"
+    )
 
     # no final_editor -> inner join should fail:
-    assert not role_inner.first()
+    assert not role_inner.first()
+
+
+"""
+In production I noticed this bug:
+
+When joining nested data like `process = Process.join("pros_and_cons.product")`
+process.pros_and_cons[0].product # is fine
+process.pros_and_cons[1].product # is None
+while they both share the same `product_gid`
+This indicates that something goes wrong when collecting the nested data.
+`pros_and_cons` is very specific to that production use-case so please think of a more general example and write a test for it.
+1. define the required tables and relationships
+2. define the required data
+3. perform the query and check the results
+"""
+
+
+class City(TypedTable):
+    gid = TypedField(str, default=uuid4)
+    name: str
+
+
+class Office(TypedTable):
+    gid = TypedField(str, default=uuid4)
+    address: str
+    city_id: City
+    company: "Company"
+
+    city_alternative = relationship(City, lambda office, city: office.city_id == city.id)
+
+
+class Company(TypedTable):
+    name: str
+
+    offices = relationship(list[Office], lambda self, other: other.company == self.id)
+
+
+def test_nested_join_with_shared_foreign_key():
+    """
+    Test that nested joins properly load relationships for all items,
+    especially when multiple items share the same foreign key value.
+
+    Bug: When joining nested data like company.offices[0].city works
+    but company.offices[1].city is None even though both offices
+    reference the same city.
+    """
+    db.define(City)
+    db.define(Company)
+    db.define(Office)
+
+    # Create a city
+    san_francisco = City.insert(name="San Francisco")
+
+    # Create a company
+    tech_corp = Company.insert(name="Tech Corp")
+
+    # Create multiple offices in the same city for the same company
+    office1 = Office.insert(address="123 Market St", city_id=san_francisco.id, company=tech_corp.id)
+    office2 = Office.insert(address="456 Mission St", city_id=san_francisco.id, company=tech_corp.id)
+    office3 = Office.insert(address="789 Howard St", city_id=san_francisco.id, company=tech_corp.id)
+
+    db.commit()
+
+    # 1: direct Reference (not a Relationship)
+
+    # Query company with nested join to offices and their cities
+    company = Company.where(id=tech_corp.id).join("offices.city_id").first_or_fail()
+
+    # All offices should be loaded
+    assert len(company.offices) == 3, f"Expected 3 offices, got {len(company.offices)}"
+
+    # BUG TEST: All offices should have their city relationship loaded
+    # Not just the first one
+    for idx, office in enumerate(company.offices, 1):
+        assert office.city_id is not None, f"Office {idx} ('{office.address}'): city relationship is None (BUG!)"
+        assert isinstance(office.city_id, City), (
+            f"Office {idx}: city ({office.city_id}) is not a City instance but a {type(office.city_id)}"
+        )
+        assert office.city_id.name == "San Francisco", (
+            f"Office {idx}: expected 'San Francisco', got '{office.city_id.name}'"
+        )
+        assert office.city_id.id == san_francisco.id, f"Office {idx}: city id mismatch"
+
+    # 2. alternative: city_alternative (Relationship)
+
+    # Query company with nested join to offices and their cities
+    company = Company.where(id=tech_corp.id).join("offices.city_alternative").first_or_fail()
+
+    # All offices should be loaded
+    assert len(company.offices) == 3, f"Expected 3 offices, got {len(company.offices)}"
+
+    # BUG TEST: All offices should have their city relationship loaded
+    # Not just the first one
+    for idx, office in enumerate(company.offices, 1):
+        assert office.city_alternative is not None, (
+            f"Office {idx} ('{office.address}'): city relationship is None (BUG!)"
+        )
+        assert isinstance(office.city_alternative, City), (
+            f"Office {idx}: city ({office.city_alternative}) is not a City instance but a {type(office.city_alternative)}"
+        )
+        assert office.city_alternative.name == "San Francisco", (
+            f"Office {idx}: expected 'San Francisco', got '{office.city_alternative.name}'"
+        )
+        assert office.city_alternative.id == san_francisco.id, f"Office {idx}: city id mismatch"

{typedal-4.0.0 → typedal-4.0.2}/tests/test_main.py

@@ -1,6 +1,6 @@
 import re
-import typing
 import sys
+import typing
 from copy import copy
 from sqlite3 import IntegrityError
 from typing import ForwardRef