Serializer validation in Django - Step-by-Step Execution

Concept Flow - Serializer validation

Receive input data

↓

Create serializer instance

↓

Call is_valid() method

↓

Check field validations

↓

If valid?

No→Collect errors

↓

Return errors

↓

Access validated_data

↓

Save or use data

The flow shows how input data is passed to a serializer, validated, and either errors are returned or validated data is accessed.

Execution Sample

Django

from rest_framework import serializers

class UserSerializer(serializers.Serializer):
    username = serializers.CharField(max_length=10)

serializer = UserSerializer(data={'username': 'longusername123'})
serializer.is_valid()
serializer.errors

This code creates a serializer with a username field limited to 10 characters, validates input data, and shows errors if validation fails.

Execution Table

Step	Action	Input/Condition	Result	Notes
1	Create serializer instance	{'username': 'longusername123'}	Serializer ready with input data	Data stored for validation
2	Call is_valid()	Check username length <= 10	Validation fails	Username too long
3	Access errors	Validation failed	{'username': ['Ensure this field has no more than 10 characters.']}	Error message returned
4	Try accessing validated_data	Validation failed	Empty or error	No validated data available

💡 Validation fails because username length exceeds max_length 10

Variable Tracker

Variable	Start	After is_valid() call	After errors accessed	Final
serializer.data	N/A	N/A	N/A	N/A
serializer.initial_data	{'username': 'longusername123'}	{'username': 'longusername123'}	{'username': 'longusername123'}	{'username': 'longusername123'}
serializer.validated_data	{}	{}	{}	{}
serializer.errors	{}	{'username': ['Ensure this field has no more than 10 characters.']}	{'username': ['Ensure this field has no more than 10 characters.']}	{'username': ['Ensure this field has no more than 10 characters.']}

Key Moments - 2 Insights

Why does serializer.validated_data stay empty after is_valid()?

Because validation failed (see step 2 in execution_table), validated_data is not populated. It only fills when is_valid() returns true.

What happens if you try to save data when validation fails?

Saving is not allowed if validation fails. You must check is_valid() first and handle errors before saving.

Visual Quiz - 3 Questions

Look at the execution_table, what is the value of serializer.errors at step 3?

A {'username': ['This field is required.']}

B {}

C {'username': ['Ensure this field has no more than 10 characters.']}

D null

💡 Hint

Check the 'Result' column at step 3 in execution_table

At which step does the validation fail?

A Step 2

B Step 1

C Step 3

D Step 4

💡 Hint

Look at the 'Result' and 'Notes' columns in execution_table

If the username was 'user1', how would serializer.validated_data change after is_valid()?

A It would remain empty

B It would contain {'username': 'user1'}

C It would contain errors

D It would be null

💡 Hint

Validated data fills only when validation passes (see variable_tracker)

Concept Snapshot

Serializer validation in Django REST Framework:
- Create serializer with input data
- Call is_valid() to check data
- If valid, access validated_data
- If invalid, check errors
- Always validate before saving data

Full Transcript

Serializer validation in Django REST Framework starts by creating a serializer instance with input data. When is_valid() is called, the serializer checks each field against its rules. If any field fails validation, is_valid() returns false and errors are stored. Validated data is only available if validation passes. Trying to save or access validated_data without successful validation will not work. This process ensures only correct data is processed or saved.

Practice

1. What is the main purpose of serializer validation in Django REST Framework?

easy

A. To check if the input data is correct before saving or processing

B. To automatically save data to the database

C. To format the output data for display

D. To create database tables automatically

Solution

1. Step 1: Understand serializer validation role

   Serializer validation ensures the data received is correct and meets rules before using it.

2. Step 2: Differentiate from other serializer tasks

   Saving data or formatting output are separate steps; validation happens first to prevent errors.

3. Final Answer:

   To check if the input data is correct before saving or processing -> Option A

4. Quick Check:

   Validation = Data correctness check [OK]

