django-uidfield 0.3.2

django-uidfield is a library which includes class UIDField for models.

About

Pretty UID fields for your Django models, with customizable prefixes and controlled length. Tested vs. Python 3.5, 3.6, 3.7, 3.8, 3.9, 3.10 and Django 2.2, 3.1, 3.2, 4.0.

Usage

See examples below. You can optionally inherit your models from UIDModel, which gracefully handles IntegrityError on saving UIDs, making up to 3 attempts with random UIDs. Integrity errors should be pretty rare if you use large enough max_length on your fields, but you may still want to use it for extra safety:

from django_uidfield.fields import UIDField

class YourModel(models.Model):
    uid_field = UIDField(prefix='tmp_', max_length=20)

# the value will be like 'tmp_Akw81LmtPqS93dKb'

or:

from django_uidfield.models import UIDModel
from django_uidfield.fields import UIDField


class YourModel(UIDModel):
    uid_field = UIDField(prefix='tmp_', max_length=20)

Adding a UIDField to an existing model

You can populate the field with a data-migration:

def populate_uid(apps, schema_editor):
    User = apps.get_model("users", "User")

    for user in User.objects.all():
        user._meta.get_field("uid").populate(user, force_renew=True)
        user.save()


class Migration(migrations.Migration):
    operations = [migrations.RunPython(code=populate_uid)]

Note that the 3-attempt deduplication mechanism will not work, and you can get an error if you have a lot of objects and a small max_length.

Changelog

0.3.2

• use Django DB router capabilities to determine a correct DB when it isn’t explicitly passed to the UIDModel.save method

0.3.1

• fixed a bug when transactions were being started in the wrong database in the multi-db setup

• added django 4.0.x to the test matrix

0.3.0

• [BREAKING] drop support for Django 3.0

• add support for Python 3.9 and 3.10

• add support for Django 3.2

• starting this version, migrations for UIDField include prefix and chars arguments, specific for the field type. They are required for proper field usage in data migrations. As a side effect of this update, the makemigrations command will generate AlterField migrations for all existing UID fields in the project after upgrading from earlier versions. These migrations won’t perform any SQL queries, though.

0.2.0

• [BREAKING] UID fields defined as nullable will stop populate their value on the new model instance saving. If your code relied on the old behavior, please make sure that all your UID fields don’t have the null=True attribute or populate their values manually in save or in calling code.

• [BREAKING] Drop support for Django 1.8, 1.10, 1.11

• [BREAKING] Drop support for Python 2.7

• add support for Django 2.2, and 3.0 versions and Python 3.7, and 3.8 versions