Django-Choices
Order and sanity for django model choices.
Django choices provides a declarative way of using the choices option on django fields. Read the full documentation on ReadTheDocs.
Note: Django 3.0 added enumeration types. This feature mostly replaces the need for Django-Choices. See also Adam Johnson's post on using them.
Installation
You can install via PyPi or direct from the github repo.
$ pip install django-choicesBasic Usage
To start you create a choices class. Then you point the choices property on your
fields to the choices attribute of the new class. Django will be able to use
the choices and you will be able to access the values by name. For example you
can replace this:
# In models.py
class Person(models.Model):
# Choices
PERSON_TYPE = (
("C", "Customer"),
("E", "Employee"),
("G", "Groundhog"),
)
# Fields
name = models.CharField(max_length=32)
type = models.CharField(max_length=1, choices=PERSON_TYPE)With this:
# In models.py
from djchoices import DjangoChoices, ChoiceItem
class Person(models.Model):
# Choices
class PersonType(DjangoChoices):
customer = ChoiceItem("C")
employee = ChoiceItem("E")
groundhog = ChoiceItem("G")
# Fields
name = models.CharField(max_length=32)
type = models.CharField(max_length=1, choices=PersonType.choices)You can use this elsewhere like this:
# Other code
Person.create(name="Phil", type=Person.PersonType.groundhog)You can use them without value, and the label will be used as value:
class Sample(DjangoChoices):
option_a = ChoiceItem()
option_b = ChoiceItem()
print(Sample.option_a) # "option_a"License
Licensed under the MIT License.
Source Code
The source code can be found on github.