Security News
Cloudflare Adds Security.txt Setup Wizard
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
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/
pip install django-enumfields
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__'
FAQs
Real Python Enums for Django.
We found that django-enumfields demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 5 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Cloudflare has launched a setup wizard allowing users to easily create and manage a security.txt file for vulnerability disclosure on their websites.
Security News
The Socket Research team breaks down a malicious npm package targeting the legitimate DOMPurify library. It uses obfuscated code to hide that it is exfiltrating browser and crypto wallet data.
Security News
ENISA’s 2024 report highlights the EU’s top cybersecurity threats, including rising DDoS attacks, ransomware, supply chain vulnerabilities, and weaponized AI.