Custom serializer fields in Django

Introduction

Custom serializer fields let you control how data is converted when sending or receiving it in APIs. This helps handle special data types or formats easily.

You want to change how a date or time is shown in your API response.

You need to convert a complex object into a simple string or number for the API.

You want to validate or clean data in a special way before saving it.

You have a field that is not supported by default serializers and need to define how to handle it.

Syntax

Django

from rest_framework import serializers

class MyCustomField(serializers.Field):
    def to_representation(self, value):
        # Convert the Python object to a simple data type
        return str(value)

    def to_internal_value(self, data):
        # Convert the input data back to the Python object
        return data

to_representation changes Python data to a format for the API response.

to_internal_value changes input data from the API to Python data.

Examples

This field converts text to uppercase when sending data, and to lowercase when receiving data.

Django

class UpperCaseField(serializers.Field):
    def to_representation(self, value):
        return value.upper()

    def to_internal_value(self, data):
        return data.lower()

This field shows booleans as 'yes' or 'no' strings in the API.

Django

class BooleanStringField(serializers.Field):
    def to_representation(self, value):
        return 'yes' if value else 'no'

    def to_internal_value(self, data):
        return data.lower() == 'yes'

Sample Program

This example shows a custom field that converts a boolean to 'yes' or 'no' strings in the API. It also validates input to accept only 'yes' or 'no'.

Django

from rest_framework import serializers

class YesNoBooleanField(serializers.Field):
    def to_representation(self, value):
        return 'yes' if value else 'no'

    def to_internal_value(self, data):
        if not isinstance(data, str) or data.lower() not in ('yes', 'no'):
            raise serializers.ValidationError('Must be "yes" or "no"')
        return data.lower() == 'yes'

class ExampleSerializer(serializers.Serializer):
    active = YesNoBooleanField()

# Example usage
serializer = ExampleSerializer(data={'active': 'yes'})
serializer.is_valid(raise_exception=True)
print(serializer.validated_data)
print(serializer.data)

Important Notes

Always raise serializers.ValidationError in to_internal_value if input is invalid.

Custom fields help keep your API data clean and user-friendly.

Summary

Custom serializer fields let you control data format in APIs.

Use to_representation to change output data.

Use to_internal_value to validate and convert input data.

Practice

1. What is the main purpose of creating a custom serializer field in Django REST Framework?

easy

A. To style the API response with CSS

B. To create new database tables automatically

C. To handle user authentication and permissions

D. To control how data is converted to and from JSON format

Solution

1. Step 1: Understand serializer fields role

   Serializer fields define how data is transformed between Python objects and JSON.

2. Step 2: Identify custom field purpose

   Custom fields let you control this transformation, especially for special data formats.

3. Final Answer:

   To control how data is converted to and from JSON format -> Option D

4. Quick Check:

   Custom serializer fields = control data format [OK]

Hint: Custom fields change data format in API input/output [OK]

Common Mistakes:

• Confusing serializer fields with database models
• Thinking custom fields handle authentication
• Assuming styling is done in serializers

2. Which method should you override in a custom serializer field to change how data is shown in API responses?

easy

A. to_internal_value

B. to_representation

C. validate

D. create

Solution

1. Step 1: Recall method roles in serializer fields

   to_representation converts Python data to JSON output; to_internal_value converts input JSON to Python.

2. Step 2: Identify output formatting method

   To change API response format, override to_representation.

3. Final Answer:

   to_representation -> Option B

4. Quick Check:

   Output formatting = to_representation [OK]

Hint: Output uses to_representation method [OK]

Common Mistakes:

• Using to_internal_value for output formatting
• Confusing validate with data conversion
• Overriding create instead of serialization methods

3. Given this custom serializer field code, what will be the output for input value 10?

class DoubleField(serializers.Field):
    def to_representation(self, value):
        return value * 2

field = DoubleField()
print(field.to_representation(10))

medium

A. 20

B. '10'

C. 10

D. Error

Solution

1. Step 1: Analyze to_representation method

   The method multiplies the input value by 2 before returning it.

2. Step 2: Calculate output for input 10

   10 * 2 = 20, so the output is 20.

3. Final Answer:

   20 -> Option A

4. Quick Check:

   10 doubled = 20 [OK]

Hint: to_representation transforms output value [OK]

Common Mistakes:

• Expecting input unchanged
• Confusing output type as string
• Assuming method raises error

4. Identify the error in this custom serializer field code:

class UpperCaseField(serializers.Field):
    def to_internal_value(self, data):
        return data.upper()

field = UpperCaseField()
print(field.to_internal_value(None))

medium

A. Field class must inherit from serializers.CharField

B. to_internal_value should return lowercase string

C. Calling upper() on None causes an AttributeError

D. to_internal_value method is missing a return statement

Solution

1. Step 1: Check method call on input

   The code calls data.upper() but data is None, which has no upper() method.

2. Step 2: Identify error type

   This causes an AttributeError at runtime.

3. Final Answer:

   Calling upper() on None causes an AttributeError -> Option C

4. Quick Check:

   None.upper() = AttributeError [OK]

Hint: Check input type before calling string methods [OK]

Common Mistakes:

• Assuming None is valid string input
• Thinking inheritance must be CharField
• Missing return statement (actually present)

5. You want to create a custom serializer field that accepts a comma-separated string of numbers and outputs a list of integers. Which methods should you override and how?

hard

A. Override to_internal_value to split and convert input string; override to_representation to join list into string

B. Override to_representation to split input string; override to_internal_value to join list

C. Override validate to convert string to list; no need to override to_representation

D. Override create method to parse string; override update to format list

Solution

1. Step 1: Understand input and output roles

   Input is a string (comma-separated), so to_internal_value must parse it into a list of integers.

2. Step 2: Format output for API response

   to_representation should convert the list back into a comma-separated string for output.

3. Final Answer:

   Override to_internal_value to split and convert input string; override to_representation to join list into string -> Option A

4. Quick Check:

   Input parsing = to_internal_value, output formatting = to_representation [OK]

Hint: Parse input in to_internal_value, format output in to_representation [OK]

Common Mistakes:

• Swapping input/output methods
• Using validate instead of conversion methods
• Overriding create/update which are unrelated