django-namedid 0.1.0__tar.gz

django_namedid-0.1.0/LICENSE

@@ -0,0 +1,22 @@
+MIT License
+
+Copyright (c) 2025 Octolo
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.
+

django_namedid-0.1.0/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: django-namedid
+Version: 0.1.0
+Summary: Django field that combines multiple fields into a unique identifier with collision handling
+Author-email: Octolo <dev@octolo.tech>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/octolo/django-namedid
+Project-URL: Repository, https://github.com/octolo/django-namedid
+Project-URL: Documentation, https://github.com/octolo/django-namedid#readme
+Project-URL: Issues, https://github.com/octolo/django-namedid/issues
+Keywords: django,django-field,unique-identifier,composite-field,named-id,slug-generation,django-orm,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=3.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-django>=4.5; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: django-stubs>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+# django-namedid
+
+Django field that automatically combines multiple fields into a unique identifier with collision handling.
+
+## Purpose
+
+Create unique identifiers by combining multiple model fields (e.g., name, id, date) with automatic collision resolution.
+
+## Installation
+
+```bash
+pip install django-namedid
+```
+
+## Quick Start
+
+### Using NamedIDField directly
+
+```python
+from django.db import models
+from namedid import NamedIDField
+from datetime import date
+
+class Product(models.Model):
+    name = models.CharField(max_length=100)
+    code = models.IntegerField()
+    created_date = models.DateField()
+    
+    named_id = NamedIDField(
+        source_fields=["name", "code", "created_date"],
+        max_length=200,
+    )
+```
+
+### Using the decorator
+
+```python
+from django.db import models
+from namedid import add_namedid
+
+@add_namedid(named_id=["title", "id"], slug=["title", "category"])
+class Article(models.Model):
+    title = models.CharField(max_length=200)
+    category = models.CharField(max_length=50)
+    content = models.TextField()
+```
+
+## Features
+
+- **Automatic generation**: Values are generated automatically before saving
+- **Collision handling**: Automatically appends numeric suffix if value exists (e.g., `name-1-2023`, `name-1-2023-1`, `name-1-2023-2`)
+- **Type formatting**: Automatically formats dates, numbers, booleans
+- **Unique and required**: Fields are always unique and cannot be empty
+- **Read-only**: Fields are automatically set to read-only
+
+## Field Properties
+
+- `unique=True`: Always unique
+- `editable=False`: Always read-only
+- `blank=False`: Cannot be empty
+- `null=False`: Cannot be NULL
+
+## Development
+
+```bash
+./service.py dev install-dev
+./service.py dev test
+```
+
+## License
+
+MIT

django_namedid-0.1.0/README.md

@@ -0,0 +1,72 @@
+# django-namedid
+
+Django field that automatically combines multiple fields into a unique identifier with collision handling.
+
+## Purpose
+
+Create unique identifiers by combining multiple model fields (e.g., name, id, date) with automatic collision resolution.
+
+## Installation
+
+```bash
+pip install django-namedid
+```
+
+## Quick Start
+
+### Using NamedIDField directly
+
+```python
+from django.db import models
+from namedid import NamedIDField
+from datetime import date
+
+class Product(models.Model):
+    name = models.CharField(max_length=100)
+    code = models.IntegerField()
+    created_date = models.DateField()
+    
+    named_id = NamedIDField(
+        source_fields=["name", "code", "created_date"],
+        max_length=200,
+    )
+```
+
+### Using the decorator
+
+```python
+from django.db import models
+from namedid import add_namedid
+
+@add_namedid(named_id=["title", "id"], slug=["title", "category"])
+class Article(models.Model):
+    title = models.CharField(max_length=200)
+    category = models.CharField(max_length=50)
+    content = models.TextField()
+```
+
+## Features
+
+- **Automatic generation**: Values are generated automatically before saving
+- **Collision handling**: Automatically appends numeric suffix if value exists (e.g., `name-1-2023`, `name-1-2023-1`, `name-1-2023-2`)
+- **Type formatting**: Automatically formats dates, numbers, booleans
+- **Unique and required**: Fields are always unique and cannot be empty
+- **Read-only**: Fields are automatically set to read-only
+
+## Field Properties
+
+- `unique=True`: Always unique
+- `editable=False`: Always read-only
+- `blank=False`: Cannot be empty
+- `null=False`: Cannot be NULL
+
+## Development
+
+```bash
+./service.py dev install-dev
+./service.py dev test
+```
+
+## License
+
+MIT

django_namedid-0.1.0/pyproject.toml

