Random unique string ID mixin for Django models

base.py

# -*- coding: UTF-8 -*-
from __future__ import unicode_literals
import shortuuid

from django.conf import settings
from django.db import models
from django.utils.translation import ugettext_lazy as _


RANDOM_UNIQUE_ID_LENGTH = getattr(settings, "RANDOM_UNIQUE_ID_LENGTH", 12)


def get_new_id():
    return shortuuid.ShortUUID().random(length=RANDOM_UNIQUE_ID_LENGTH)


class RandomUniqueIdMixin(models.Model):
    id = models.CharField(
        _("ID"),
        primary_key=True,
        db_index=True,
        max_length=RANDOM_UNIQUE_ID_LENGTH,
        default=get_new_id,
    )

    class Meta:
        abstract = True

    def save(self, *args, **kwargs):
        if self._state.adding:
            # ensure that the id is unique
            while self.__class__.objects.filter(id=self.id).exists():
                self.id = get_new_id()
        # finally save the object
        super(RandomUniqueIdMixin, self).save(*args, **kwargs)

models.py

# -*- coding: UTF-8 -*-
"""
To use the RandomUniqueIdMixin mixin, extend it instead of models.Model
"""
from __future__ import unicode_literals

from django.db import models
from django.utils.translation import ugettext_lazy as _

from .base import RandomUniqueIdMixin

class Message(RandomUniqueIdMixin):
    # ...fields and methods here...

requirements.txt

shortuuid==0.5.0