Skip to main content

A simple Constant Field definition for Django REST Framework

Project description

A ConstantField type for Django REST Framework.


pip install djangorestframework-constant-field


Using this is really simple, just set the value attribute on your serializer:

from rest_framework import serializers
from rest_framework_constant.fields import ConstantField

class MySerializer(serializers.Serializer):
    """Custom Serializer

    my_value = ConstantField(value='My Value')

serialized = MySerializer()


# {
#     'my_value': 'My Value',
# }


This is useful when you’re building a serializer to integrate into some third party system where some of your fields are pre-defined. The above example is equivalent to:

from rest_framework import serializers

class MySerializer(serializers.Serializer):
    """Custom Serializer

    my_value = serializers.SerializerMethodField()

    def get_my_value(self, obj):
        """Excessive code.
        return 'My Value'

Testing & Contributing

To build and test this package, simply fork this repo and:

git clone<yourname>/djangorestframework-constant-field.git

cd djangorestframework-constant-field
pip install -r requirements.txt
python test

The current app is almost completely contained inside rest_framework_constant.

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

Built Distribution

djangorestframework_constant_field-0.9.1-py2.py3-none-any.whl (5.2 kB view hashes)

Uploaded Python 2 Python 3

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