TypeDAL 3.1.4__py3-none-any.whl → 3.2.0__py3-none-any.whl

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.1.4"
+__version__ = "3.2.0"

typedal/mixins.py

@@ -7,13 +7,20 @@ Mixins can add reusable fields and behavior (optimally both, otherwise it doesn'
 import base64
 import os
 import typing
+import warnings
 from datetime import datetime
-from typing import Any
+from typing import Any, Optional
 
 from slugify import slugify
 
-from .core import TypedTable  # noqa F401 - used by example in docstring
-from .core import TypeDAL, _TypedTable
+from .core import (  # noqa F401 - used by example in docstring
+    QueryBuilder,
+    T_MetaInstance,
+    TableMeta,
+    TypeDAL,
+    TypedTable,
+    _TypedTable,
+)
 from .fields import DatetimeField, StringField
 from .types import OpRow, Set
 
@@ -79,7 +86,7 @@ class SlugMixin(Mixin):
     Some random bytes are added at the end to prevent duplicates.
 
     Example:
-        >>> class MyTable(TypedTable, SlugMixin, slug_field="some_name"):
+        >>> class MyTable(TypedTable, SlugMixin, slug_field="some_name", slug_suffix_length=8):
         >>>    some_name: str
         >>>    ...
     """
@@ -95,11 +102,11 @@ class SlugMixin(Mixin):
         },
     )  # set via init subclass
 
-    def __init_subclass__(cls, slug_field: str = None, slug_suffix: int = 8, **kw: Any) -> None:
+    def __init_subclass__(cls, slug_field: str = None, slug_suffix_length: int = 0, **kw: Any) -> None:
         """
         Bind 'slug field' option to be used later (on_define).
 
-        You can control the length of the random suffix with the `slug_suffix` option (0 is no suffix).
+        You can control the length of the random suffix with the `slug_suffix_length` option (0 is no suffix).
         """
         # unfortunately, PyCharm and mypy do not recognize/autocomplete/typecheck init subclass (keyword) arguments.
         if slug_field is None:
@@ -108,6 +115,14 @@ class SlugMixin(Mixin):
                 "e.g. `class MyClass(TypedTable, SlugMixin, slug_field='title'): ...`"
             )
 
+        if "slug_suffix" in kw:
+            warnings.warn(
+                "The 'slug_suffix' option is deprecated, use 'slug_suffix_length' instead.",
+                DeprecationWarning,
+            )
+
+        slug_suffix = slug_suffix_length or kw.get("slug_suffix", 0)
+
         cls.__settings__ = {
             "slug_field": slug_field,
             "slug_suffix": slug_suffix,
@@ -133,3 +148,25 @@ class SlugMixin(Mixin):
             row["slug"] = slugify(generated_slug)
 
         cls._before_insert.append(generate_slug_before_insert)
+
+    @classmethod
+    def from_slug(cls: typing.Type[T_MetaInstance], slug: str, join: bool = True) -> Optional[T_MetaInstance]:
+        """
+        Find a row by its slug.
+        """
+        builder = cls.where(slug=slug)
+        if join:
+            builder = builder.join()
+
+        return builder.first()
+
+    @classmethod
+    def from_slug_or_fail(cls: typing.Type[T_MetaInstance], slug: str, join: bool = True) -> T_MetaInstance:
+        """
+        Find a row by its slug, or raise an error if it doesn't exist.
+        """
+        builder = cls.where(slug=slug)
+        if join:
+            builder = builder.join()
+
+        return builder.first_or_fail()

{typedal-3.1.4.dist-info → typedal-3.2.0.dist-info}/METADATA

@@ -1,6 +1,6 @@
-Metadata-Version: 2.1
+Metadata-Version: 2.3
 Name: TypeDAL
-Version: 3.1.4
+Version: 3.2.0
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues
@@ -35,6 +35,7 @@ Requires-Dist: mkdocs-dracula-theme; extra == 'dev'
 Requires-Dist: pytest-mypy-testing; extra == 'dev'
 Requires-Dist: python-semantic-release<8; extra == 'dev'
 Requires-Dist: su6[all]; extra == 'dev'
+Requires-Dist: testcontainers; extra == 'dev'
 Requires-Dist: types-pyyaml; extra == 'dev'
 Requires-Dist: types-tabulate; extra == 'dev'
 Provides-Extra: migrations

{typedal-3.1.4.dist-info → typedal-3.2.0.dist-info}/RECORD

@@ -1,4 +1,4 @@
-typedal/__about__.py,sha256=rg1ktSg7m5s-wVEyJZGLexDBUkbBQvnRft88RSv-4tY,206
+typedal/__about__.py,sha256=JM7UvclHJLbyevmmJGGt8HQwzgu3SMpy7q2WeNEm9Io,206
 typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
 typedal/caching.py,sha256=8UABVAhOlBpL96ykmqhxLaFYOe-XeAh7JoGh57OkxP8,11818
 typedal/cli.py,sha256=3tge8B-YjgjMC6425-RMczmWvpOTfWV5QYPXRY23IWA,18200
@@ -8,12 +8,12 @@ typedal/fields.py,sha256=z2PD9vLWqBR_zXtiY0DthqTG4AeF3yxKoeuVfGXnSdg,5197
 typedal/for_py4web.py,sha256=d07b8hL_PvNDUS26Z5fDH2OxWb-IETBuAFPSzrRwm04,1285
 typedal/for_web2py.py,sha256=4RHgzGXgKIO_BYB-7adC5e35u52rX-p1t4tPEz-NK24,1867
 typedal/helpers.py,sha256=mtRYPFlS0dx2wK8kYSJ4vm1wsTXRkdPumFRlOAjF_xU,7177
-typedal/mixins.py,sha256=UzuTgrJF30cowpKTHI4Y4iSub9wJoxo88XmrWHRrtGs,4361
+typedal/mixins.py,sha256=OHhVYLBGTzPSJKgp1uovBs1Y6NJa0d-DxHTOk9LyOXA,5414
 typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 typedal/types.py,sha256=1kGkNX6vfGg6ln84AG558C4Zx5ACRz-emrUTnuy-rRY,3410
 typedal/web2py_py4web_shared.py,sha256=VK9T8P5UwVLvfNBsY4q79ANcABv-jX76YKADt1Zz_co,1539
 typedal/serializers/as_json.py,sha256=ffo152W-sARYXym4BzwX709rrO2-QwKk2KunWY8RNl4,2229
-typedal-3.1.4.dist-info/METADATA,sha256=yh1PzCqEG-XLvhPRLgD33O6fW-GAspkIKobbj7qNA5I,9270
-typedal-3.1.4.dist-info/WHEEL,sha256=KGYbc1zXlYddvwxnNty23BeaKzh7YuoSIvIMO4jEhvw,87
-typedal-3.1.4.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.1.4.dist-info/RECORD,,
+typedal-3.2.0.dist-info/METADATA,sha256=foiNGED0K4DE5WJOKqWZt693_ms7zMp8JO8GXbblkok,9316
+typedal-3.2.0.dist-info/WHEEL,sha256=uNdcs2TADwSd5pVaP0Z_kcjcvvTUklh2S7bxZMF8Uj0,87
+typedal-3.2.0.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-3.2.0.dist-info/RECORD,,

{typedal-3.1.4.dist-info → typedal-3.2.0.dist-info}/WHEEL

@@ -1,4 +1,4 @@
 Wheel-Version: 1.0
-Generator: hatchling 1.17.1
+Generator: hatchling 1.22.4
 Root-Is-Purelib: true
 Tag: py3-none-any