Choices

Support for symmetrical property enumeration types derived from Django choice types. These choices types are drop in replacements for the Django IntegerChoices and TextChoices.

class django_enum.choices.FlagChoices(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: DecomposeMixin, DjangoSymmetricMixin, IntFlag, Choices

An integer flag enumeration type that accepts enum-properties property lists.

Note that on Pythons before 3.14 there is a quirk to the choices type where member tuples including the label are not unpacked on declaration. This means if you want to define composite fields on these versions it might look like this on Python < 3.14:

class MyFlag(FlagChoices):
    A = 1 << 0, "a"
    B = 1 << 1, "b"
    C = 1 << 2, "c"
    AB = A[0] | B[0], "ab"  # Python < 3.14
    BC = B[0] | C[0], "bc"  # Python < 3.14
    ABC = A[0] | B[0] | C[0], "abc"  # Python < 3.14

And this on Python >= 3.14:

class MyFlag(FlagChoices):
    A = 1 << 0, "a"
    B = 1 << 1, "b"
    C = 1 << 2, "c"
    AB = A | B, "ab"  # Python >= 3.14
    BC = B | C, "bc"  # Python >= 3.14
    ABC = A | B | C, "abc"  # Python >= 3.14

class django_enum.choices.FloatChoices(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: DjangoSymmetricMixin, float, Choices

A floating point enumeration type that accepts enum-properties property lists.

class django_enum.choices.IntegerChoices(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: DjangoSymmetricMixin, IntegerChoices

An integer enumeration type that extends Django’s IntegerChoices and accepts enum-properties property lists.

class django_enum.choices.TextChoices(new_class_name, /, names, *, module=None, qualname=None, type=None, start=1, boundary=None)

Bases: DjangoSymmetricMixin, TextChoices

A character enumeration type that extends Django’s TextChoices and accepts enum-properties property lists.