https://github.com/hzdg/django-enumfields

Real Python Enums for Django
https://github.com/hzdg/django-enumfields

Last synced: 23 days ago
JSON representation

Real Python Enums for Django

• Host: GitHub
• URL: https://github.com/hzdg/django-enumfields
• Owner: hzdg
• License: other
• Created: 2013-11-12T23:48:40.000Z (about 11 years ago)
• Default Branch: master
• Last Pushed: 2022-12-20T17:11:45.000Z (almost 2 years ago)
• Last Synced: 2024-09-30T18:36:34.984Z (2 months ago)
• Language: Python
• Size: 150 KB
• Stars: 146
• Watchers: 25
• Forks: 59
• Open Issues: 12
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGES.md
  • License: LICENSE

Awesome Lists containing this project

• starred-awesome - django-enumfields - Real Python Enums for Django (Python)

README

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

.. image:: https://travis-ci.org/hzdg/django-enumfields.svg?branch=master

    :target: https://travis-ci.org/hzdg/django-enumfields

.. image:: https://img.shields.io/pypi/v/django-enumfields.svg

    :target: https://pypi.python.org/pypi/django-enumfields

.. image:: https://img.shields.io/pypi/pyversions/django-enumfields.svg

    :target: https://pypi.python.org/pypi/django-enumfields/

Installation

------------

1. ``pip install django-enumfields``

Included Tools

--------------

EnumField, EnumIntegerField

```````````````````````````

.. code-block:: python

    from enumfields import EnumField

    from enum import Enum

    class Color(Enum):

        RED = 'r'

        GREEN = 'g'

        BLUE = 'b'

    class MyModel(models.Model):

        color = EnumField(Color, max_length=1)

Elsewhere:

.. code-block:: python

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

``EnumIntegerField`` works identically, but the underlying storage mechanism is

an ``IntegerField`` instead of a ``CharField``.

Usage in Forms

~~~~~~~~~~~~~~

Call the ``formfield`` method to use an ``EnumField`` directly in a ``Form``.

.. code-block:: python

    class MyForm(forms.Form):

        color = EnumField(Color, max_length=1).formfield()

Enum

````

Normally, you just use normal PEP435_-style enums, however, django-enumfields

also includes 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.

.. code-block:: python

    from enumfields import EnumField, Enum  # Our own Enum class

    class Color(Enum):

        RED = 'r'

        GREEN = 'g'

        BLUE = 'b'

        class Labels:

            RED = 'A custom label'

    class MyModel(models.Model):

        color = EnumField(Color, max_length=1)

    assert Color.GREEN.label == 'Green'

    assert Color.RED.label == 'A custom label'

.. _PEP435: http://www.python.org/dev/peps/pep-0435/

EnumFieldListFilter

```````````````````

``enumfields.admin.EnumFieldListFilter`` is provided to allow using enums in

``list_filter``.

.. code-block:: python

    from enumfields.admin import EnumFieldListFilter

    class MyModelAdmin(admin.ModelAdmin):

        list_filter = [('color', EnumFieldListFilter)]

Django Rest Framework integration

`````````````````````````````````

``EnumSupportSerializerMixin`` mixin allows you to use enums in DRF serializers.

.. code-block:: python

    # models.py

    from enumfields import EnumField

    from enum import Enum

    

    class Color(Enum):

        RED = 'r'

        GREEN = 'g'

        BLUE = 'b'

    

    class MyModel(models.Model):

        color = EnumField(Color, max_length=1)

    # serializers.py

    from enumfields.drf.serializers import EnumSupportSerializerMixin

    from rest_framework import serializers

    from .models import MyModel

    class MyModelSerializer(EnumSupportSerializerMixin, serializers.ModelSerializer):

        class Meta:

            model = MyModel

            fields = '__all__'