@@ -0,0 +1,81 @@
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "django-namedid"
+version = "0.1.0"
+description = "Django field that combines multiple fields into a unique identifier with collision handling"
+readme = "README.md"
+authors = [{ name = "Octolo", email = "dev@octolo.tech" }]
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.10"
+keywords = [
+    "django",
+    "django-field",
+    "unique-identifier",
+    "composite-field",
+    "named-id",
+    "slug-generation",
+    "django-orm",
+    "python",
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Framework :: Django",
+    "Framework :: Django :: 3.2",
+    "Framework :: Django :: 4.0",
+    "Framework :: Django :: 4.1",
+    "Framework :: Django :: 4.2",
+    "Framework :: Django :: 5.0",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+    "Topic :: Internet :: WWW/HTTP :: Dynamic Content",
+]
+dependencies = [
+    "Django>=3.2",
+]
+
+[project.urls]
+Homepage = "https://github.com/octolo/django-namedid"
+Repository = "https://github.com/octolo/django-namedid"
+Documentation = "https://github.com/octolo/django-namedid#readme"
+Issues = "https://github.com/octolo/django-namedid/issues"
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.3",
+    "pytest-django>=4.5",
+    "ruff>=0.5",
+    "mypy>=1.0",
+    "django-stubs>=5.0.0",
+]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["namedid*"]
+exclude = ["tests*"]
+
+[tool.pytest.ini_options]
+DJANGO_SETTINGS_MODULE = "tests.settings"
+testpaths = ["tests"]
+pythonpath = ["src"]
+
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+plugins = ["mypy_django_plugin.main"]
+mypy_path = "src"
+
+[tool.django-stubs]
+django_settings_module = "tests.settings"
+
+[tool.ruff]
+line-length = 100
+target-version = "py310"
+

django_namedid-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

django_namedid-0.1.0/src/django_namedid.egg-info/PKG-INFO

@@ -0,0 +1,109 @@
+Metadata-Version: 2.4
+Name: django-namedid
+Version: 0.1.0
+Summary: Django field that combines multiple fields into a unique identifier with collision handling
+Author-email: Octolo <dev@octolo.tech>
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/octolo/django-namedid
+Project-URL: Repository, https://github.com/octolo/django-namedid
+Project-URL: Documentation, https://github.com/octolo/django-namedid#readme
+Project-URL: Issues, https://github.com/octolo/django-namedid/issues
+Keywords: django,django-field,unique-identifier,composite-field,named-id,slug-generation,django-orm,python
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Framework :: Django
+Classifier: Framework :: Django :: 3.2
+Classifier: Framework :: Django :: 4.0
+Classifier: Framework :: Django :: 4.1
+Classifier: Framework :: Django :: 4.2
+Classifier: Framework :: Django :: 5.0
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: Django>=3.2
+Provides-Extra: dev
+Requires-Dist: pytest>=8.3; extra == "dev"
+Requires-Dist: pytest-django>=4.5; extra == "dev"
+Requires-Dist: ruff>=0.5; extra == "dev"
+Requires-Dist: mypy>=1.0; extra == "dev"
+Requires-Dist: django-stubs>=5.0.0; extra == "dev"
+Dynamic: license-file
+
+# django-namedid
+
+Django field that automatically combines multiple fields into a unique identifier with collision handling.
+
+## Purpose
+
+Create unique identifiers by combining multiple model fields (e.g., name, id, date) with automatic collision resolution.
+
+## Installation
+
+```bash
+pip install django-namedid
+```
+
+## Quick Start
+
+### Using NamedIDField directly
+
+```python
+from django.db import models
+from namedid import NamedIDField
+from datetime import date
+
+class Product(models.Model):
+    name = models.CharField(max_length=100)
+    code = models.IntegerField()
+    created_date = models.DateField()
+    
+    named_id = NamedIDField(
+        source_fields=["name", "code", "created_date"],
+        max_length=200,
+    )
+```
+
+### Using the decorator
+
+```python
+from django.db import models
+from namedid import add_namedid
+
+@add_namedid(named_id=["title", "id"], slug=["title", "category"])
+class Article(models.Model):
+    title = models.CharField(max_length=200)
+    category = models.CharField(max_length=50)
+    content = models.TextField()
+```
+
+## Features
+
+- **Automatic generation**: Values are generated automatically before saving
+- **Collision handling**: Automatically appends numeric suffix if value exists (e.g., `name-1-2023`, `name-1-2023-1`, `name-1-2023-2`)
+- **Type formatting**: Automatically formats dates, numbers, booleans
+- **Unique and required**: Fields are always unique and cannot be empty
+- **Read-only**: Fields are automatically set to read-only
+
+## Field Properties
+
+- `unique=True`: Always unique
+- `editable=False`: Always read-only
+- `blank=False`: Cannot be empty
+- `null=False`: Cannot be NULL
+
+## Development
+
+```bash
+./service.py dev install-dev
+./service.py dev test
+```
+
+## License
+
+MIT

django_namedid-0.1.0/src/django_namedid.egg-info/SOURCES.txt

@@ -0,0 +1,11 @@
+LICENSE
+README.md
+pyproject.toml
+src/django_namedid.egg-info/PKG-INFO
+src/django_namedid.egg-info/SOURCES.txt
+src/django_namedid.egg-info/dependency_links.txt
+src/django_namedid.egg-info/requires.txt
+src/django_namedid.egg-info/top_level.txt
+src/namedid/__init__.py
+src/namedid/decorators.py
+src/namedid/fields.py

