TypeDAL 3.8.3__tar.gz → 3.8.5__tar.gz

{typedal-3.8.3 → typedal-3.8.5}/CHANGELOG.md

@@ -2,6 +2,19 @@
 
 <!--next-version-placeholder-->
 
+## v3.8.5 (2024-10-24)
+
+### Fix
+
+* Use right 'timestamp' field ([`2aedb02`](https://github.com/trialandsuccess/TypeDAL/commit/2aedb027b4490f8284253e9c7f427b0660b6bc13))
+* Allow specifying a field to Builder.count(...); support selecting extra fields (e.g. MyField.count()) ([`ce28a79`](https://github.com/trialandsuccess/TypeDAL/commit/ce28a7995a6d817424462f8b18383c85fa349ba4))
+
+## v3.8.4 (2024-10-24)
+
+### Fix
+
+* Paginate with limit=0 will yield all rows instead of crashing pt2 ([`78f1ae7`](https://github.com/trialandsuccess/TypeDAL/commit/78f1ae7257af0ba90040a7356ad579d3c77aa231))
+
 ## v3.8.3 (2024-10-24)
 
 ### Fix

{typedal-3.8.3 → typedal-3.8.5}/PKG-INFO

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

{typedal-3.8.3 → typedal-3.8.5}/example_new.py

@@ -8,6 +8,8 @@ from src.typedal.fields import TextField
 from src.typedal.helpers import utcnow
 from pydal.validators import IS_NOT_EMPTY
 
+from typedal.fields import TimestampField
+
 db = TypeDAL("sqlite:memory")
 
 
@@ -20,7 +22,7 @@ class Person(TypedTable):
     age = TypedField(int, default=18, requires=IS_NOT_EMPTY())
     nicknames: list[str]
 
-    ts = TypedField(dt.datetime, type="timestamp")
+    ts = TimestampField()
 
 
 assert db.person._format == "%(name)s"

{typedal-3.8.3 → typedal-3.8.5}/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__ = "3.8.3"
+__version__ = "3.8.5"

{typedal-3.8.3 → typedal-3.8.5}/src/typedal/core.py

@@ -1500,7 +1500,14 @@ class TypedTable(_TypedTable, metaclass=TableMeta):
             return None  # type: ignore
 
         inst._row = row
-        inst.__dict__.update(row)
+
+        if hasattr(row, "id"):
+            inst.__dict__.update(row)
+        else:
+            # deal with _extra (and possibly others?)
+            # Row <{actual: {}, _extra: ...}>
+            inst.__dict__.update(row[str(cls)])
+
         inst._setup_instance_methods()
         return inst
 
@@ -1828,7 +1835,22 @@ class TypedRows(typing.Collection[T_MetaInstance], Rows):
         `metadata` can be any (un)structured data
         `model` is a Typed Table class
         """
-        records = records or {row.id: model(row) for row in rows}
+
+        def _get_id(row: Row) -> int:
+            """
+            Try to find the id field in a row.
+
+            If _extra exists, the row changes:
+            <Row {'test_relationship': {'id': 1}, '_extra': {'COUNT("test_relationship"."querytable")': 8}}>
+            """
+            if idx := getattr(row, "id", None):
+                return typing.cast(int, idx)
+            elif main := getattr(row, str(model), None):
+                return typing.cast(int, main.id)
+            else:  # pragma: no cover
+                raise NotImplementedError(f"`id` could not be found for {row}")
+
+        records = records or {_get_id(row): model(row) for row in rows}
         super().__init__(rows.db, records, rows.colnames, rows.compact, rows.response, rows.fields)
         self.model = model
         self.metadata = metadata or {}
@@ -2721,7 +2743,7 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
         """
         yield from self.collect()
 
-    def count(self) -> int:
+    def count(self, distinct: bool = None) -> int:
         """
         Return the amount of rows matching the current query.
         """
@@ -2730,25 +2752,27 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
         query = self.query
 
         for key, relation in self.relationships.items():
-            if not relation.condition or relation.join != "inner":
+            if (not relation.condition or relation.join != "inner") and not distinct:
                 continue
 
             other = relation.get_table(db)
-            other = other.with_alias(f"{key}_{hash(relation)}")
+            if not distinct:
+                # todo: can this lead to other issues?
+                other = other.with_alias(f"{key}_{hash(relation)}")
             query &= relation.condition(model, other)
 
-        return db(query).count()
+        return db(query).count(distinct)
 
     def __paginate(
         self,
         limit: int,
         page: int = 1,
     ) -> "QueryBuilder[T_MetaInstance]":
-        _from = limit * (page - 1)
-        _to = limit * page
-
         available = self.count()
 
+        _from = limit * (page - 1)
+        _to = (limit * page) if limit else available
+
         metadata: Metadata = {}
 
         metadata["pagination"] = {

{typedal-3.8.3 → typedal-3.8.5}/tests/test_query_builder.py

@@ -275,6 +275,7 @@ def test_paginate():
 
     # what if no limit?
     all_rows = TestQueryTable.join(method="left").paginate(limit=0, page=1)
+    assert len(all_rows) == 5
     assert all_rows.pagination["total_items"] == 5
     assert all_rows.pagination["total_pages"] == 1
     assert not all_rows.pagination["has_next_page"]
@@ -470,3 +471,17 @@ def test_column():
 
     assert len(rows) == 4
     assert set(rows) == {33}
+
+
+def test_collect_with_extra_fields():
+    _setup_data()
+    builder = TestRelationship.select(TestRelationship.id, TestRelationship.name, TestRelationship.querytable.count())
+
+    assert builder.execute()
+
+    row = builder.first_or_fail()
+
+    assert row.id
+    assert row.name
+    assert row._extra
+    assert row[TestRelationship.querytable.count()]

{typedal-3.8.3 → typedal-3.8.5}/tests/test_relationships.py

@@ -43,7 +43,7 @@ class Role(TypedTable, TaggableMixin):
 @db.define()
 class User(TypedTable, TaggableMixin):
     gid = TypedField(str, default=uuid4)
-    name: str
+    name: TypedField[str]
     roles: TypedField[list[Role]]
     main_role = TypedField(Role)
     extra_roles = TypedField(list[Role])
@@ -110,6 +110,11 @@ def _setup_data():
         ]
     )
 
+    # no relationships:
+    new_author = User.insert(name="Untagged Author", roles=[], main_role=writer, extra_roles=[])
+    untagged1 = Article.insert(title="Untagged Article 1", author=new_author)
+    untagged2 = Article.insert(title="Untagged Article 2", author=new_author)
+
     # articles
 
     article1, article2 = Article.bulk_insert(
@@ -184,11 +189,11 @@ def test_typedal_way():
 
     all_articles = Article.join().collect().as_dict()
 
-    assert all_articles[1]["final_editor"]["name"] == "Editor 1"
-    assert all_articles[2]["secondary_author"]["name"] == "Editor 1"
+    assert all_articles[3]["final_editor"]["name"] == "Editor 1"
+    assert all_articles[4]["secondary_author"]["name"] == "Editor 1"
 
-    assert all_articles[1]["secondary_author"] is None
-    assert all_articles[2]["final_editor"] is None
+    assert all_articles[3]["secondary_author"] is None
+    assert all_articles[4]["final_editor"] is None
 
     assert Article.first_or_fail()
 
@@ -244,7 +249,7 @@ def test_typedal_way():
 
     users = User.join().collect()
 
-    assert len(users) == 3  # reader, writer, editor
+    assert len(users) == 4  # reader, writer, editor, untagged
 
     # get by id:
     reader = users[1]
@@ -533,6 +538,47 @@ def test_caching_dependencies():
 
 def test_illegal():
     with pytest.raises(ValueError), pytest.warns(UserWarning):
-
         class HasRelationship:
             something = relationship("...", condition=lambda: 1, on=lambda: 2)
+
+
+
+def test_join_with_select():
+    _setup_data()
+
+    builder = User.select(User.id, User.gid, Article.id, Article.gid).where(id=2).join("articles")
+    user = builder.first_or_fail()
+
+    assert user.id
+    assert user.gid
+    assert not user.name
+    assert user.articles[0].id
+    assert user.articles[0].gid
+    assert not hasattr(user.articles[0], "title")
+
+    for user in builder.paginate(limit=1, page=1):
+        assert user.id
+        assert user.gid
+        assert not user.name
+        assert user.articles[0].id
+        assert user.articles[0].gid
+        assert not hasattr(user.articles[0], "title")
+
+    for user in builder.collect():
+        assert user.id
+        assert user.gid
+        assert not user.name
+        assert user.articles[0].id
+        assert user.articles[0].gid
+        assert not hasattr(user.articles[0], "title")
+
+
+def test_count_with_join():
+    _setup_data()
+
+    # 0. count via select:
+    row = User.select(User.id, User.gid, Article.id, Article.gid).where(id=4).join("articles").first_or_fail()
+    assert len(row.articles) == 2
+
+    assert User.where(id=4).join("articles").count(User.id) == 1
+    assert User.where(id=4).join("articles").count(Article.id) == 2