Custom Django field for using enumerations of named constants
Project description
Provides an enumeration Django model field (using IntegerField) with reusable enums and transition validation.
Installation
Install django-enumfield in your python environment
$ pip install django-enumfield
Usage
Create an Enum-class and pass it as first argument to the Django model EnumField.
from django.db import models
from django_enumfield import enum
class BeerStyle(enum.Enum):
LAGER = 0
STOUT = 1
WEISSBIER = 2
class Beer(models.Model):
style = enum.EnumField(BeerStyle, default=BeerStyle.LAGER)
Beer.objects.create(style=BeerStyle.STOUT)
Beer.objects.filter(style=BeerStyle.STOUT)
You can use your own labels for Enum items
class Animals(enum.Enum):
CAT = 1
DOG = 2
labels = {
CAT: 'Cat',
DOG: 'Dog'
}
The Enum-class provides the possibility to use transition validation.
from django.db import models
from django_enumfield import enum
class PersonStatus(enum.Enum):
ALIVE = 1
DEAD = 2
REANIMATED = 3
_transitions = {
DEAD: (ALIVE,),
REANIMATED: (DEAD,)
}
class Person(models.Model):
status = enum.EnumField(PersonStatus)
These transitions state that a PersonStatus can only go to DEAD from ALIVE and to REANIMATED from DEAD.
person = Person.objects.create(status=PersonStatus.ALIVE)
try:
person.status = PersonStatus.REANIMATED
person.save()
except InvalidStatusOperationError:
print "Person status can not go from ALIVE to REANIMATED"
The Enum-class can also be used without the EnumField. This is very useful in Django form ChoiceFields.
from django.forms import Form
from django_enumfield import enum
class GenderEnum(enum.Enum):
MALE = 1
FEMALE = 2
labels = {
MALE: 'Male',
FEMALE: 'Female',
}
class PersonForm(forms.Form)
gender = forms.TypedChoiceField(choices=GenderEnum.choices(), coerce=int)
Rendering PersonForm in a template will generate a select-box with “Male” and “Female” as option labels for the gender field.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_enumfield-1.1.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | f8efb2b26ee95b18ba7b8f0e8d15f299e3fe9e98b718b6460aba896d436e502b |
|
MD5 | 471386623a2f8d49522db76bd97b82c0 |
|
BLAKE2b-256 | 47888f0efd4af30470264f5edb5323cf3a03c92e3b8079ff78606cbb5ab67314 |