django_namedid-0.1.0/src/django_namedid.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

django_namedid-0.1.0/src/django_namedid.egg-info/requires.txt

@@ -0,0 +1,8 @@
+Django>=3.2
+
+[dev]
+pytest>=8.3
+pytest-django>=4.5
+ruff>=0.5
+mypy>=1.0
+django-stubs>=5.0.0

django_namedid-0.1.0/src/django_namedid.egg-info/top_level.txt

@@ -0,0 +1 @@
+namedid

django_namedid-0.1.0/src/namedid/__init__.py

@@ -0,0 +1,11 @@
+"""Django NamedID - Field that combines multiple fields into a unique identifier."""
+
+__version__ = "0.1.0"
+
+from .decorators import add_namedid
+from .fields import NamedIDField
+
+__all__ = [
+    "NamedIDField",
+    "add_namedid",
+]

django_namedid-0.1.0/src/namedid/decorators.py

@@ -0,0 +1,22 @@
+from __future__ import annotations
+
+from typing import Callable, TypeVar
+
+from .fields import NamedIDField
+
+T = TypeVar("T")
+
+
+def add_namedid(**fields_config: list[str]) -> Callable[[type[T]], type[T]]:
+    """Decorator to automatically add NamedIDField fields to a Django model."""
+
+    def decorator(cls: type[T]) -> type[T]:
+        for field_name, source_fields in fields_config.items():
+            field = NamedIDField(
+                source_fields=source_fields,
+                max_length=255,
+            )
+            cls.add_to_class(field_name, field)  # type: ignore[attr-defined]
+        return cls
+
+    return decorator

django_namedid-0.1.0/src/namedid/fields.py

@@ -0,0 +1,88 @@
+from __future__ import annotations
+
+import re
+from datetime import date, datetime
+from typing import Any
+
+from django.db import models
+from django.utils.translation import gettext_lazy as _
+
+
+class NamedIDField(models.CharField):
+    """Field that combines multiple fields into a unique identifier with collision handling."""
+
+    def __init__(
+        self,
+        source_fields: list[str],
+        separator: str = "-",
+        *args: Any,
+        **kwargs: Any,
+    ) -> None:
+        self.source_fields = source_fields
+        self.separator = separator
+        kwargs["editable"] = False
+        kwargs.setdefault("blank", False)
+        kwargs.setdefault("null", False)
+        kwargs.setdefault("unique", True)
+        super().__init__(*args, **kwargs)
+
+    def pre_save(self, model_instance: Any, add: bool) -> str:
+        base_value = self._generate_base_value(model_instance)
+        if not base_value:
+            raise ValueError(
+                _("Cannot generate named_id: all source fields %(fields)s are None or empty")
+                % {"fields": self.source_fields}
+            )
+
+        field_name = self.attname
+        model_class = model_instance.__class__
+
+        query = model_class.objects.filter(**{field_name: base_value})
+        if not add and hasattr(model_instance, "pk") and model_instance.pk:
+            query = query.exclude(pk=model_instance.pk)
+
+        if not query.exists():
+            return base_value
+
+        counter = 1
+        while True:
+            candidate = f"{base_value}{self.separator}{counter}"
+            query = model_class.objects.filter(**{field_name: candidate})
+            if not add and hasattr(model_instance, "pk") and model_instance.pk:
+                query = query.exclude(pk=model_instance.pk)
+            if not query.exists():
+                return candidate
+            counter += 1
+
+    def _generate_base_value(self, model_instance: Any) -> str:
+        values = []
+        for field_name in self.source_fields:
+            value = getattr(model_instance, field_name, None)
+            if value is not None:
+                formatted_value = self._format_value(value)
+                values.append(str(formatted_value))
+        return self.separator.join(values)
+
+    def _format_value(self, value: Any) -> str:
+        if isinstance(value, (date, datetime)):
+            return value.strftime("%Y%m%d")
+        if isinstance(value, (int, float)):
+            return str(value)
+        if isinstance(value, bool):
+            return "1" if value else "0"
+        string_value = str(value)
+        string_value = string_value.lower()
+        string_value = string_value.replace(" ", self.separator)
+        string_value = re.sub(r'[^\w\-]', '', string_value)
+        string_value = re.sub(rf'{re.escape(self.separator)}+', self.separator, string_value)
+        string_value = string_value.strip(self.separator)
+        return string_value
+
+    def deconstruct(self):
+        name, path, args, kwargs = super().deconstruct()
+        kwargs['source_fields'] = self.source_fields
+        if self.separator != "-":  # Only include if non-default
+            kwargs['separator'] = self.separator
+        # Remove editable since it's always False
+        kwargs.pop('editable', None)
+        return name, path, args, kwargs