Custom form validation methods in Django

Introduction

Custom form validation methods help you check user input in your forms beyond basic rules. They make sure data is correct and meaningful before saving or using it.

When you want to check if a username is already taken in a signup form.

When you need to ensure a password meets special rules like including numbers and letters.

When you want to confirm two fields match, like password and password confirmation.

When you want to validate a date is not in the past.

When you want to add custom error messages for specific input problems.

Syntax

Django

class MyForm(forms.Form):
    field_name = forms.CharField()

    def clean_field_name(self):
        data = self.cleaned_data['field_name']
        # custom validation logic
        if some_condition:
            raise forms.ValidationError('Error message')
        return data

    def clean(self):
        cleaned_data = super().clean()
        # cross-field validation
        if condition:
            raise forms.ValidationError('Error message')
        return cleaned_data

clean_field_name validates one field at a time.

clean method validates multiple fields together.

Examples

This checks if the username is 'admin' and raises an error if so.

Django

class SignupForm(forms.Form):
    username = forms.CharField()

    def clean_username(self):
        username = self.cleaned_data['username']
        if username == 'admin':
            raise forms.ValidationError('Username cannot be admin')
        return username

This checks if password and confirm_password fields match.

Django

class PasswordForm(forms.Form):
    password = forms.CharField(widget=forms.PasswordInput)
    confirm_password = forms.CharField(widget=forms.PasswordInput)

    def clean(self):
        cleaned_data = super().clean()
        pw = cleaned_data.get('password')
        cpw = cleaned_data.get('confirm_password')
        if pw and cpw and pw != cpw:
            raise forms.ValidationError('Passwords do not match')
        return cleaned_data

Sample Program

This form checks that the email ends with '@example.com' and the message is at least 10 characters long.

Django

from django import forms

class ContactForm(forms.Form):
    email = forms.EmailField()
    message = forms.CharField(widget=forms.Textarea)

    def clean_email(self):
        email = self.cleaned_data['email']
        if not email.endswith('@example.com'):
            raise forms.ValidationError('Email must be from example.com domain')
        return email

    def clean(self):
        cleaned_data = super().clean()
        message = cleaned_data.get('message')
        if message and len(message) < 10:
            raise forms.ValidationError('Message must be at least 10 characters long')
        return cleaned_data

Important Notes

Always return the cleaned data at the end of your validation methods.

Use raise forms.ValidationError to show errors to users.

Field-specific clean methods run before the general clean() method.

Summary

Custom validation methods let you check form data your way.

Use clean_fieldname for single fields and clean for multiple fields.

Raise ValidationError to show helpful error messages.

Practice

1. What is the purpose of defining a clean_fieldname method in a Django form?

easy

A. To handle form submission via AJAX

B. To automatically save the form data to the database

C. To add custom validation logic for a specific form field

D. To style the form field with CSS classes

Solution

1. Step 1: Understand the role of clean_fieldname

   This method is used to add validation logic for a single field in a Django form.

2. Step 2: Differentiate from other methods

   Unlike clean which validates multiple fields, clean_fieldname focuses on one field only.

3. Final Answer:

   To add custom validation logic for a specific form field -> Option C

4. Quick Check:

   clean_fieldname validates one field [OK]

Hint: Remember: clean_fieldname validates one field only [OK]

Common Mistakes:

• Confusing clean_fieldname with clean method
• Thinking it saves data automatically
• Assuming it styles the form

2. Which of the following is the correct way to raise a validation error inside a custom clean method for a field named email?

easy

A. return ValidationError('Invalid email')

B. raise ValidationError('Invalid email')

C. self.add_error('email', 'Invalid email')

D. ValidationError('Invalid email')

Solution

1. Step 1: Identify how to raise errors in Django forms

   In custom clean methods, you raise a ValidationError to signal invalid data.

2. Step 2: Check the syntax for raising errors

   The correct syntax is to use raise ValidationError('message'), not return or just call it.

3. Final Answer:

   raise ValidationError('Invalid email') -> Option B

4. Quick Check:

   Use raise to throw ValidationError [OK]

Hint: Use raise, not return, to signal validation errors [OK]

Common Mistakes:

• Using return instead of raise
• Calling ValidationError without raise
• Misusing self.add_error inside clean_fieldname

3. Given this Django form snippet, what will happen if the user enters 'abc' for the age field?

class MyForm(forms.Form):
    age = forms.IntegerField()

    def clean_age(self):
        age = self.cleaned_data.get('age')
        if age < 18:
            raise ValidationError('Must be at least 18')
        return age

medium

A. Form will crash with a TypeError

B. Form will accept 'abc' and pass validation

C. clean_age will raise 'Must be at least 18' error

D. Form will raise a validation error because 'abc' is not an integer

Solution

1. Step 1: Understand IntegerField behavior

   IntegerField automatically validates input to be an integer before calling clean_age.

2. Step 2: Analyze input 'abc'

   'abc' is not an integer, so IntegerField will raise a validation error before clean_age runs.

3. Final Answer:

   Form will raise a validation error because 'abc' is not an integer -> Option D

4. Quick Check:

   IntegerField rejects non-integers first [OK]

Hint: IntegerField validates type before custom clean runs [OK]

Common Mistakes:

• Thinking clean_age handles type errors
• Assuming 'Must be at least 18' error triggers for 'abc'
• Expecting a crash instead of validation error

4. Identify the error in this custom form validation method:

def clean(self):
    data = self.cleaned_data
    if data['start_date'] > data['end_date']:
        raise ValidationError('Start date must be before end date')
    return data

medium

A. Accessing cleaned_data directly without calling super().clean()

B. Raising ValidationError with a string instead of a dictionary

C. Not returning cleaned_data at the end of clean()

D. Using '>' operator instead of '>=' for date comparison

Solution

1. Step 1: Check how clean() should be overridden

   When overriding clean(), you must call super().clean() to get cleaned_data properly.

2. Step 2: Identify the error in accessing cleaned_data

   This code accesses self.cleaned_data directly without calling super().clean(), which may cause missing or incomplete data.

3. Final Answer:

   Accessing cleaned_data directly without calling super().clean() -> Option A

4. Quick Check:

   Always call super().clean() first [OK]

Hint: Call super().clean() before using cleaned_data [OK]

Common Mistakes:

• Forgetting to call super().clean()
• Returning wrong data type
• Misusing ValidationError format

5. You want to ensure that a Django form's password and confirm_password fields match. Which is the best way to implement this validation?

hard

A. Override the form's clean method to compare both fields and raise ValidationError if they differ

B. Add a validator to the password field that checks confirm_password

C. Define a clean_password method that compares both fields

D. Use JavaScript on the client side only to check matching passwords

Solution

1. Step 1: Understand field-level vs form-level validation

   Field-level methods like clean_password only see one field's data, so can't compare two fields.

2. Step 2: Use form-level clean() for cross-field validation

   Overriding clean lets you access all fields and compare password and confirm_password.

3. Final Answer:

   Override the form's clean method to compare both fields and raise ValidationError if they differ -> Option A

4. Quick Check:

   Use clean() for multi-field validation [OK]

Hint: Use clean() method for comparing multiple fields [OK]

Common Mistakes:

• Trying to compare fields in clean_password
• Relying only on client-side JavaScript
• Adding validators that can't access other fields