self.add_error()与raise ValidationError()的差异及相关机制咨询

Let’s break down your questions one by one, based on Django’s form validation behavior:

Is the statement about self.add_error() correct? #

Absolutely. When you call self.add_error('field1', 'description here') in your form’s validation methods:

• Django automatically removes field1 from the cleaned_data dictionary (since the field failed validation, its value isn’t considered "clean" anymore).
• The error message (or ValidationError object) is added to the self.errors dictionary, mapped directly to the field1 key. This ensures the error is tied to the correct field for display later.

Does raise ValidationError() automatically add to self.errors? #

This depends on where you raise the error within the form:

• In a field-specific clean method (e.g., clean_field1()): If you raise ValidationError here, Django catches it automatically, adds the error to self.errors['field1'], and removes field1 from cleaned_data—exactly like self.add_error() does for that field.
• In the general clean() method:
  • If you raise a simple ValidationError('General error message'), this becomes a "non-field error" and is added to self.errors['__all__'].
  • If you want to attach the error to a specific field from clean(), raise the error with a dictionary mapping field names to messages: raise ValidationError({'field1': 'Error message for field1'}). Django will then add this error to self.errors['field1'] and remove the field from cleaned_data.
• Outside form validation methods: If you raise ValidationError in a view or other non-form context, it won’t be added to the form’s self.errors automatically—you’d need to handle it manually, but this isn’t part of standard form validation flow.

How to display the error under the corresponding field when using raise ValidationError? #

To ensure errors show up below their respective fields:

1. Use field-specific clean methods: For example, validate field1 in clean_field1() and raise ValidationError('Your message here') inside it. Django will automatically render this error below the field1 input if you use standard form rendering in your template (like {{ form.field1 }} and {{ form.field1.errors }}).
2. Attach errors to fields in clean(): When validating cross-field logic, use the dictionary syntax to tie errors to specific fields:

   def clean(self):
       cleaned_data = super().clean()
       field1 = cleaned_data.get('field1')
       field2 = cleaned_data.get('field2')
       
       if field1 and field2 and field1 == field2:
           raise ValidationError({'field1': 'Field1 can’t match Field2'})
       
       return cleaned_data
   

3. Template setup: Ensure your template renders field errors explicitly. A common pattern is:

   <div class="form-group">
       {{ form.field1.label_tag }}
       {{ form.field1 }}
       {% if form.field1.errors %}
           <div class="text-danger">
               {% for error in form.field1.errors %}
                   <p>{{ error }}</p>
               {% endfor %}
           </div>
       {% endif %}
   </div>
   

   Using Django’s built-in renderers like {{ form.as_p }} or {{ form.as_table }} will also automatically display errors below their fields.

内容的提问来源于stack exchange，提问作者FAM_Maurice