Skip to main content

Real Python Enums for Django.

Project description

This package lets you use real Python (PEP435-style) enums with Django.

Installation

  1. pip install django-enumfields

Included Tools

EnumField, EnumIntegerField

from enumfields import EnumField
from enum import Enum  # Uses Ethan Furman's "enum34" backport

class MyModel(models.Model):

    class Color(Enum):
        RED = 'r'
        GREEN = 'g'
        BLUE = 'b'

    color = EnumField(Color, max_length=1)

Elsewhere:

m = MyModel.objects.filter(color=MyModel.Color.RED)

EnumIntegerField works identically, but the underlying storage mechanism is an IntegerField instead of a CharField.

Enum

Normally, you just use normal PEP435-style enums, however, django-enumfields also encludes 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 MyModel(models.Model):

    class Color(Enum):
        RED = 'r'
        GREEN = 'g'
        BLUE = 'b'

        class Labels:
            RED = 'A custom label'

    color = EnumField(Color, max_length=1)

assert MyModel.Color.GREEN.label == 'Green'
assert MyModel.Color.RED.label == 'A custom label'

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-enumfields-0.7.0.tar.gz (7.3 kB view details)

Uploaded Source

File details

Details for the file django-enumfields-0.7.0.tar.gz.

File metadata

File hashes

Hashes for django-enumfields-0.7.0.tar.gz
Algorithm Hash digest
SHA256 36707800d404c7258273f8a00a94a7e18f4fef7b30dc3a629b2cb3247b1bc431
MD5 d3a99fd20cb056f57b96367fc0807274
BLAKE2b-256 2e78524954038f68c7b7fb9e52b4d9823ed063ff8e32b2ff9d9ebcb9997e6513

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