django-display-ids 0.1.4__tar.gz → 0.3.0__tar.gz

django_display_ids-0.3.0/PKG-INFO

@@ -0,0 +1,130 @@
+Metadata-Version: 2.3
+Name: django-display-ids
+Version: 0.3.0
+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
+Classifier: Development Status :: 4 - Beta
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.2
+Classifier: Framework :: Django :: 6.0
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Typing :: Typed
+Requires-Dist: django>=4.2
+Requires-Python: >=3.12
+Project-URL: Documentation, https://django-display-ids.readthedocs.io/
+Project-URL: Repository, https://github.com/josephabrahams/django-display-ids
+Description-Content-Type: text/markdown
+
+# django-display-ids
+
+[![PyPI](https://img.shields.io/pypi/v/django-display-ids)](https://pypi.org/project/django-display-ids/)
+[![Python](https://img.shields.io/pypi/pyversions/django-display-ids)](https://pypi.org/project/django-display-ids/)
+[![Django](https://img.shields.io/badge/django-4.2%20%7C%205.2%20%7C%206.0-blue)](https://pypi.org/project/django-display-ids/)
+[![CI](https://github.com/josephabrahams/django-display-ids/actions/workflows/ci.yml/badge.svg)](https://github.com/josephabrahams/django-display-ids/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/josephabrahams/django-display-ids/graph/badge.svg)](https://codecov.io/gh/josephabrahams/django-display-ids)
+[![Docs](https://readthedocs.org/projects/django-display-ids/badge/?version=stable)](https://django-display-ids.readthedocs.io/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/josephabrahams/django-display-ids/blob/main/LICENSE)
+
+Stripe-like prefixed IDs for Django. Works with existing UUIDs — no schema changes.
+
+## Why?
+
+UUIDv7 (native in Python 3.14+) offers excellent database performance with time-ordered indexing. But they lack context — seeing `550e8400-e29b-41d4-a716-446655440000` in a URL or log doesn't tell you what kind of object it refers to.
+
+Display IDs like `inv_2aUyqjCzEIiEcYMKj7TZtw` are more useful: the prefix identifies the object type at a glance, and they're compact and URL-safe. But storing display IDs in the database is far less efficient than native UUIDs.
+
+Different consumers have different needs:
+- **Humans** prefer slugs (`my-invoice`) or display IDs (`inv_xxx`)
+- **APIs and integrations** work well with UUIDs
+
+This library gives you the best of both worlds: accept any format in your URLs and API endpoints, then translate to an efficient UUID lookup in the database. Store UUIDs, expose whatever format your users need.
+
+## Installation
+
+```bash
+pip install django-display-ids
+```
+
+Add to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "django_display_ids",
+]
+```
+
+## Quick Start
+
+**Django views:**
+
+```python
+from django.views.generic import DetailView
+from django_display_ids import DisplayIDObjectMixin
+
+class InvoiceDetailView(DisplayIDObjectMixin, DetailView):
+    model = Invoice
+    lookup_param = "id"
+    lookup_strategies = ("display_id", "uuid", "slug")
+    display_id_prefix = "inv"
+```
+
+**Django REST Framework:**
+
+```python
+from rest_framework.viewsets import ModelViewSet
+from django_display_ids.contrib.rest_framework import DisplayIDLookupMixin
+
+class InvoiceViewSet(DisplayIDLookupMixin, ModelViewSet):
+    queryset = Invoice.objects.all()
+    serializer_class = InvoiceSerializer
+    lookup_url_kwarg = "id"
+    lookup_strategies = ("display_id", "uuid", "slug")
+    display_id_prefix = "inv"
+```
+
+Now your views accept:
+- `inv_2aUyqjCzEIiEcYMKj7TZtw` (display ID)
+- `550e8400-e29b-41d4-a716-446655440000` (UUID)
+- `my-invoice-slug` (slug)
+
+**Templates:**
+
+```django
+{% load display_ids %}
+
+{{ invoice.display_id }}                       {# inv_2aUyqjCzEIiEcYMKj7TZtw #}
+{{ order.customer_id|display_id:"cust" }}      {# encode any UUID #}
+```
+
+## Features
+
+- **Multiple identifier formats**: display ID (`prefix_base62uuid`), UUID (v4/v7), slug
+- **Framework support**: Django CBVs and Django REST Framework
+- **Template filter**: Encode UUIDs as display IDs in templates
+- **Zero model changes required**: Works with any existing UUID field
+- **OpenAPI integration**: Automatic schema generation with drf-spectacular
+
+## Documentation
+
+Full documentation at [django-display-ids.readthedocs.io](https://django-display-ids.readthedocs.io/).
+
+## Contributing
+
+See the [contributing guide](https://django-display-ids.readthedocs.io/en/latest/contributing.html).
+
+## Related Projects
+
+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-display-ids** works with existing UUID fields and handles resolution only — no migrations required.

django_display_ids-0.3.0/README.md

@@ -0,0 +1,107 @@
+# django-display-ids
+
+[![PyPI](https://img.shields.io/pypi/v/django-display-ids)](https://pypi.org/project/django-display-ids/)
+[![Python](https://img.shields.io/pypi/pyversions/django-display-ids)](https://pypi.org/project/django-display-ids/)
+[![Django](https://img.shields.io/badge/django-4.2%20%7C%205.2%20%7C%206.0-blue)](https://pypi.org/project/django-display-ids/)
+[![CI](https://github.com/josephabrahams/django-display-ids/actions/workflows/ci.yml/badge.svg)](https://github.com/josephabrahams/django-display-ids/actions/workflows/ci.yml)
+[![codecov](https://codecov.io/gh/josephabrahams/django-display-ids/graph/badge.svg)](https://codecov.io/gh/josephabrahams/django-display-ids)
+[![Docs](https://readthedocs.org/projects/django-display-ids/badge/?version=stable)](https://django-display-ids.readthedocs.io/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-blue.svg)](https://github.com/josephabrahams/django-display-ids/blob/main/LICENSE)
+
+Stripe-like prefixed IDs for Django. Works with existing UUIDs — no schema changes.
+
+## Why?
+
+UUIDv7 (native in Python 3.14+) offers excellent database performance with time-ordered indexing. But they lack context — seeing `550e8400-e29b-41d4-a716-446655440000` in a URL or log doesn't tell you what kind of object it refers to.
+
+Display IDs like `inv_2aUyqjCzEIiEcYMKj7TZtw` are more useful: the prefix identifies the object type at a glance, and they're compact and URL-safe. But storing display IDs in the database is far less efficient than native UUIDs.
+
+Different consumers have different needs:
+- **Humans** prefer slugs (`my-invoice`) or display IDs (`inv_xxx`)
+- **APIs and integrations** work well with UUIDs
+
+This library gives you the best of both worlds: accept any format in your URLs and API endpoints, then translate to an efficient UUID lookup in the database. Store UUIDs, expose whatever format your users need.
+
+## Installation
+
+```bash
+pip install django-display-ids
+```
+
+Add to `INSTALLED_APPS`:
+
+```python
+INSTALLED_APPS = [
+    # ...
+    "django_display_ids",
+]
+```
+
+## Quick Start
+
+**Django views:**
+
+```python
+from django.views.generic import DetailView
+from django_display_ids import DisplayIDObjectMixin
+
+class InvoiceDetailView(DisplayIDObjectMixin, DetailView):
+    model = Invoice
+    lookup_param = "id"
+    lookup_strategies = ("display_id", "uuid", "slug")
+    display_id_prefix = "inv"
+```
+
+**Django REST Framework:**
+
+```python
+from rest_framework.viewsets import ModelViewSet
+from django_display_ids.contrib.rest_framework import DisplayIDLookupMixin
+
+class InvoiceViewSet(DisplayIDLookupMixin, ModelViewSet):
+    queryset = Invoice.objects.all()
+    serializer_class = InvoiceSerializer
+    lookup_url_kwarg = "id"
+    lookup_strategies = ("display_id", "uuid", "slug")
+    display_id_prefix = "inv"
+```
+
+Now your views accept:
+- `inv_2aUyqjCzEIiEcYMKj7TZtw` (display ID)
+- `550e8400-e29b-41d4-a716-446655440000` (UUID)
+- `my-invoice-slug` (slug)
+
+**Templates:**
+
+```django
+{% load display_ids %}
+
+{{ invoice.display_id }}                       {# inv_2aUyqjCzEIiEcYMKj7TZtw #}
+{{ order.customer_id|display_id:"cust" }}      {# encode any UUID #}
+```
+
+## Features
+
+- **Multiple identifier formats**: display ID (`prefix_base62uuid`), UUID (v4/v7), slug
+- **Framework support**: Django CBVs and Django REST Framework
+- **Template filter**: Encode UUIDs as display IDs in templates
+- **Zero model changes required**: Works with any existing UUID field
+- **OpenAPI integration**: Automatic schema generation with drf-spectacular
+
+## Documentation
+
+Full documentation at [django-display-ids.readthedocs.io](https://django-display-ids.readthedocs.io/).
+
+## Contributing
+
+See the [contributing guide](https://django-display-ids.readthedocs.io/en/latest/contributing.html).
+
+## Related Projects
+
+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-display-ids** works with existing UUID fields and handles resolution only — no migrations required.

{django_display_ids-0.1.4 → django_display_ids-0.3.0}/pyproject.toml

@@ -1,10 +1,10 @@
 [project]
 name = "django-display-ids"
-version = "0.1.4"
+version = "0.3.0"
 description = "Stripe-like prefixed IDs for Django. Works with existing UUIDs — no schema changes."
 readme = "README.md"
 requires-python = ">=3.12"
-license = { text = "ISC" }
+license = { text = "MIT" }
 keywords = [
     "django",
     "stripe",
@@ -22,7 +22,7 @@ classifiers = [
     "Framework :: Django :: 4.2",
     "Framework :: Django :: 5.2",
     "Framework :: Django :: 6.0",
-    "License :: OSI Approved :: ISC License (ISCL)",
+    "License :: OSI Approved :: MIT License",
     "Programming Language :: Python :: 3",
     "Programming Language :: Python :: 3.12",
     "Programming Language :: Python :: 3.13",
@@ -34,7 +34,8 @@ dependencies = [
 ]
 
 [project.urls]
-Homepage = "https://joseph.is/django-display-ids"
+Documentation = "https://django-display-ids.readthedocs.io/"
+Repository = "https://github.com/josephabrahams/django-display-ids"
 
 [dependency-groups]
 dev = [
@@ -47,14 +48,32 @@ dev = [
     "nox>=2024.0",
     "ruff>=0.8",
     "pre-commit>=4.0",
+    "mypy>=1.13",
+    "django-stubs>=5.1",
+    "djangorestframework-stubs>=3.15",
+    "sphinx-autobuild",
+]
+docs = [
+    "sphinx>=7.0",
+    "furo",
+    "sphinx-copybutton",
 ]
 
 [build-system]
 requires = ["uv_build>=0.9.26,<0.10.0"]
 build-backend = "uv_build"
 
-[tool.uv]
-default-groups = ["dev"]
+[tool.django-stubs]
+django_settings_module = "tests.settings"
+
+[tool.mypy]
+python_version = "3.12"
+plugins = ["mypy_django_plugin.main", "mypy_drf_plugin.main"]
+strict = true
+
+[[tool.mypy.overrides]]
+module = "tests.*"
+disable_error_code = ["no-untyped-def"]
 
 [tool.pytest.ini_options]
 DJANGO_SETTINGS_MODULE = "tests.settings"
@@ -93,3 +112,6 @@ known-first-party = ["django_display_ids"]
 [tool.ruff.format]
 quote-style = "double"
 indent-style = "space"
+
+[tool.uv]
+default-groups = ["dev", "docs"]

{django_display_ids-0.1.4 → django_display_ids-0.3.0}/src/django_display_ids/__init__.py

@@ -23,7 +23,10 @@ Example:
         display_id_prefix = "inv"
 """
 
+from typing import Any
+
 from .admin import DisplayIDSearchMixin
+from .converters import DisplayIDConverter, DisplayIDOrUUIDConverter, UUIDConverter
 from .encoding import (
     decode_display_id,
     decode_uuid,
@@ -45,12 +48,29 @@ from .exceptions import (
     UnknownPrefixError,
 )
 from .managers import DisplayIDManager, DisplayIDQuerySet
-from .models import DisplayIDMixin, get_model_for_prefix
 from .resolver import resolve_object
 from .typing import DEFAULT_STRATEGIES, StrategyName
 from .views import DisplayIDObjectMixin
 
+
+def __getattr__(name: str) -> Any:
+    """Lazy import for model-related items to avoid app registry issues."""
+    if name == "DisplayIDMixin":
+        from .models import DisplayIDMixin
+
+        return DisplayIDMixin
+    if name == "get_model_for_prefix":
+        from .models import get_model_for_prefix
+
+        return get_model_for_prefix
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
 __all__ = [  # noqa: RUF022 - keep categorized order for readability
+    # URL converters
+    "DisplayIDConverter",
+    "UUIDConverter",
+    "DisplayIDOrUUIDConverter",
     # Encoding
     "encode_uuid",
     "decode_uuid",
@@ -85,10 +105,8 @@ __all__ = [  # noqa: RUF022 - keep categorized order for readability
     "DEFAULT_STRATEGIES",
 ]
 
-__version__ = "0.1.1"
-
 
-def get_drf_mixin():
+def get_drf_mixin() -> type:
     """Lazily import the DRF mixin to avoid hard dependency.
 
     Returns:

{django_display_ids-0.1.4 → django_display_ids-0.3.0}/src/django_display_ids/admin.py

@@ -4,12 +4,12 @@ from __future__ import annotations
 
 import contextlib
 import uuid
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from .encoding import decode_display_id
 
 if TYPE_CHECKING:
-    from django.db.models import QuerySet
+    from django.db.models import Model, QuerySet
     from django.http import HttpRequest
 
 __all__ = ["DisplayIDSearchMixin"]
@@ -39,13 +39,15 @@ class DisplayIDSearchMixin:
     """
 
     uuid_field: str | None = None
+    model: type[Model]
 
     def _get_uuid_field(self) -> str:
         """Get the UUID field name to search."""
         if self.uuid_field is not None:
             return self.uuid_field
         # Try to get from model's uuid_field attribute
-        return getattr(self.model, "uuid_field", None) or "id"
+        uuid_field: str | None = getattr(self.model, "uuid_field", None)
+        return uuid_field or "id"
 
     def _try_parse_uuid(self, value: str) -> uuid.UUID | None:
         """Try to parse a string as a UUID."""
@@ -57,16 +59,16 @@ class DisplayIDSearchMixin:
     def get_search_results(
         self,
         request: HttpRequest,
-        queryset: QuerySet,
+        queryset: QuerySet[Any],
         search_term: str,
-    ) -> tuple[QuerySet, bool]:
+    ) -> tuple[QuerySet[Any], bool]:
         """Extend search to handle display IDs and raw UUIDs.
 
         Tries to match the search term as:
         1. A display ID (prefix_base62uuid) if it contains an underscore
         2. A raw UUID if it looks like a UUID format
         """
-        queryset, use_distinct = super().get_search_results(
+        queryset, use_distinct = super().get_search_results(  # type: ignore[misc]
             request, queryset, search_term
         )
 

django_display_ids-0.3.0/src/django_display_ids/apps.py

@@ -0,0 +1,11 @@
+"""Django app configuration for django-display-ids."""
+
+from django.apps import AppConfig
+
+
+class DjangoDisplayIdsConfig(AppConfig):
+    """App configuration for django-display-ids."""
+
+    name = "django_display_ids"
+    verbose_name = "Django Display IDs"
+    default_auto_field = "django.db.models.BigAutoField"

{django_display_ids-0.1.4 → django_display_ids-0.3.0}/src/django_display_ids/conf.py

@@ -45,5 +45,8 @@ def get_setting(name: str) -> str | tuple[StrategyName, ...]:
     if name not in DEFAULTS:
         raise KeyError(f"Unknown setting: {name}")
 
-    user_settings = getattr(settings, "DISPLAY_IDS", {})
-    return user_settings.get(name, DEFAULTS[name])
+    user_settings: dict[str, str | tuple[str, ...]] = getattr(
+        settings, "DISPLAY_IDS", {}
+    )
+    result = user_settings.get(name, DEFAULTS[name])
+    return result  # type: ignore[return-value]

{django_display_ids-0.1.4 → django_display_ids-0.3.0}/src/django_display_ids/contrib/drf_spectacular/__init__.py

@@ -6,16 +6,21 @@ proper OpenAPI schema generation for DisplayIDField.
 
 from __future__ import annotations
 
+from typing import TYPE_CHECKING, Any
+
 try:
     from drf_spectacular.extensions import OpenApiSerializerFieldExtension
 except ImportError:
     # drf-spectacular not installed, skip extension registration
     pass
 else:
+    if TYPE_CHECKING:
+        from drf_spectacular.openapi import AutoSchema
+
     from django_display_ids.encoding import ENCODED_UUID_LENGTH, encode_uuid
     from django_display_ids.examples import example_uuid_for_prefix
 
-    class DisplayIDFieldExtension(OpenApiSerializerFieldExtension):
+    class DisplayIDFieldExtension(OpenApiSerializerFieldExtension):  # type: ignore[no-untyped-call]
         """OpenAPI schema extension for DisplayIDField.
 
         Generates schema with correct prefix example based on the field's
@@ -27,7 +32,7 @@ else:
         )
         match_subclasses = True
 
-        def _get_model_from_view(self, auto_schema):
+        def _get_model_from_view(self, auto_schema: AutoSchema | None) -> Any:
             """Try to get model from the view's queryset."""
             if auto_schema is None:
                 return None
@@ -48,7 +53,9 @@ else:
                 return queryset.model
             return None
 
-        def map_serializer_field(self, auto_schema, direction):
+        def map_serializer_field(
+            self, auto_schema: AutoSchema, direction: str
+        ) -> dict[str, Any]:
             """Generate OpenAPI schema for DisplayIDField."""
             # Get prefix from field override or try to get from model
             prefix = self.target._prefix_override

{django_display_ids-0.1.4 → django_display_ids-0.3.0}/src/django_display_ids/contrib/rest_framework/serializers.py

@@ -95,9 +95,9 @@ class DisplayIDField(serializers.SerializerMethodField):
         # If using prefix override, generate display_id with that prefix
         if self._prefix_override is not None:
             # Get uuid_field name from model, then fall back to settings
-            uuid_field_name = getattr(obj, "uuid_field", None)
+            uuid_field_name: str | None = getattr(obj, "uuid_field", None)
             if uuid_field_name is None:
-                uuid_field_name = get_setting("UUID_FIELD")
+                uuid_field_name = str(get_setting("UUID_FIELD"))
             uuid_value = getattr(obj, uuid_field_name, None)
             if uuid_value is None:
                 raise ValueError(
@@ -108,7 +108,8 @@ class DisplayIDField(serializers.SerializerMethodField):
 
         # Use the model's display_id property
         if hasattr(obj, "display_id"):
-            return obj.display_id
+            display_id: str = obj.display_id
+            return display_id
 
         raise ValueError(
             f"Cannot generate display_id: {obj.__class__.__name__} "

{django_display_ids-0.1.4 → django_display_ids-0.3.0}/src/django_display_ids/contrib/rest_framework/views.py

@@ -174,4 +174,4 @@ class DisplayIDLookupMixin:
         # Check object-level permissions
         self.check_object_permissions(self.request, obj)
 
-        return obj
+        return obj  # type: ignore[no-any-return]

django_display_ids-0.3.0/src/django_display_ids/converters.py

@@ -0,0 +1,111 @@
+"""Django URL path converters for display IDs and UUIDs."""
+
+from __future__ import annotations
+
+__all__ = [
+    "DisplayIDConverter",
+    "DisplayIDOrUUIDConverter",
+    "UUIDConverter",
+]
+
+
+class DisplayIDConverter:
+    """Path converter for display IDs.
+
+    Matches the format: {prefix}_{base62} where prefix is 1-16 lowercase
+    letters and base62 is exactly 22 alphanumeric characters.
+
+    Example:
+        from django.urls import path, register_converter
+        from django_display_ids.converters import DisplayIDConverter
+
+        register_converter(DisplayIDConverter, "display_id")
+
+        urlpatterns = [
+            path("invoices/<display_id:id>/", InvoiceDetailView.as_view()),
+        ]
+    """
+
+    regex = r"[a-z]{1,16}_[0-9A-Za-z]{22}"
+
+    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 UUIDConverter:
+    """Path converter for UUIDs.
+
+    Matches UUIDs in both hyphenated and unhyphenated formats:
+    - 550e8400-e29b-41d4-a716-446655440000 (hyphenated)
+    - 550e8400e29b41d4a716446655440000 (unhyphenated)
+
+    Example:
+        from django.urls import path, register_converter
+        from django_display_ids.converters import UUIDConverter
+
+        register_converter(UUIDConverter, "uuid")
+
+        urlpatterns = [
+            path("invoices/<uuid:id>/", InvoiceDetailView.as_view()),
+        ]
+
+    Note:
+        Django's built-in UUIDConverter only accepts hyphenated UUIDs.
+        This converter is more permissive.
+    """
+
+    # 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})"
+    )
+
+    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:
+    """Path converter for display IDs or UUIDs.
+
+    Matches either format:
+    - Display ID: {prefix}_{base62}
+    - UUID: hyphenated or unhyphenated
+
+    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()),
+        ]
+    """
+
+    # 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")"
+    )
+
+    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

{django_display_ids-0.1.4 → django_display_ids-0.3.0}/src/django_display_ids/examples.py

@@ -26,7 +26,7 @@ def _get_prefix(prefix_or_model: str | type[Model]) -> str:
     if isinstance(prefix_or_model, str):
         return prefix_or_model
     # It's a model class
-    prefix = getattr(prefix_or_model, "display_id_prefix", None)
+    prefix: str | None = getattr(prefix_or_model, "display_id_prefix", None)
     if prefix is None:
         raise ValueError(f"Model {prefix_or_model.__name__} has no display_id_prefix")
     return prefix