TypeDAL 3.9.4__py3-none-any.whl → 3.10.1__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.9.4"
+__version__ = "3.10.1"

typedal/mixins.py

@@ -11,6 +11,8 @@ import warnings
 from datetime import datetime
 from typing import Any, Optional
 
+from pydal import DAL
+from pydal.validators import IS_NOT_IN_DB, ValidationError
 from slugify import slugify
 
 from .core import (  # noqa F401 - used by example in docstring
@@ -87,6 +89,56 @@ def slug_random_suffix(length: int = 8) -> str:
     return base64.urlsafe_b64encode(os.urandom(length)).rstrip(b"=").decode().strip("=")
 
 
+T = typing.TypeVar("T")
+
+
+# noinspection PyPep8Naming
+class HAS_UNIQUE_SLUG(IS_NOT_IN_DB):
+    """
+    Checks if slugified field is already in the db.
+
+    Usage:
+        table.name = HAS_UNIQUE_SLUG(db, "table.slug")
+    """
+
+    def __init__(
+        self,
+        db: TypeDAL | DAL,
+        field: str,  # table.slug
+        error_message: str = "This slug is not unique: %s.",
+    ):
+        """
+        Based on IS_NOT_IN_DB but with less options and a different default error message.
+        """
+        super().__init__(db, field, error_message)
+
+    def validate(self, original: T, record_id: Optional[int] = None) -> T:
+        """
+        Performs checks to see if the slug already exists for a different row.
+        """
+        value = slugify(str(original))
+        if not value.strip():
+            raise ValidationError(self.translator(self.error_message))
+
+        (tablename, fieldname) = str(self.field).split(".")
+        table = self.dbset.db[tablename]
+        field = table[fieldname]
+        query = field == value
+
+        # make sure exclude the record_id
+        row_id = record_id or self.record_id
+        if isinstance(row_id, dict):  # pragma: no cover
+            row_id = table(**row_id)
+        if row_id is not None:
+            query &= table._id != row_id
+        subset = self.dbset(query)
+
+        if subset.count():
+            raise ValidationError(self.error_message % value)
+
+        return original
+
+
 class SlugMixin(Mixin):
     """
     (Opinionated) example mixin to add a 'slug' field, which depends on a user-provided other field.
@@ -139,26 +191,40 @@ class SlugMixin(Mixin):
         cls.__settings__["slug_field"] = slug_field
         cls.__settings__["slug_suffix"] = slug_suffix
 
+    @classmethod
+    def __generate_slug_before_insert(cls, row: OpRow) -> None:
+        settings = cls.__settings__
+
+        text_input = row[settings["slug_field"]]
+        generated_slug = slugify(text_input)
+
+        if suffix_len := settings["slug_suffix"]:
+            generated_slug += f"-{slug_random_suffix(suffix_len)}"
+
+        row["slug"] = slugify(generated_slug)
+        return None
+
     @classmethod
     def __on_define__(cls, db: TypeDAL) -> None:
         """
         When db is available, include a before_insert hook to generate and include a slug.
         """
         super().__on_define__(db)
+        settings = cls.__settings__
 
         # slugs should not be editable (for SEO reasons), so there is only a before insert hook:
-        def generate_slug_before_insert(row: OpRow) -> None:
-            settings = cls.__settings__
-
-            text_input = row[settings["slug_field"]]
-            generated_slug = slugify(text_input)
+        cls._before_insert.append(cls.__generate_slug_before_insert)
 
-            if suffix_len := settings["slug_suffix"]:
-                generated_slug += f"-{slug_random_suffix(suffix_len)}"
+        if settings["slug_suffix"] == 0:
+            # add a validator to the field that will be slugified:
+            slug_field = getattr(cls, settings["slug_field"])
+            current_requires = getattr(slug_field, "requires", None) or []
+            if not isinstance(current_requires, list):
+                current_requires = [current_requires]
 
-            row["slug"] = slugify(generated_slug)
+            current_requires.append(HAS_UNIQUE_SLUG(db, f"{cls}.slug"))
 
-        cls._before_insert.append(generate_slug_before_insert)
+            slug_field.requires = current_requires
 
     @classmethod
     def from_slug(cls: typing.Type[T_MetaInstance], slug: str, join: bool = True) -> Optional[T_MetaInstance]:

{typedal-3.9.4.dist-info → typedal-3.10.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: TypeDAL
-Version: 3.9.4
+Version: 3.10.1
 Summary: Typing support for PyDAL
 Project-URL: Documentation, https://typedal.readthedocs.io/
 Project-URL: Issues, https://github.com/trialandsuccess/TypeDAL/issues
@@ -19,7 +19,7 @@ Requires-Dist: configurable-json
 Requires-Dist: configuraptor>=1.26.2
 Requires-Dist: dill
 Requires-Dist: legacy-cgi; python_version >= '3.13'
-Requires-Dist: pydal
+Requires-Dist: pydal<20250215.1
 Requires-Dist: python-slugify
 Provides-Extra: all
 Requires-Dist: edwh-migrate[full]>=0.8.0; extra == 'all'

{typedal-3.9.4.dist-info → typedal-3.10.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-typedal/__about__.py,sha256=583NYmTPDE--uDZNTDHfBV8c7G0SNDrgHFd9WcC4P6c,206
+typedal/__about__.py,sha256=lfj40YAUn5B1Ndcb8s7gmDIHat_R1pkHfqFCP36BSKQ,207
 typedal/__init__.py,sha256=QQpLiVl9w9hm2LBxey49Y_tCF_VB2bScVaS_mCjYy54,366
 typedal/caching.py,sha256=SMcJsahLlZ79yykWCveERFx1ZJUNEKhA9SPmCTIuLp8,11798
 typedal/cli.py,sha256=wzyId6YwRyqfuJ2byxvl6YecDNaKpkLmo-R5HvRuTok,19265
@@ -8,12 +8,12 @@ typedal/fields.py,sha256=A4qt0aK4F_-UeOY-xJ0ObVY-tFEoLFy7TYRMHnp4g6o,6516
 typedal/for_py4web.py,sha256=plb08K6HmxbM1_5GuBFFzovAJIT7Q3g9ocNjUJOBngY,1946
 typedal/for_web2py.py,sha256=xn7zo6ImsmTkH6LacbjLQl2oqyBvP0zLqRxEJvMQk1w,1929
 typedal/helpers.py,sha256=uej96exzJ9qVBd6LudP8uJ_7Cmq6vKraerdKvSRBVjc,8128
-typedal/mixins.py,sha256=6QfeVBAk7J4uHSR82Ek_Bhq43hzxnrmLn6xqxZqYtMk,5757
+typedal/mixins.py,sha256=ySF55URmSMyUCdMhiQJSKjkz4s5XGaO1pvmpJAOLUSU,7821
 typedal/py.typed,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
 typedal/types.py,sha256=1FIgv1s0be0E8r5Wd9E1nvDvK4ETV8u2NlfI7_P6UUY,6752
 typedal/web2py_py4web_shared.py,sha256=VK9T8P5UwVLvfNBsY4q79ANcABv-jX76YKADt1Zz_co,1539
 typedal/serializers/as_json.py,sha256=ffo152W-sARYXym4BzwX709rrO2-QwKk2KunWY8RNl4,2229
-typedal-3.9.4.dist-info/METADATA,sha256=32kW1RYety5OYw9r2qVjFT0YfUuiSIdo46QfVFWDkNI,10439
-typedal-3.9.4.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
-typedal-3.9.4.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
-typedal-3.9.4.dist-info/RECORD,,
+typedal-3.10.1.dist-info/METADATA,sha256=upJmwQSLqLlRE74JHQZ7RQxYVZsT9GrS56kaK5Fz7UM,10451
+typedal-3.10.1.dist-info/WHEEL,sha256=1yFddiXMmvYK7QYTqtRNtX66WJ0Mz8PYEiEUoOUUxRY,87
+typedal-3.10.1.dist-info/entry_points.txt,sha256=m1wqcc_10rHWPdlQ71zEkmJDADUAnZtn7Jac_6mbyUc,44
+typedal-3.10.1.dist-info/RECORD,,