fix #103 fix #104

Author: bckohan

justfile

@@ -39,7 +39,7 @@ install-precommit:
     @just run pre-commit install
 
 # update and install development dependencies
-install *OPTS:
+install *OPTS="--all-extras":
     uv sync {{ OPTS }}
     @just run pre-commit install
 

pyproject.toml

@@ -84,7 +84,8 @@ dev = [
     "deepdiff>=8.2.0",
     "django-extensions>=3.2.3",
     "django-stubs[compatible-mypy]>=5.1.3",
-    "django-test-migrations @ git+https://github.com/bckohan/django-test-migrations.git@issue-503#egg=django-test-migrations",
+    # todo - update when version > 1.4.0 released
+    "django-test-migrations @ git+https://github.com/wemake-services/django-test-migrations.git@master#egg=django-test-migrations",
     "djlint>=1.36.4",
     "ipdb>=0.13.13",
     "matplotlib>=3.9.4",

src/django_enum/fields.py

@@ -674,7 +674,7 @@ def formfield(self, form_class=None, choices_form_class=None, **kwargs):
 
         is_multi = self.enum and issubclass(self.enum, Flag)
         if is_multi:
-            kwargs["empty_value"] = self.enum(0)
+            kwargs["empty_value"] = None if self.null else self.enum(0)
             # why fail? - does this fail for single select too?
             # kwargs['show_hidden_initial'] = True
 
@@ -1256,6 +1256,10 @@ class EnumExtraBigIntegerField(IntEnumField, BinaryField):
 
     description = _("A bit field wider than the standard word size.")
 
+    def __init__(self, editable=True, **kwargs):
+        # Django disables form editing on BinaryFields by default, so we override
+        super().__init__(editable=editable, **kwargs)
+
     @cached_property
     def signed(self):
         """True if the enum has negative values"""

src/django_enum/forms.py

@@ -333,19 +333,16 @@ class EnumChoiceField(ChoiceFieldMixin, TypedChoiceField):  # type: ignore
 
 class EnumFlagField(ChoiceFieldMixin, TypedMultipleChoiceField):  # type: ignore
     """
-    The default ``TypedMultipleChoiceField`` will only accept the base
-    enumeration values. Use this field on forms to accept any value mappable
-    to an enumeration including any labels or symmetric properties.
+    A generic form field for :class:`~enum.Flag` derived enumerations. By default the
+    :class:`~django_enum.forms.FlagSelectMultiple` widget will be used.
 
-    Behavior:
+    After cleaning the value stored in the cleaned data will be a combined enum instance.
+    (e.g. all input flags will be or-ed together)
 
-    if no select value in post data:
-        if null=True, no choice is null.
-        If null=False, no choice is Enum(0)
-    if select value in post data:
-        if null=True or False, no choice is Enum(0)
+    .. note::
 
-    if strict=False, values can be outside of the enumerations
+        The default empty_value is Flag(0) but when used in a ModelForm the empty_value
+        will be automatically set to None if null=True.
     """
 
     widget = FlagSelectMultiple

tests/enum_prop/models.py

@@ -383,7 +383,8 @@ class SingleNoCoercePerf(models.Model):
 class BitFieldModel(models.Model):
     bit_field_small = EnumField(GNSSConstellation)
     bit_field_large = EnumField(LargeBitField, null=True, default=None, blank=True)
-    bit_field_large_neg = EnumField(
+    bit_field_large_empty_default = EnumField(LargeBitField, blank=True)
+    large_neg = EnumField(
         LargeNegativeField, default=LargeNegativeField.NEG_ONE, null=True
     )
     no_default = EnumField(LargeBitField)

tests/test_field_types_ep.py

@@ -23,16 +23,14 @@ def test_large_bitfields(self):
             tester._meta.get_field("bit_field_small"), PositiveSmallIntegerField
         )
         self.assertIsInstance(tester._meta.get_field("bit_field_large"), BinaryField)
-        self.assertIsInstance(
-            tester._meta.get_field("bit_field_large_neg"), BinaryField
-        )
+        self.assertIsInstance(tester._meta.get_field("large_neg"), BinaryField)
 
         self.assertEqual(
             tester.bit_field_small,
             GNSSConstellation.GPS | GNSSConstellation.GLONASS,
         )
         self.assertEqual(tester.bit_field_large, None)
-        self.assertEqual(tester.bit_field_large_neg, LargeNegativeField.NEG_ONE)
+        self.assertEqual(tester.large_neg, LargeNegativeField.NEG_ONE)
         self.assertEqual(tester.no_default, LargeBitField(0))
 
         self.assertEqual(
@@ -94,7 +92,7 @@ def test_large_bitfields(self):
         tester2 = BitFieldModel.objects.create(
             bit_field_small=GNSSConstellation.GPS | GNSSConstellation.GLONASS,
             bit_field_large=LargeBitField.ONE | LargeBitField.TWO,
-            bit_field_large_neg=None,
+            large_neg=None,
         )
 
         # has_any and has_all are not supported on ExtraLarge bit fields
@@ -107,14 +105,11 @@ def test_large_bitfields(self):
             )
 
         with self.assertRaises(FieldError):
-            BitFieldModel.objects.filter(
-                bit_field_large_neg__has_any=LargeNegativeField.NEG_ONE
-            )
+            BitFieldModel.objects.filter(large_neg__has_any=LargeNegativeField.NEG_ONE)
 
         with self.assertRaises(FieldError):
             BitFieldModel.objects.filter(
-                bit_field_large_neg__has_all=LargeNegativeField.NEG_ONE
-                | LargeNegativeField.ZERO
+                large_neg__has_all=LargeNegativeField.NEG_ONE | LargeNegativeField.ZERO
             )
 
 

tests/test_forms_ep.py

@@ -46,15 +46,44 @@ def test_flag_choices_admin_form(self):
         )
 
     def test_flag_choices_model_form(self):
