django-display-ids 0.1.2__tar.gz → 0.1.3__tar.gz

{django_display_ids-0.1.2 → django_display_ids-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: django-display-ids
-Version: 0.1.2
+Version: 0.1.3
 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: ISC
@@ -17,7 +17,7 @@ Classifier: Programming Language :: Python :: 3.14
 Classifier: Typing :: Typed
 Requires-Dist: django>=4.2
 Requires-Python: >=3.12
-Project-URL: Source, https://joseph.is/django-display-ids
+Project-URL: Homepage, https://joseph.is/django-display-ids
 Description-Content-Type: text/markdown
 
 # django-display-ids
@@ -34,6 +34,8 @@ This library focuses on **lookup only** — it works with your existing UUID fie
 pip install django-display-ids
 ```
 
+No `INSTALLED_APPS` entry required — just import and use.
+
 ## Quick Start
 
 ```python
@@ -249,11 +251,13 @@ The `display_id` strategy requires a prefix. If no prefix is configured, the str
 |-----------|---------|-------------|
 | `lookup_param` / `lookup_url_kwarg` | `"pk"` | URL parameter name |
 | `lookup_strategies` | from settings | Strategies to try |
-| `display_id_prefix` | `None` | Expected prefix |
+| `display_id_prefix` | from model | Expected prefix (falls back to model's `display_id_prefix`) |
 | `uuid_field` | `"id"` | UUID field name on model |
 | `slug_field` | `"slug"` | Slug field name on model |
 
-### Django Settings
+### Django Settings (Optional)
+
+All settings have sensible defaults. Only add this if you need to override them:
 
 ```python
 # settings.py
@@ -298,10 +302,16 @@ Run tests:
 uv run pytest
 ```
 
+Run tests with coverage:
+
+```bash
+uv run pytest --cov=src/django_display_ids
+```
+
 Run tests across Python and Django versions:
 
 ```bash
-uvx nox -p
+uvx nox
 ```
 
 Lint and format:

{django_display_ids-0.1.2 → django_display_ids-0.1.3}/README.md

@@ -12,6 +12,8 @@ This library focuses on **lookup only** — it works with your existing UUID fie
 pip install django-display-ids
 ```
 
+No `INSTALLED_APPS` entry required — just import and use.
+
 ## Quick Start
 
 ```python
@@ -227,11 +229,13 @@ The `display_id` strategy requires a prefix. If no prefix is configured, the str
 |-----------|---------|-------------|
 | `lookup_param` / `lookup_url_kwarg` | `"pk"` | URL parameter name |
 | `lookup_strategies` | from settings | Strategies to try |
-| `display_id_prefix` | `None` | Expected prefix |
+| `display_id_prefix` | from model | Expected prefix (falls back to model's `display_id_prefix`) |
 | `uuid_field` | `"id"` | UUID field name on model |
 | `slug_field` | `"slug"` | Slug field name on model |
 
-### Django Settings
+### Django Settings (Optional)
+
+All settings have sensible defaults. Only add this if you need to override them:
 
 ```python
 # settings.py
@@ -276,10 +280,16 @@ Run tests:
 uv run pytest
 ```
 
+Run tests with coverage:
+
+```bash
+uv run pytest --cov=src/django_display_ids
+```
+
 Run tests across Python and Django versions:
 
 ```bash
-uvx nox -p
+uvx nox
 ```
 
 Lint and format:

{django_display_ids-0.1.2 → django_display_ids-0.1.3}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "django-display-ids"
-version = "0.1.2"
+version = "0.1.3"
 description = "Stripe-like prefixed IDs for Django. Works with existing UUIDs — no schema changes."
 readme = "README.md"
 requires-python = ">=3.12"
@@ -34,12 +34,13 @@ dependencies = [
 ]
 
 [project.urls]
-Source = "https://joseph.is/django-display-ids"
+Homepage = "https://joseph.is/django-display-ids"
 
 [dependency-groups]
 dev = [
     "pytest>=8.0",
     "pytest-django>=4.8",
+    "pytest-cov>=6.0",
     "djangorestframework>=3.14",
     "shortuuid>=1.0",
     "nox>=2024.0",

{django_display_ids-0.1.2 → django_display_ids-0.1.3}/src/django_display_ids/contrib/rest_framework/views.py

@@ -5,6 +5,7 @@ from __future__ import annotations
 from typing import TYPE_CHECKING, Any
 
 from django_display_ids.conf import get_setting
+from django_display_ids.encoding import PREFIX_PATTERN
 from django_display_ids.exceptions import (
     InvalidIdentifierError,
     LookupError,
@@ -21,6 +22,8 @@ __all__ = [
     "DisplayIDLookupMixin",
 ]
 
+_NOT_SET: Any = object()
+
 
 def _get_drf_exceptions() -> tuple[type[Exception], type[Exception]]:
     """Lazily import DRF exceptions to avoid hard dependency."""
@@ -68,7 +71,7 @@ class DisplayIDLookupMixin:
 
     lookup_url_kwarg: str = "pk"
     lookup_strategies: tuple[StrategyName, ...] | None = None
-    display_id_prefix: str | None = None
+    display_id_prefix: str | None = _NOT_SET
     uuid_field: str | None = None
     slug_field: str | None = None
 
@@ -91,6 +94,24 @@ class DisplayIDLookupMixin:
             return self.lookup_strategies
         return get_setting("STRATEGIES")  # type: ignore[return-value]
 
+    def _get_display_id_prefix(self, model: type[models.Model]) -> str | None:
+        """Get the display ID prefix.
+
+        Returns the viewset's display_id_prefix if set (including None to
+        explicitly disable), otherwise falls back to the model's
+        display_id_prefix attribute.
+        """
+        if self.display_id_prefix is not _NOT_SET:
+            if self.display_id_prefix is not None and not PREFIX_PATTERN.match(
+                self.display_id_prefix
+            ):
+                raise ValueError(
+                    f"display_id_prefix must be 1-16 lowercase letters, "
+                    f"got: {self.display_id_prefix!r}"
+                )
+            return self.display_id_prefix
+        return getattr(model, "display_id_prefix", None)
+
     def get_queryset(self) -> Any:
         """Get the base queryset.
 
@@ -138,7 +159,7 @@ class DisplayIDLookupMixin:
                 model=model,
                 value=str(value),
                 strategies=self._get_strategies(),
-                prefix=self.display_id_prefix,
+                prefix=self._get_display_id_prefix(model),
                 uuid_field=self._get_uuid_field(),
                 slug_field=self._get_slug_field(),
                 queryset=queryset,

{django_display_ids-0.1.2 → django_display_ids-0.1.3}/src/django_display_ids/models.py

@@ -7,7 +7,7 @@ from typing import ClassVar
 from django.db import models
 
 from .conf import get_setting
-from .encoding import encode_display_id
+from .encoding import PREFIX_PATTERN, encode_display_id
 
 __all__ = [
     "DisplayIDMixin",
@@ -92,6 +92,11 @@ class DisplayIDMixin(models.Model):
         if "display_id_prefix" in cls.__dict__:
             prefix = cls.__dict__["display_id_prefix"]
             if prefix is not None:
+                if not PREFIX_PATTERN.match(prefix):
+                    raise ValueError(
+                        f"{cls.__name__}.display_id_prefix must be 1-16 "
+                        f"lowercase letters, got: {prefix!r}"
+                    )
                 _register_prefix(prefix, cls.__name__)
 
     @classmethod

{django_display_ids-0.1.2 → django_display_ids-0.1.3}/src/django_display_ids/views.py

@@ -7,6 +7,7 @@ from typing import TYPE_CHECKING, Any
 from django.http import Http404
 
 from .conf import get_setting
+from .encoding import PREFIX_PATTERN
 from .exceptions import (
     InvalidIdentifierError,
     LookupError,
@@ -23,6 +24,8 @@ __all__ = [
     "DisplayIDObjectMixin",
 ]
 
+_NOT_SET: Any = object()
+
 
 class DisplayIDObjectMixin:
     """Mixin for Django CBVs that resolves objects by display ID, UUID, or slug.
@@ -49,7 +52,7 @@ class DisplayIDObjectMixin:
     model: type[models.Model] | None = None
     lookup_param: str = "pk"
     lookup_strategies: tuple[StrategyName, ...] | None = None
-    display_id_prefix: str | None = None
+    display_id_prefix: str | None = _NOT_SET
     uuid_field: str | None = None
     slug_field: str | None = None
 
@@ -68,6 +71,26 @@ class DisplayIDObjectMixin:
             return self.lookup_strategies
         return get_setting("STRATEGIES")  # type: ignore[return-value]
 
+    def _get_display_id_prefix(self) -> str | None:
+        """Get the display ID prefix.
+
+        Returns the view's display_id_prefix if set (including None to
+        explicitly disable), otherwise falls back to the model's
+        display_id_prefix attribute.
+        """
+        if self.display_id_prefix is not _NOT_SET:
+            if self.display_id_prefix is not None and not PREFIX_PATTERN.match(
+                self.display_id_prefix
+            ):
+                raise ValueError(
+                    f"display_id_prefix must be 1-16 lowercase letters, "
+                    f"got: {self.display_id_prefix!r}"
+                )
+            return self.display_id_prefix
+        if self.model is not None:
+            return getattr(self.model, "display_id_prefix", None)
+        return None
+
     # These may be provided by parent classes
     kwargs: dict[str, Any]
 
@@ -114,7 +137,7 @@ class DisplayIDObjectMixin:
                 model=self.model,
                 value=str(value),
                 strategies=self._get_strategies(),
-                prefix=self.display_id_prefix,
+                prefix=self._get_display_id_prefix(),
                 uuid_field=self._get_uuid_field(),
                 slug_field=self._get_slug_field(),
                 queryset=qs,