Installation using pip:
pip install django-smalluuidTested on:
- Django >= 2.2 <= 4.0
- Python 3.7, 3.8, 3.9, 3.10
To get started use the SmallUUIDField field in your model definitions:
from django.db import models
from django_smalluuid.models import SmallUUIDField, uuid_default
class ExampleModel(models.Model):
uuid = SmallUUIDField(default=uuid_default())The field provides values as instances of SmallUUID (see smalluuid):
>>> obj = ExampleModel.objects.create()
# The initial UUID has been auto-generated by uuid_default()
>>> obj.uuid
SmallUUID('T1q_P6HcQNSyW6tpqJTxww')
# It is still available in the groupex hex form (if needed)
>>> obj.hex_grouped
'4f5abf3f-a1dc-40d4-b25b-ab69a894f1c3'
# Filtering is done on the shortened UUIDs
>>> ExampleModel.objects.filter(uuid='T1q_P6HcQNSyW6tpqJTxww')
[<ExampleModel: ExampleModel object>]django-smalluuid also supports the Typed UUID's as provided by smalluuid. This allows for the object's type to be stored within the UUID.
Updating the above example:
from django.db import models
from django_smalluuid.models import SmallUUIDField, uuid_typed_default
class TypedExampleModel(models.Model):
uuid = SmallUUIDField(default=uuid_typed_default(type=42))Which can be interacted with as follows:
>>> obj = TypedExampleModel.objects.create()
>>> obj.uuid
TypedSmallUUID('qvyk8nzbQfu8zAnTPQweyw')
>>> obj.uuid.type
42django-smalluuid is packaged using seed and relies upon smalluuid.