from datetime import datetime from django.db import models from django.db.models.base import ModelBase from django.contrib.contenttypes.models import ContentType from django.utils.translation import ugettext_lazy as _ from django.db.models.fields import FieldDoesNotExist from model_utils.managers import QueryManager from model_utils.fields import AutoCreatedField, AutoLastModifiedField, \ StatusField, StatusModifedField class InheritanceCastModel(models.Model): """ An abstract base class that provides a ``real_type`` FK to ContentType. For use in trees of inherited models, to be able to downcast parent instances to their child types. """ real_type = models.ForeignKey(ContentType, editable=False, null=True) def save(self, *args, **kwargs): if not self.id: self.real_type = self._get_real_type() super(InheritanceCastModel, self).save(*args, **kwargs) def _get_real_type(self): return ContentType.objects.get_for_model(type(self)) def cast(self): return self.real_type.get_object_for_this_type(pk=self.pk) class Meta: abstract = True class TimeStampedModel(models.Model): """ An abstract base class model that provides self-updating ``created`` and ``modified`` fields. """ created = AutoCreatedField(_('created')) modified = AutoLastModifiedField(_('modified')) class Meta: abstract = True class TimeFramedBaseModel(ModelBase): """ A model base class for the ``TimeFramedModel`` that adds a special model manager ``timeframed`` for time frames. """ def _prepare(cls): super(TimeFramedBaseModel, cls)._prepare() try: cls._meta.get_field('timeframed') raise ValueError("Model %s has a field named 'timeframed' and " "conflicts with a manager." % cls.__name__) except FieldDoesNotExist: pass cls.add_to_class('timeframed', QueryManager( (models.Q(start__lte=datetime.now()) | models.Q(start__isnull=True)) & (models.Q(end__gte=datetime.now()) | models.Q(end__isnull=True)) )) class TimeFramedModel(models.Model): """ An abstract base class model that provides ``start`` and ``end`` fields to record a timeframe. """ __metaclass__ = TimeFramedBaseModel start = models.DateTimeField(_('start'), null=True, blank=True) end = models.DateTimeField(_('end'), null=True, blank=True) class Meta: abstract = True class StatusBaseModel(ModelBase): """ A model base class for the ``StatusModel`` to add a series of model managers for each given status. """ def _prepare(cls): super(StatusBaseModel, cls)._prepare() status = getattr(cls, 'STATUS', ()) if status is None: return for value, name in status: try: cls._meta.get_field(name) raise ValueError("Model %s has a field named '%s' and " "conflicts with a status." % (cls.__name__, name)) except FieldDoesNotExist: pass cls.add_to_class(value, QueryManager(**{'status': value})) class StatusModel(models.Model): """ An abstract base class model that provides self-updating status fields like ``deleted`` and ``restored``. """ __metaclass__ = StatusBaseModel status = StatusField(_('status')) status_date = StatusModifedField(_('status date')) def __unicode__(self): return self.get_status_display() class Meta: abstract = True