Hint: Validation checks data correctness before saving or using it [OK]

Common Mistakes:

• Confusing validation with saving data
• Thinking validation formats output
• Assuming validation creates database tables

2. Which method name is correct to validate a single field called email in a serializer?

easy

A. validateEmail

B. validate_field_email

C. check_email

D. validate_email

Solution

1. Step 1: Recall Django REST Framework naming convention

   Single field validation methods must be named validate_<fieldname>.

2. Step 2: Match method name to field email

   The correct method is validate_email, exactly matching the field name.

3. Final Answer:

   validate_email -> Option D

4. Quick Check:

   Single field validator = validate_fieldname [OK]

Hint: Use validate_ plus field name exactly for single field validation [OK]

Common Mistakes:

• Using camelCase instead of snake_case
• Adding extra words like 'field' in method name
• Using incorrect prefixes like 'check_'

3. Given this serializer code, what will happen if age is less than 18?

class UserSerializer(serializers.Serializer):
    age = serializers.IntegerField()

    def validate_age(self, value):
        if value < 18:
            raise serializers.ValidationError('Must be at least 18')
        return value

medium

A. ValidationError with message 'Must be at least 18' is raised

B. The age is automatically set to 18

C. No error, age is accepted as is

D. Serializer ignores the age field

Solution

1. Step 1: Understand the validate_age method logic

   The method checks if age is less than 18 and raises ValidationError if true.

2. Step 2: Predict behavior when age < 18

   If age is less than 18, the error is raised stopping validation and returning the message.

3. Final Answer:

   ValidationError with message 'Must be at least 18' is raised -> Option A

4. Quick Check:

   Age < 18 triggers ValidationError [OK]

Hint: ValidationError raised when condition inside validate_<field> fails [OK]

Common Mistakes:

• Assuming age is changed automatically
• Thinking no error occurs for invalid age
• Believing the field is ignored silently

4. Identify the error in this serializer validation code:

class ProductSerializer(serializers.Serializer):
    price = serializers.FloatField()

    def validate(self, data):
        if data['price'] < 0:
            raise serializers.ValidationError('Price must be positive')
        return data

    def validate_price(self, value):
        if value == 0:
            raise serializers.ValidationError('Price cannot be zero')
        return value

medium

A. validate method should call super().validate(data)

B. validate_price should return data, not value

C. No error, code is correct

D. ValidationError messages must be dictionaries, not strings

Solution

1. Step 1: Check validate_price method

   It correctly checks if value is zero and raises error, then returns value.

2. Step 2: Check validate method

   It checks if price is negative and raises error, then returns data dictionary.

3. Step 3: Confirm ValidationError usage

   Passing string message is allowed; dictionary is optional for field-specific errors.

4. Final Answer:

   No error, code is correct -> Option C

5. Quick Check:

   Both validate and validate_<field> methods are valid [OK]

Hint: Both validate and validate_<field> can coexist and return correct types [OK]

Common Mistakes:

• Expecting validate_price to return data dict
• Thinking super().validate(data) is mandatory
• Believing ValidationError must be dict only

5. You want to validate that start_date is before end_date in a serializer. Which is the best way to do this?

hard

A. Use validate_start_date to compare both dates

B. Use the validate(self, data) method to compare both fields

C. Validate dates outside the serializer only

D. Use validate_end_date to compare both dates

Solution

1. Step 1: Understand single field validators scope

   Methods like validate_start_date only receive one field's value, so cannot compare two fields.

2. Step 2: Use validate method for multi-field validation

   The validate(self, data) method receives all fields and can compare start_date and end_date together.

3. Final Answer:

   Use the validate(self, data) method to compare both fields -> Option B

4. Quick Check:

   Multi-field validation = validate(data) method [OK]

Hint: Use validate(data) for checks involving multiple fields [OK]

Common Mistakes:

• Trying to compare fields inside single field validators
• Ignoring multi-field validation method
• Doing validation only outside serializer