Skip to main content

Django field that set/get django's new TextChoices/IntegerChoices enum.

Project description

django-choices-field

build status coverage PyPI version python version django version

Django field that set/get django's new TextChoices/IntegerChoices enum.

Install

pip install django-choices-field

Usage

import enum

from django.db import models
from django_choices_field import TextChoicesField, IntegerChoicesField, IntegerChoicesFlag


class MyModel(models.Model):
    class TextEnum(models.TextChoices):
        FOO = "foo", "Foo Description"
        BAR = "bar", "Bar Description"

    class IntegerEnum(models.IntegerChoices):
        FIRST = 1, "First Description"
        SECOND = 2, "Second Description"

    class IntegerFlagEnum(IntegerChoicesFlag):
        FIRST = enum.auto(), "First Option"
        SECOND = enum.auto(), "Second Option"
        THIRD = enum.auto(), "Third Option"

    text_field = TextChoicesField(
        choices_enum=TextEnum,
        default=TextEnum.FOO,
    )
    integer_field = IntegerChoicesField(
        choices_enum=IntegerEnum,
        default=IntegerEnum.FIRST,
    )
    flag_field = IntegerChoicesFlagField(
        choices_enum=IntegerFlagEnum,
        default=IntegerFlagEnum.FIRST | IntegerFlagEnum.SECOND,
    )


obj = MyModel()
reveal_type(obj.text_field)  # MyModel.TextEnum.FOO
assert isinstance(obj.text_field, MyModel.TextEnum)
assert obj.text_field == "foo"

reveal_type(obj.integer_field)  # MyModel.IntegerEnum.FIRST
assert isinstance(obj.integer_field, MyModel.IntegerEnum)
assert obj.integer_field == 1

reveal_type(obj.flag_field)  # MyModel.IntegerFlagEnum.FIRST | MyModel.IntegerFlagEnum.SECOND
assert isinstance(obj.integer_field, MyModel.IntegerFlagEnum)
assert obj.flag_field == 3

NOTE: The IntegerChoicesFlag requires python 3.11+ to work properly.

License

This project is licensed under MIT licence (see LICENSE for more info)

Contributing

Make sure to have poetry installed.

Install dependencies with:

poetry install

Run the testsuite with:

poetry run pytest

Feel free to fork the project and send me pull requests with new features, corrections and translations. I'll gladly merge them and release new versions ASAP.

Project details


Download files

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

Source Distribution

django_choices_field-2.2.1.tar.gz (5.5 kB view details)

Uploaded Source

Built Distribution

django_choices_field-2.2.1-py3-none-any.whl (6.0 kB view details)

Uploaded Python 3

File details

Details for the file django_choices_field-2.2.1.tar.gz.

File metadata

  • Download URL: django_choices_field-2.2.1.tar.gz
  • Upload date:
  • Size: 5.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.5.1 CPython/3.8.2 Linux/5.15.0-1040-azure

File hashes

Hashes for django_choices_field-2.2.1.tar.gz
Algorithm Hash digest
SHA256 e0fcab302700dc798286f452f027e07b2c7614a362bb47c3e05e54c714808f62
MD5 b319d7d5482130ad1d108d1dcb9c449b
BLAKE2b-256 34543ef49589cf3bcaae1d3ee30455f44143e223ff124cef586f17bbcf5392fd

See more details on using hashes here.

File details

Details for the file django_choices_field-2.2.1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_choices_field-2.2.1-py3-none-any.whl
Algorithm Hash digest
SHA256 02ae613c0acd539a5c4a54763808f51a922868c792f9e12541707a5ad40a43d5
MD5 ceaaa4904fdd378ba2e2faeaec960bbb
BLAKE2b-256 1643d0d9cfe0574e7edf04e246687be14e22e4743ba6212ce9679eaf9a811d0a

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page