django-display-ids 0.3.1__py3-none-any.whl → 0.3.2__py3-none-any.whl

django_display_ids/__init__.py

@@ -26,7 +26,14 @@ Example:
 from typing import Any
 
 from .admin import DisplayIDSearchMixin
-from .converters import DisplayIDConverter, DisplayIDOrUUIDConverter, UUIDConverter
+from .converters import (
+    DisplayIDConverter,
+    DisplayIDOrSlugConverter,
+    DisplayIDOrUUIDConverter,
+    DisplayIDOrUUIDOrSlugConverter,
+    make_display_id_or_slug_converter,
+    make_display_id_or_uuid_or_slug_converter,
+)
 from .encoding import (
     decode_display_id,
     decode_uuid,
@@ -69,8 +76,11 @@ def __getattr__(name: str) -> Any:
 __all__ = [  # noqa: RUF022 - keep categorized order for readability
     # URL converters
     "DisplayIDConverter",
-    "UUIDConverter",
+    "DisplayIDOrSlugConverter",
     "DisplayIDOrUUIDConverter",
+    "DisplayIDOrUUIDOrSlugConverter",
+    "make_display_id_or_slug_converter",
+    "make_display_id_or_uuid_or_slug_converter",
     # Encoding
     "encode_uuid",
     "decode_uuid",

django_display_ids/conf.py

@@ -14,19 +14,25 @@ from __future__ import annotations
 from typing import TYPE_CHECKING
 
 from django.conf import settings
+from django.urls.converters import SlugConverter
 
 if TYPE_CHECKING:
     from .typing import StrategyName
 
 __all__ = [
     "DEFAULTS",
+    "SLUG_REGEX",
     "get_setting",
 ]
 
+# Django's default slug regex pattern
+SLUG_REGEX: str = SlugConverter.regex
+
 DEFAULTS: dict[str, str | tuple[str, ...]] = {
     "UUID_FIELD": "id",
     "SLUG_FIELD": "slug",
     "STRATEGIES": ("display_id", "uuid"),
+    "SLUG_REGEX": SLUG_REGEX,
 }
 
 

django_display_ids/converters.py

@@ -2,14 +2,37 @@
 
 from __future__ import annotations
 
+from .conf import SLUG_REGEX
+
 __all__ = [
+    "DISPLAY_ID_REGEX",
+    "SLUG_REGEX",
     "DisplayIDConverter",
+    "DisplayIDOrSlugConverter",
     "DisplayIDOrUUIDConverter",
-    "UUIDConverter",
+    "DisplayIDOrUUIDOrSlugConverter",
+    "make_display_id_or_slug_converter",
+    "make_display_id_or_uuid_or_slug_converter",
 ]
 
+# Regex pattern constants
+DISPLAY_ID_REGEX = r"[a-z]{1,16}_[0-9A-Za-z]{22}"
+UUID_REGEX = r"[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
+
+
+class BaseConverter:
+    """Base class for URL path converters with pass-through conversion."""
+
+    def to_python(self, value: str) -> str:
+        """Convert the URL value to a Python object."""
+        return value
+
+    def to_url(self, value: str) -> str:
+        """Convert a Python object to a URL string."""
+        return value
+
 
-class DisplayIDConverter:
+class DisplayIDConverter(BaseConverter):
     """Path converter for display IDs.
 
     Matches the format: {prefix}_{base62} where prefix is 1-16 lowercase
@@ -26,86 +49,138 @@ class DisplayIDConverter:
         ]
     """
 
-    regex = r"[a-z]{1,16}_[0-9A-Za-z]{22}"
+    regex = DISPLAY_ID_REGEX
 
-    def to_python(self, value: str) -> str:
-        """Convert the URL value to a Python object."""
-        return value
 
-    def to_url(self, value: str) -> str:
-        """Convert a Python object to a URL string."""
-        return value
+class DisplayIDOrUUIDConverter(BaseConverter):
+    """Path converter for display IDs or UUIDs.
+
+    Matches either format:
+    - Display ID: {prefix}_{base62}
+    - UUID: hyphenated (e.g., 550e8400-e29b-41d4-a716-446655440000)
+
+    Example:
+        from django.urls import path, register_converter
+        from django_display_ids.converters import DisplayIDOrUUIDConverter
+
+        register_converter(DisplayIDOrUUIDConverter, "display_id_or_uuid")
+
+        urlpatterns = [
+            path("invoices/<display_id_or_uuid:id>/", InvoiceDetailView.as_view()),
+        ]
+    """
+
+    regex = rf"(?:{DISPLAY_ID_REGEX}|{UUID_REGEX})"
+
+
+class DisplayIDOrSlugConverter(BaseConverter):
+    """Path converter for display IDs or slugs.
+
+    Matches either format:
+    - Display ID: {prefix}_{base62}
+    - Slug: Django's default slug pattern [-a-zA-Z0-9_]+
+
+    Example:
+        from django.urls import path, register_converter
+        from django_display_ids.converters import DisplayIDOrSlugConverter
+
+        register_converter(DisplayIDOrSlugConverter, "display_id_or_slug")
+
+        urlpatterns = [
+            path("products/<display_id_or_slug:id>/", ProductDetailView.as_view()),
+        ]
+    """
 
+    regex = rf"(?:{DISPLAY_ID_REGEX}|{SLUG_REGEX})"
 
-class UUIDConverter:
-    """Path converter for UUIDs.
 
-    Matches UUIDs in both hyphenated and unhyphenated formats:
-    - 550e8400-e29b-41d4-a716-446655440000 (hyphenated)
-    - 550e8400e29b41d4a716446655440000 (unhyphenated)
+class DisplayIDOrUUIDOrSlugConverter(BaseConverter):
+    """Path converter for display IDs, UUIDs, or slugs.
+
+    Matches any of:
+    - Display ID: {prefix}_{base62}
+    - UUID: hyphenated (e.g., 550e8400-e29b-41d4-a716-446655440000)
+    - Slug: Django's default slug pattern [-a-zA-Z0-9_]+
 
     Example:
         from django.urls import path, register_converter
-        from django_display_ids.converters import UUIDConverter
+        from django_display_ids.converters import DisplayIDOrUUIDOrSlugConverter
 
-        register_converter(UUIDConverter, "uuid")
+        register_converter(DisplayIDOrUUIDOrSlugConverter, "identifier")
 
         urlpatterns = [
-            path("invoices/<uuid:id>/", InvoiceDetailView.as_view()),
+            path("products/<identifier:id>/", ProductDetailView.as_view()),
         ]
+    """
 
-    Note:
-        Django's built-in UUIDConverter only accepts hyphenated UUIDs.
-        This converter is more permissive.
+    regex = rf"(?:{DISPLAY_ID_REGEX}|{UUID_REGEX}|{SLUG_REGEX})"
+
+
+def make_display_id_or_slug_converter(
+    slug_regex: str | None = None,
+) -> type[DisplayIDOrSlugConverter]:
+    """Create a DisplayIDOrSlugConverter with a custom slug regex.
+
+    Args:
+        slug_regex: Custom slug regex pattern. If None, uses the
+            DISPLAY_IDS["SLUG_REGEX"] setting (defaults to Django's pattern).
+
+    Returns:
+        A DisplayIDOrSlugConverter subclass with the custom regex.
+
+    Example:
+        from django.urls import path, register_converter
+        from django_display_ids.converters import make_display_id_or_slug_converter
+
+        # Lowercase slugs only
+        LowercaseConverter = make_display_id_or_slug_converter(r"[a-z0-9-]+")
+        register_converter(LowercaseConverter, "display_id_or_slug")
+
+        urlpatterns = [
+            path("products/<display_id_or_slug:id>/", ProductDetailView.as_view()),
+        ]
     """
+    from .conf import get_setting
 
-    # Hyphenated: 8-4-4-4-12 hex chars with hyphens
-    # Unhyphenated: 32 hex chars
-    # Note: Parentheses group the alternatives so ^ and $ anchor correctly
-    regex = (
-        r"(?:[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}|[0-9a-f]{32})"
-    )
+    pattern = slug_regex if slug_regex is not None else get_setting("SLUG_REGEX")
 
-    def to_python(self, value: str) -> str:
-        """Convert the URL value to a Python object."""
-        return value
+    class CustomDisplayIDOrSlugConverter(DisplayIDOrSlugConverter):
+        regex = rf"(?:{DISPLAY_ID_REGEX}|{pattern})"
 
-    def to_url(self, value: str) -> str:
-        """Convert a Python object to a URL string."""
-        return value
+    return CustomDisplayIDOrSlugConverter
 
 
-class DisplayIDOrUUIDConverter:
-    """Path converter for display IDs or UUIDs.
+def make_display_id_or_uuid_or_slug_converter(
+    slug_regex: str | None = None,
+) -> type[DisplayIDOrUUIDOrSlugConverter]:
+    """Create a DisplayIDOrUUIDOrSlugConverter with a custom slug regex.
 
-    Matches either format:
-    - Display ID: {prefix}_{base62}
-    - UUID: hyphenated or unhyphenated
+    Args:
+        slug_regex: Custom slug regex pattern. If None, uses the
+            DISPLAY_IDS["SLUG_REGEX"] setting (defaults to Django's pattern).
+
+    Returns:
+        A DisplayIDOrUUIDOrSlugConverter subclass with the custom regex.
 
     Example:
         from django.urls import path, register_converter
-        from django_display_ids.converters import DisplayIDOrUUIDConverter
+        from django_display_ids.converters import (
+            make_display_id_or_uuid_or_slug_converter,
+        )
 
-        register_converter(DisplayIDOrUUIDConverter, "display_id_or_uuid")
+        # Lowercase slugs only
+        Converter = make_display_id_or_uuid_or_slug_converter(r"[a-z0-9-]+")
+        register_converter(Converter, "identifier")
 
         urlpatterns = [
-            path("invoices/<display_id_or_uuid:id>/", InvoiceDetailView.as_view()),
+            path("products/<identifier:id>/", ProductDetailView.as_view()),
         ]
     """
+    from .conf import get_setting
 
-    # Note: Parentheses group the alternatives so ^ and $ anchor correctly
-    regex = (
-        r"(?:"
-        r"[a-z]{1,16}_[0-9A-Za-z]{22}"
-        r"|[0-9a-f]{8}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{4}-[0-9a-f]{12}"
-        r"|[0-9a-f]{32}"
-        r")"
-    )
+    pattern = slug_regex if slug_regex is not None else get_setting("SLUG_REGEX")
 
-    def to_python(self, value: str) -> str:
-        """Convert the URL value to a Python object."""
-        return value
+    class CustomDisplayIDOrUUIDOrSlugConverter(DisplayIDOrUUIDOrSlugConverter):
+        regex = rf"(?:{DISPLAY_ID_REGEX}|{UUID_REGEX}|{pattern})"
 
-    def to_url(self, value: str) -> str:
-        """Convert a Python object to a URL string."""
-        return value
+    return CustomDisplayIDOrUUIDOrSlugConverter

{django_display_ids-0.3.1.dist-info → django_display_ids-0.3.2.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-display-ids
-Version: 0.3.1
+Version: 0.3.2
 Summary: Stripe-like prefixed IDs for Django. Works with existing UUIDs — no schema changes.
 Keywords: django,stripe,uuid,base62,prefixed-id,drf,shortuuid,nanoid,ulid
 License: MIT
@@ -123,8 +123,8 @@ See the [contributing guide](https://django-display-ids.readthedocs.io/en/latest
 
 If you need ID generation and storage (custom model fields), consider:
 
-- **[django-prefix-id](https://github.com/jaddison/django-prefix-id)** — PrefixIDField that generates and stores base62-encoded UUIDs
-- **[django-spicy-id](https://github.com/mik3y/django-spicy-id)** — Drop-in AutoField replacement
-- **[django-charid-field](https://github.com/yunojuno/django-charid-field)** — CharField wrapper supporting cuid, ksuid, ulid
+- [django-prefix-id](https://github.com/jaddison/django-prefix-id) — PrefixIDField that generates and stores base62-encoded UUIDs
+- [django-spicy-id](https://github.com/mik3y/django-spicy-id) — Drop-in AutoField replacement
+- [django-charid-field](https://github.com/yunojuno/django-charid-field) — CharField wrapper supporting cuid, ksuid, ulid
 
 **django-display-ids** works with existing UUID fields and handles resolution only — no migrations required.

{django_display_ids-0.3.1.dist-info → django_display_ids-0.3.2.dist-info}/RECORD

@@ -1,13 +1,13 @@
-django_display_ids/__init__.py,sha256=2qX0YC7Jwpoom5rLOhvOewR3GQEIbUhu5ZYwjfEoklo,3207
+django_display_ids/__init__.py,sha256=wwFvtGjdQia56uY893Jz5iSwaqyH4KXbgvd3nxdzGss,3496
 django_display_ids/admin.py,sha256=_voqWbr8AwPRC_uCTJWTcEhAhc7RZUgvs7DyVsutDuw,3046
 django_display_ids/apps.py,sha256=UqblGiYNONOIEH-giEAuKp1YDgxl2yf0jS0ELMj1iig,315
-django_display_ids/conf.py,sha256=Mg5ZIhTRSF5dzNO_iYndoF4_g5Umo-5oUw1vB76M7fw,1230
+django_display_ids/conf.py,sha256=6bHdUwDkuroYEPmOlPiAc49EcxlOG_QO0aHHawckOe8,1404
 django_display_ids/contrib/__init__.py,sha256=sxGJK8Whb6cL7RqACqGRYrIZvaMwP3l6dYk3mIYWzDY,62
 django_display_ids/contrib/drf_spectacular/__init__.py,sha256=21n56CH7tp2lKq4EGW99KVEgVB9fJ5GnfllUW_KrIe8,4003
 django_display_ids/contrib/rest_framework/__init__.py,sha256=Xun6zMhCZzQJZQ7ywvBYoKhTJIZEV84AntrbSWfBjYI,1567
 django_display_ids/contrib/rest_framework/serializers.py,sha256=Jp-z7qHafxkGNYv30YC9rrqLt936SrhONJv3rqfQaC0,4049
 django_display_ids/contrib/rest_framework/views.py,sha256=nDaze7MJwVqL0MrxQLOur3sPVrRXud_WT4ijGR02jDY,6087
-django_display_ids/converters.py,sha256=9xP3vKW1keN1glJvwmZun0BaBRLMKio0aD7Coc888ms,3197
+django_display_ids/converters.py,sha256=ElwrfA7DXiadSZ-Sjvl6ZALgH7tfEZ-tLI7UdE6MsAs,5797
 django_display_ids/encoding.py,sha256=csIwUZaQKSOLwRU6-DWGTNGvSxmroyK0Yt7TBCo0AFE,2945
 django_display_ids/examples.py,sha256=gap5NNPTmE7B5uxiYKoMoK8G-OEtL1Ek0W039l6oJ9I,2689
 django_display_ids/exceptions.py,sha256=nmyRfpsqVvz226Zcu_QANwr8MudbfoX09mAgOCwuPuQ,3022
@@ -20,6 +20,6 @@ django_display_ids/templatetags/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm
 django_display_ids/templatetags/display_ids.py,sha256=4KHE8r8mgSKb7LgIuXJaJB_3UGrzRZvTdLqSCYQtb5I,1157
 django_display_ids/typing.py,sha256=2O3kT7XKkiE7WI9A5KkILPM-Zi7-zCy5gVvXQL_J2mI,478
 django_display_ids/views.py,sha256=-y_Zwo4QLU0lPRPjABpijsze5vsG0CBvJtrVwVtuLwM,5127
-django_display_ids-0.3.1.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
-django_display_ids-0.3.1.dist-info/METADATA,sha256=eKOjG80Rb_fK-_FQtUYR67fyWGZlN5SzgZuhjD4RGDA,5295
-django_display_ids-0.3.1.dist-info/RECORD,,
+django_display_ids-0.3.2.dist-info/WHEEL,sha256=fAguSjoiATBe7TNBkJwOjyL1Tt4wwiaQGtNtjRPNMQA,80
+django_display_ids-0.3.2.dist-info/METADATA,sha256=qlsCntznDOhR1wMFyPhU2AAnWyodabq1nMHtQm2HczA,5283
+django_display_ids-0.3.2.dist-info/RECORD,,