+        from django.forms.models import fields_for_model
+        from django_enum.forms import EnumChoiceField, EnumFlagField
         from tests.examples.models.flag import Permissions
-        from tests.enum_prop.enums import GNSSConstellation
+        from tests.enum_prop.enums import (
+            GNSSConstellation,
+            LargeBitField,
+            LargeNegativeField,
+        )
 
         class FlagChoicesModelForm(ModelForm):
-            class Meta(EnumTesterForm.Meta):
+            class Meta:
+                fields = "__all__"
                 model = BitFieldModel
 
+        fields = fields_for_model(BitFieldModel)
+
+        self.assertEqual(len(fields), 5)
+
+        expected_types = {
+            "bit_field_small": EnumFlagField,
+            "bit_field_large": EnumFlagField,
+            "bit_field_large_empty_default": EnumFlagField,
+            "large_neg": EnumChoiceField,
+            "no_default": EnumFlagField,
+        }
+
+        for field, inst in fields.items():
+            self.assertIsInstance(inst, expected_types[field])
+
         form = FlagChoicesModelForm(
-            data={"bit_field_small": [GNSSConstellation.GPS, GNSSConstellation.GLONASS]}
+            data={
+                "bit_field_small": [
+                    GNSSConstellation.GPS.value,
+                    GNSSConstellation.GLONASS,
+                ],
+                "large_neg": LargeNegativeField.NEG_ONE.value,
+                "no_default": LargeBitField.TWO,
+            }
         )
 
         form.full_clean()
@@ -63,6 +92,21 @@ class Meta(EnumTesterForm.Meta):
             form.cleaned_data["bit_field_small"],
             GNSSConstellation.GPS | GNSSConstellation.GLONASS,
         )
+        self.assertIsInstance(form.cleaned_data["bit_field_small"], GNSSConstellation)
+        self.assertEqual(
+            form.cleaned_data["large_neg"],
+            LargeNegativeField.NEG_ONE,
+        )
+        self.assertIsInstance(form.cleaned_data["large_neg"], LargeNegativeField)
+        self.assertEqual(form.cleaned_data["no_default"], LargeBitField.TWO)
+        self.assertIsInstance(form.cleaned_data["no_default"], LargeBitField)
+        self.assertEqual(form.cleaned_data["bit_field_large"], None)
+        self.assertEqual(
+            form.cleaned_data["bit_field_large_empty_default"], LargeBitField(0)
+        )
+        self.assertIsInstance(
+            form.cleaned_data["bit_field_large_empty_default"], LargeBitField
+        )
         self.assertIsInstance(form.base_fields["bit_field_small"], EnumFlagField)
 
     def test_extern_flag_admin_form(self):