Opened 13 years ago

Last modified 13 years ago

#15708 closed

Regression in Forms: KeyError if trying to access nonvalid input from required field — at Version 2

Reported by: jonescb Owned by: nobody
Component: Forms Version: 1.3
Severity: Keywords:
Cc: Triage Stage: Unreviewed
Has patch: no Needs documentation: no
Needs tests: no Patch needs improvement: no
Easy pickings: no UI/UX: no

Description (last modified by Karen Tracey)

I discovered that I'm getting a KeyError when I try to access a blank required field from the clean() method of the Form.

Something like this will trigger the error:

class TestForm(forms.Form)
    name = forms.CharField()

    def clean(self):
        super(forms.Form, self).clean()
        name = self.cleaned_data['name'] # this is the offending line
        return self.cleaned_data

If you display that form in a template and the user enters nothing into the field, it causes a KeyError which leads to a 500 error. This same code used to work in Django 1.2, but it doesn't work in 1.3 anymore.

If you set the field to required=False, it does work.
The obvious workaround is to wrap the offending line in a try/except.

The previous functionality was that Django would display an error to the user telling them that the field is required if you configured your templates to display the errors. It still displays that error if you don't try to access keys from self.cleaned_data.

This also happens with EmailField if you enter an invalid email address. I didn't test any other fields though.

Change History (2)

comment:1 by jonescb, 13 years ago

Sorry, I messed up the formatting of the code in clean(), and I can't edit it.
I'll just redo it.

class TestForm(forms.Form)
    name = forms.CharField?()
    def clean(self):
        super(forms.Form, self).clean()
        name = self.cleaned_data['name'] # this is the offending line 
        return self.cleaned_data

comment:2 by Karen Tracey, 13 years ago

Description: modified (diff)
Note: See TracTickets for help on using tickets.
Back to Top