Custom form validation methods in Django - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the purpose of custom form validation methods in Django?

Custom form validation methods let you check user input beyond basic rules. They help ensure data is correct and meaningful before saving or processing.

beginner

How do you name a method to validate a specific field in a Django form?

Name the method clean_fieldname, replacing fieldname with your form field's name. Django calls it automatically to validate that field.

beginner

What should a clean_fieldname method return in Django?

It should return the cleaned (validated and possibly modified) value for that field. If invalid, it should raise ValidationError.

intermediate

What is the difference between clean_fieldname and clean() methods in Django forms?

clean_fieldname validates one field at a time. clean() validates the whole form and can check multiple fields together.

beginner

How do you raise a validation error inside a custom validation method?

Use <code>from django.core.exceptions import ValidationError</code> and then raise <code>ValidationError('Your error message')</code> when validation fails.

Which method name will Django call automatically to validate a form field named 'email'?

A clean_email

B validate_email

C check_email

D cleanField_email

Django calls methods named clean_ automatically for field validation.

What should a custom field validation method return if the input is valid?

A Nothing

B The cleaned value

C Raise ValidationError

D The original form instance

The method must return the cleaned (possibly modified) value for the field.

Where do you put validation logic that depends on multiple fields in a Django form?

A In the model's save method

B In clean_fieldname methods

C In the form's __init__ method

D In the clean() method

The clean() method validates the whole form and can access multiple fields.

What happens if you raise ValidationError inside a custom validation method?

A The form is invalid and shows the error message

B The form saves anyway

C The server crashes

D The error is ignored

Raising ValidationError stops form validation and shows the error to the user.

Which import is needed to raise a ValidationError in Django forms?

A import ValidationError from django

B from django.forms import ValidationError

C from django.core.exceptions import ValidationError

D from django.validation import ValidationError

ValidationError is imported from django.core.exceptions.

Explain how to create a custom validation method for a single field in a Django form.

Think about method naming and what it returns or raises.

Describe when and why you would use the clean() method in a Django form.

Consider validation that depends on more than one field.

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