django-hashid-field

import os from django.db import models from django.conf import settings from hashid_field import HashidField, HashidAutoField # Minimal Django settings for the field to work if not settings.configured: settings.configure( DEBUG=True, SECRET_KEY='a-very-secret-key', INSTALLED_APPS=['django_hashid_field_test'], DATABASES={'default': {'ENGINE': 'django.db.backends.sqlite3', 'NAME': ':memory:'}}, HASHID_FIELD_SALT=os.environ.get('DJANGO_HASHID_FIELD_SALT', 'default-test-salt'), HASHID_FIELD_ALLOW_INT_LOOKUP=True ) class Product(models.Model): # Use HashidAutoField for a primary key (replaces integer ID) id = HashidAutoField(primary_key=True) name = models.CharField(max_length=255) price = models.DecimalField(max_digits=10, decimal_places=2) # Use HashidField for a non-primary key field # It stores an integer in the DB, but exposes a hashid string legacy_id = HashidField(null=True, blank=True) def __str__(self): return f"{self.name} ({self.id})" # Example usage (after makemigrations and migrate) # from django.db import connection # from django.apps import apps # apps.populate(settings.INSTALLED_APPS) # with connection.schema_editor() as schema_editor: # schema_editor.create_model(Product) # # product = Product.objects.create(name="Test Product", price=99.99, legacy_id=12345) # print(f"Created Product: {product.name}, Hashid ID: {product.id}, Legacy Hashid: {product.legacy_id}") # # # Look up by hashid string # retrieved_product = Product.objects.get(id=product.id) # print(f"Retrieved Product by hashid: {retrieved_product.name}") # # # Look up by underlying integer ID (if HASHID_FIELD_ALLOW_INT_LOOKUP is True) # retrieved_product_int = Product.objects.get(id=product.id.id) # print(f"Retrieved Product by int ID: {retrieved_product_int.name}")