TypeDAL 3.13.0__tar.gz → 3.14.0__tar.gz

{typedal-3.13.0 → typedal-3.14.0}/CHANGELOG.md

@@ -2,6 +2,18 @@
 
 <!--next-version-placeholder-->
 
+## v3.14.0 (2025-05-15)
+
+### Feature
+
+* `db.find_model` to get the registered TypedTable class for a specific 'table_name' ([`c645303`](https://github.com/trialandsuccess/TypeDAL/commit/c645303a85c96735f48eafaaeb20f867b977686f))
+
+## v3.13.1 (2025-04-28)
+
+### Fix
+
+* Pass select kwargs via `.column()` - so you can do e.g. `distinct=True` ([`e5bc168`](https://github.com/trialandsuccess/TypeDAL/commit/e5bc168b90d6a5d214f049de0ef31e544214cc23))
+
 ## v3.13.0 (2025-04-28)
 
 ### Feature

{typedal-3.13.0 → typedal-3.14.0}/PKG-INFO

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

{typedal-3.13.0 → typedal-3.14.0}/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.13.0"
+__version__ = "3.14.0"

{typedal-3.13.0 → typedal-3.14.0}/src/typedal/__init__.py

@@ -10,4 +10,4 @@ try:
 except ImportError:  # pragma: no cover
     P4W_DAL = None  # type: ignore
 
-__all__ = ["TypeDAL", "TypedTable", "TypedField", "TypedRows", "fields", "Relationship", "relationship"]
+__all__ = ["Relationship", "TypeDAL", "TypedField", "TypedRows", "TypedTable", "fields", "relationship"]

{typedal-3.13.0 → typedal-3.14.0}/src/typedal/cli.py

@@ -185,7 +185,7 @@ def setup(
             data.pop(prop, None)
             continue
 
-        if minimal and getattr(config, prop, None) not in (None, "") or is_optional(annotation):
+        if (minimal and getattr(config, prop, None) not in (None, "")) or is_optional(annotation):
             # property already present or not required, SKIP!
             data[prop] = getattr(config, prop, None)
             continue
@@ -392,7 +392,8 @@ 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-3.13.0 → typedal-3.14.0}/src/typedal/core.py

@@ -93,10 +93,8 @@ def is_typed_field(cls: Any) -> typing.TypeGuard["TypedField[Any]"]:
 
     Deprecated
     """
-    return (
-        isinstance(cls, TypedField)
-        or isinstance(typing.get_origin(cls), type)
-        and issubclass(typing.get_origin(cls), TypedField)
+    return isinstance(cls, TypedField) or (
+        isinstance(typing.get_origin(cls), type) and issubclass(typing.get_origin(cls), TypedField)
     )
 
 
@@ -698,11 +696,30 @@ class TypeDAL(pydal.DAL):  # type: ignore
         """
         Allows dynamically accessing a table by its name as a string.
 
+        If you need the TypedTable class instead of the pydal table, use find_model instead.
+
         Example:
             db['users'] -> user
         """
         return typing.cast(Table, super().__getitem__(str(key)))
 
+    def find_model(self, table_name: str) -> Type["TypedTable"] | None:
+        """
+        Retrieves a mapped table class by its name.
+
+        This method searches for a table class matching the given table name
+        in the defined class map dictionary. If a match is found, the corresponding
+        table class is returned; otherwise, None is returned, indicating that no
+        table class matches the input name.
+
+        Args:
+            table_name: The name of the table to retrieve the mapped class for.
+
+        Returns:
+            The mapped table class if it exists, otherwise None.
+        """
+        return self._class_map.get(table_name, None)
+
     @classmethod
     def _build_field(cls, name: str, _type: str, **kw: Any) -> Field:
         # return Field(name, _type, **{**cls.default_kwargs, **kw})
@@ -1018,6 +1035,14 @@ class TableMeta(type):
         """
         return QueryBuilder(self).select(*a, **kw)
 
+    def column(self: Type[T_MetaInstance], field: "TypedField[T] | T", **options: Unpack[SelectKwargs]) -> list[T]:
+        """
+        Get all values in a specific column.
+
+        Shortcut for `.select(field).execute().column(field)`.
+        """
+        return QueryBuilder(self).select(field, **options).execute().column(field)
+
     def paginate(self: Type[T_MetaInstance], limit: int, page: int = 1) -> "PaginatedRows[T_MetaInstance]":
         """
         See QueryBuilder.paginate!
@@ -2695,24 +2720,24 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
         return save_to_cache(typed_rows, rows)
 
     @typing.overload
-    def column(self, field: TypedField[T]) -> list[T]:
+    def column(self, field: TypedField[T], **options: Unpack[SelectKwargs]) -> list[T]:
         """
         If a typedfield is passed, the output type can be safely determined.
         """
 
     @typing.overload
-    def column(self, field: T) -> list[T]:
+    def column(self, field: T, **options: Unpack[SelectKwargs]) -> list[T]:
         """
         Otherwise, the output type is loosely determined (assumes `field: type` or Any).
         """
 
-    def column(self, field: TypedField[T] | T) -> list[T]:
+    def column(self, field: TypedField[T] | T, **options: Unpack[SelectKwargs]) -> list[T]:
         """
         Get all values in a specific column.
 
         Shortcut for `.select(field).execute().column(field)`.
         """
-        return self.select(field).execute().column(field)
+        return self.select(field, **options).execute().column(field)
 
     def _handle_relationships_pre_select(
         self,
@@ -2878,7 +2903,7 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
 
         return _to(rows, self.model, records, metadata=metadata)
 
-    def collect_or_fail(self, exception: Exception = None) -> "TypedRows[T_MetaInstance]":
+    def collect_or_fail(self, exception: typing.Optional[Exception] = None) -> "TypedRows[T_MetaInstance]":
         """
         Call .collect() and raise an error if nothing found.
 
@@ -2898,7 +2923,7 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
         """
         yield from self.collect()
 
-    def __count(self, db: TypeDAL, distinct: bool = None) -> Query:
+    def __count(self, db: TypeDAL, distinct: typing.Optional[bool] = None) -> Query:
         # internal, shared logic between .count and ._count
         model = self.model
         query = self.query
@@ -2914,7 +2939,7 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
 
         return query
 
-    def count(self, distinct: bool = None) -> int:
+    def count(self, distinct: typing.Optional[bool] = None) -> int:
         """
         Return the amount of rows matching the current query.
         """
@@ -2923,7 +2948,7 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
 
         return db(query).count(distinct)
 
-    def _count(self, distinct: bool = None) -> str:
+    def _count(self, distinct: typing.Optional[bool] = None) -> str:
         """
         Return the SQL for .count().
         """
@@ -3022,7 +3047,7 @@ class QueryBuilder(typing.Generic[T_MetaInstance]):
     def _first(self) -> str:
         return self._paginate(page=1, limit=1)
 
-    def first_or_fail(self, exception: Exception = None, verbose: bool = False) -> T_MetaInstance:
+    def first_or_fail(self, exception: typing.Optional[Exception] = None, verbose: bool = False) -> T_MetaInstance:
         """
         Call .first() and raise an error if nothing found.
 
@@ -3110,7 +3135,7 @@ class TypedSet(pydal.objects.Set):  # type: ignore # pragma: no cover
     This class is not actually used, only 'cast' by TypeDAL.__call__
     """
 
-    def count(self, distinct: bool = None, cache: AnyDict = None) -> int:
+    def count(self, distinct: typing.Optional[bool] = None, cache: AnyDict = None) -> int:
         """
         Count returns an int.
         """

{typedal-3.13.0 → typedal-3.14.0}/src/typedal/for_py4web.py

@@ -5,7 +5,6 @@ ONLY USE IN COMBINATION WITH PY4WEB!
 import typing
 
 import threadsafevariable
-from configuraptor.abs import AnyType
 from py4web.core import ICECUBE
 from py4web.core import Fixture as _Fixture
 from pydal.base import MetaDAL, hashlib_md5
@@ -68,8 +67,8 @@ def setup_py4web_tables(db: TypeDAL) -> None:
 
 
 __all__ = [
+    "DAL",
     "AuthUser",
     "Fixture",
-    "DAL",
     "setup_py4web_tables",
 ]

{typedal-3.13.0 → typedal-3.14.0}/src/typedal/helpers.py

@@ -55,7 +55,7 @@ def all_dict(cls: type) -> AnyDict:
     return dict(ChainMap(*(c.__dict__ for c in reversed_mro(cls))))  # type: ignore
 
 
-def all_annotations(cls: type, _except: typing.Iterable[str] = None) -> dict[str, type]:
+def all_annotations(cls: type, _except: typing.Optional[typing.Iterable[str]] = None) -> dict[str, type]:
     """
     Wrapper around `_all_annotations` that filters away any keys in _except.
 
@@ -306,6 +306,10 @@ def get_field(field: "TypedField[typing.Any] | Field") -> "Field":
 
 
 class classproperty:
+    """
+    Combination of @classmethod and @property.
+    """
+
     def __init__(self, fget: typing.Callable[..., typing.Any]) -> None:
         """
         Initialize the classproperty.

{typedal-3.13.0 → typedal-3.14.0}/src/typedal/mixins.py

@@ -163,7 +163,11 @@ class SlugMixin(Mixin):
     )  # set via init subclass
 
     def __init_subclass__(
-        cls, slug_field: str = None, slug_suffix_length: int = 0, slug_suffix: Optional[int] = None, **kw: Any
+        cls,
+        slug_field: typing.Optional[str] = None,
+        slug_suffix_length: int = 0,
+        slug_suffix: Optional[int] = None,
+        **kw: Any,
     ) -> None:
         """
         Bind 'slug field' option to be used later (on_define).

{typedal-3.13.0 → typedal-3.14.0}/src/typedal/serializers/as_json.py

@@ -68,7 +68,7 @@ class SerializedJson(ConfigurableJsonEncoder):
         return _rules.get(_type, JSONRule(transform=self._default) if with_default else None)
 
 
-def encode(something: Any, indent: int = None, **kw: Any) -> str:
+def encode(something: Any, indent: typing.Optional[int] = None, **kw: Any) -> str:
     """
     Encode anything to JSON with some improved defaults.
     """

{typedal-3.13.0 → typedal-3.14.0}/tests/test_main.py

@@ -166,6 +166,11 @@ def test_mixed_defines(capsys):
 
     assert SecondNewSyntax(1).location == "Rotterdam"
 
+    # test find_model:
+    assert db.find_model("old_syntax") is None
+    assert db.find_model("first_new_syntax") is FirstNewSyntax
+    assert db.find_model("second_new_syntax") is SecondNewSyntax
+
 
 def test_dont_allow_bool_in_query():
     with pytest.raises(ValueError):

{typedal-3.13.0 → typedal-3.14.0}/tests/test_query_builder.py

@@ -483,6 +483,8 @@ def test_column():
     assert len(rows) == 4
     assert set(rows) == {33}
 
+    assert TestRelationship.column(TestRelationship.value, distinct=True, orderby=~TestRelationship.value) == [33, 3]
+
 
 def test_collect_with_extra_fields():
     _setup_data()