Skip to content

Commit

Permalink
Restore cast-on-assign behavior on Django 1.8+
Browse files Browse the repository at this point in the history
Turns out the future-deprecated SubfieldBase class did more
than what was initially thought.  Since it is removed in
Django 1.10+, for clarity we no longer use it at all.
Instead we intern the behavior of its `Creator` descriptor
class as `CastOnAssignDescriptor`.

Fixes #60
Refs https://code.djangoproject.com/ticket/26807
Refs 8260050
  • Loading branch information
akx committed Jun 27, 2016
1 parent 9639aa6 commit 938545a
Showing 1 changed file with 24 additions and 2 deletions.
26 changes: 24 additions & 2 deletions enumfields/fields.py
Original file line number Diff line number Diff line change
Expand Up @@ -10,10 +10,28 @@
from .compat import import_string
from .forms import EnumChoiceField

metaclass = models.SubfieldBase if django.VERSION < (1, 8) else type

class CastOnAssignDescriptor(object):
"""
A property descriptor which ensures that `field.to_python()` is called on _every_ assignment to the field.
class EnumFieldMixin(six.with_metaclass(metaclass)):
This used to be provided by the `django.db.models.subclassing.Creator` class, which in turn
was used by the deprecated-in-Django-1.10 `SubfieldBase` class, hence the reimplementation here.
"""

def __init__(self, field):
self.field = field

def __get__(self, obj, type=None):
if obj is None:
return self
return obj.__dict__[self.field.name]

def __set__(self, obj, value):
obj.__dict__[self.field.name] = self.field.to_python(value)


class EnumFieldMixin(object):
def __init__(self, enum, **options):
if isinstance(enum, six.string_types):
self.enum = import_string(enum)
Expand All @@ -25,6 +43,10 @@ def __init__(self, enum, **options):

super(EnumFieldMixin, self).__init__(**options)

def contribute_to_class(self, cls, name):
super(EnumFieldMixin, self).contribute_to_class(cls, name)
setattr(cls, name, CastOnAssignDescriptor(self))

def to_python(self, value):
if value is None or value == '':
return None
Expand Down

0 comments on commit 938545a

Please sign in to comment.