This package lets you use real Python (PEP435-style) enums with Django.
Installation
pip install django-enumfields
Included Tools
EnumField, EnumIntegerField
from enumfields import EnumField
from enum import Enum
class Color(Enum):
RED = 'r'
GREEN = 'g'
BLUE = 'b'
class MyModel(models.Model):
color = EnumField(Color, max_length=1)Elsewhere:
m = MyModel.objects.filter(color=Color.RED)EnumIntegerField works identically, but the underlying storage mechanism is an IntegerField instead of a CharField.
Usage in Forms
Call the formfield method to use an EnumField directly in a Form.
class MyForm(forms.Form):
color = EnumField(Color, max_length=1).formfield()Enum
Normally, you just use normal PEP435-style enums, however, django-enumfields also includes its own version of Enum with a few extra bells and whistles. Namely, the smart definition of labels which are used, for example, in admin dropdowns. By default, it will create labels by title-casing your constant names. You can provide custom labels with a nested “Labels” class.
from enumfields import EnumField, Enum # Our own Enum class
class Color(Enum):
RED = 'r'
GREEN = 'g'
BLUE = 'b'
class Labels:
RED = 'A custom label'
class MyModel(models.Model):
color = EnumField(Color, max_length=1)
assert Color.GREEN.label == 'Green'
assert Color.RED.label == 'A custom label'EnumFieldListFilter
enumfields.admin.EnumFieldListFilter is provided to allow using enums in list_filter.
from enumfields.admin import EnumFieldListFilter
class MyModelAdmin(admin.ModelAdmin):
list_filter = [('color', EnumFieldListFilter)]Django Rest Framework integration
EnumSupportSerializerMixin mixin allows you to use enums in DRF serializers.
# models.py
from enumfields import EnumField
from enum import Enum
class Color(Enum):
RED = 'r'
GREEN = 'g'
BLUE = 'b'
class MyModel(models.Model):
color = EnumField(Color, max_length=1)
# serializers.py
from enumfields.drf.serializers import EnumSupportSerializerMixin
from rest_framework import serializers
from .models import MyModel
class MyModelSerializer(EnumSupportSerializerMixin, serializers.ModelSerializer):
class Meta:
model = MyModel
fields = '__all__'
Release files for django-enumfields 2.1.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| django-enumfields-2.1.1.tar.gz | 14.0 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| django_enumfields-2.1.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 23.1 kB
Release files / django-enumfields-2.1.1.tar.gz
| Download URL | django-enumfields-2.1.1.tar.gz |
|---|---|
| Size | 14.0 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f64841732a9c343f5071220e0abcf5f51c9472c06e3c33d7c6a7ec27b6087561
|
|
BLAKE2b-256 checksum How to use checksums |
24a8aaf2b5ddb697c9bcab53c32cfebe11e536502e07c30646b4756e7214b685
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.0
|
Release files / django_enumfields-2.1.1-py3-none-any.whl
| Download URL | django_enumfields-2.1.1-py3-none-any.whl |
|---|---|
| Size | 9.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
d32f2151801a5fc13c860276ee99495c2c9345e0a4281d0104276c39ddb22807
|
|
BLAKE2b-256 checksum How to use checksums |
a40f30b3c47b88ebf4c9fcd5f0387f8982cc4adc39705232f745ebcc3fbe6172
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
twine/3.3.0 pkginfo/1.7.0 requests/2.25.1 setuptools/51.0.0 requests-toolbelt/0.9.1 tqdm/4.57.0 CPython/3.9.0
|
