no linting errors

Author: bckohan

README.rst

@@ -71,20 +71,21 @@ type for the given enumeration based on its value type and range. For example,
         int_enum = EnumField(IntEnum)
 
 
-``EnumField`` is more than just an alias. The fields are now assignable and
-accessible as their enumeration type rather than by-value:
+``EnumField`` *is more than just an alias. The fields are now assignable and
+accessible as their enumeration type rather than by-value:*
 
 .. code:: python
 
     instance = MyModel.objects.create(
-        txt_enum=TextEnum.VALUE1,
+        txt_enum=MyModel.TextEnum.VALUE1,
         int_enum=3  # by-value assignment also works
     )
+    instance.refresh_from_db()
 
-    instance.txt_enum == TextEnum('V1')
+    instance.txt_enum == MyModel.TextEnum('V1')
     instance.txt_enum.label == 'Value 1'
 
-    instance.int_enum == IntEnum['THREE']
+    instance.int_enum == MyModel.IntEnum['THREE']
     instance.int_enum.value == 3
 
 
@@ -96,7 +97,7 @@ possible very rich enumeration fields.
 .. code:: python
 
     from enum_properties import s
-    from django_enum import TextChoices  # use instead of django's TextChoices
+    from django_enum import TextChoices  # use instead of Django's TextChoices
     from django.db import models
 
     class MyModel(models.Model):
@@ -114,13 +115,14 @@ possible very rich enumeration fields.
 
         color = EnumField(Color)
 
-    instance = MyModel.objects.create(color=Color('FF0000'))
-    instance.color == Color('Red') == Color('R') == Color((1, 0, 0))
+    instance = MyModel.objects.create(color=MyModel.Color('FF0000'))
+    instance.color == MyModel.Color('Red') == MyModel.Color('R') == MyModel.Color((1, 0, 0))
 
     # save back by any symmetric value
     instance.color = 'FF0000'
-    instance.save()
+    instance.full_clean()
     instance.color.hex == 'ff0000'
+    instance.save()
 
 
 .. note::

django_enum/__init__.py

@@ -8,22 +8,22 @@
 
 *******************************************************************************
 """
+from django_enum.choices import (
+    DjangoEnumPropertiesMeta,
+    FloatChoices,
+    IntegerChoices,
+    TextChoices,
+)
 from django_enum.fields import (
+    EnumBigIntegerField,
+    EnumCharField,
     EnumField,
     EnumFloatField,
-    EnumCharField,
-    EnumSmallIntegerField,
     EnumIntegerField,
-    EnumBigIntegerField,
-    EnumPositiveSmallIntegerField,
+    EnumPositiveBigIntegerField,
     EnumPositiveIntegerField,
-    EnumPositiveBigIntegerField
-)
-from django_enum.choices import (
-    TextChoices,
-    IntegerChoices,
-    FloatChoices,
-    DjangoEnumPropertiesMeta
+    EnumPositiveSmallIntegerField,
+    EnumSmallIntegerField,
 )
 from django_enum.forms import EnumChoiceField
 

django_enum/choices.py

@@ -3,46 +3,78 @@
 types. These choices types are drop in replacements for the Django
 IntegerChoices and TextChoices.
 """
-from enum_properties import (
-    SymmetricMixin,
-    EnumPropertiesMeta
-)
 from django.db.models import Choices
 from django.db.models import IntegerChoices as DjangoIntegerChoices
 from django.db.models import TextChoices as DjangoTextChoices
 from django.db.models.enums import ChoicesMeta
 
+try:
+    from enum_properties import EnumPropertiesMeta, SymmetricMixin
 
-class DjangoEnumPropertiesMeta(EnumPropertiesMeta, ChoicesMeta):
-    """Derive """
-    pass
 
+    class DjangoEnumPropertiesMeta(EnumPropertiesMeta, ChoicesMeta):
+        """
+        A composite meta class that combines Django's Choices metaclass with
+        enum-properties metaclass. This metaclass will add Django's expected
+        choices attribute and label properties to enumerations and
+        enum-properties' generic property support.
+        """
 
-class DjangoSymmetricMixin(SymmetricMixin):
-    _symmetric_builtins_ = ['name', 'label']
 
+    class DjangoSymmetricMixin(SymmetricMixin):
+        """
+        An enumeration mixin that makes Django's Choices type label field
+        symmetric.
+        """
+        _symmetric_builtins_ = ['name', 'label']
 
-class TextChoices(
-    DjangoSymmetricMixin,
-    DjangoTextChoices,
-    metaclass=DjangoEnumPropertiesMeta
-):
-    pass
 
+    class TextChoices(
+        DjangoSymmetricMixin,
+        DjangoTextChoices,
+        metaclass=DjangoEnumPropertiesMeta
+    ):
+        """
+        A character enumeration type that extends Django's TextChoices and
+        accepts enum-properties property lists.
+        """
 
-class IntegerChoices(
-    DjangoSymmetricMixin,
-    DjangoIntegerChoices,
-    metaclass=DjangoEnumPropertiesMeta
-):
-    pass
 
+    class IntegerChoices(
+        DjangoSymmetricMixin,
+        DjangoIntegerChoices,
+        metaclass=DjangoEnumPropertiesMeta
+    ):
+        """
+        An integer enumeration type that extends Django's IntegerChoices and
+        accepts enum-properties property lists.
+        """
 
-class FloatChoices(
-    DjangoSymmetricMixin,
-    float,
-    Choices,
-    metaclass=DjangoEnumPropertiesMeta
-):
-    pass
 
+    class FloatChoices(
+        DjangoSymmetricMixin,
+        float,
+        Choices,
+        metaclass=DjangoEnumPropertiesMeta
+    ):
+        """
+        A floating point enumeration type that accepts enum-properties
+        property lists.
+        """
+
+except (ImportError, ModuleNotFoundError):
+
+    class MissingEnumProperties:
+        """Throw error if choice types are used without enum-properties"""
+
+        def __init__(self, *args, **kwargs):
+            raise ImportError(
+                f'{self.__class__.__name__} requires enum-properties to be '
+                f'installed.'
+            )
+
+    DjangoEnumPropertiesMeta = MissingEnumProperties
+    DjangoSymmetricMixin = MissingEnumProperties
+    TextChoices = MissingEnumProperties
+    IntegerChoices = MissingEnumProperties
+    FloatChoices = MissingEnumProperties