Skip to main content

Sanity for the django choices functionality.

Project description

https://secure.travis-ci.org/bigjason/django-choices.svg?branch=master https://coveralls.io/repos/bigjason/django-choices/badge.svg?branch=master&service=github Documentation Status

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.

Installation

You can install via PyPi or direct from the github repo.

To install with pip:

$ pip install django-choices

To install with easy_install:

$ easy_install django-choices

Basic 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.

Souce Code

The source code can be found on github.

Project details


Release history Release notifications

This version
History Node

1.6.0

History Node

1.5.1

History Node

1.5.0

History Node

1.4.4

History Node

1.4.3

History Node

1.4.2

History Node

1.4

History Node

1.3

History Node

1.2

History Node

1.1.12

History Node

1.1.11

History Node

1.1.9

History Node

1.1.8

History Node

1.1.7

History Node

1.1.6

History Node

1.1.2

History Node

1.1.1

History Node

1.1.0

History Node

1.0.5

History Node

1.0.0

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django_choices-1.6.0-py2.py3-none-any.whl (8.9 kB) Copy SHA256 hash SHA256 Wheel 3.6 Jul 12, 2017
django-choices-1.6.0.tar.gz (6.3 kB) Copy SHA256 hash SHA256 Source None Jul 12, 2017

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page