David Dahan
David Dahan

Reputation: 11172

Clean method on date fields in Django Forms

I need to override the clean() method of my Django form to test two datefields together: a begin_date and a end_date (is the end date posterior to start date, and is the begin date posterior to now).

The problem is that when one of these two fields is empty or invalid, I got an exception (KeyError). I'd like to got a simple error form like I got with empty charfields.

I was pretty sure to find the answer here: Django self.cleaned_data Keyerror but I didn't.

Here is the code:

class MyForm(forms.Form):
    begin_date = forms.DateField()
    end_date = forms.DateField()
    #...

    def clean(self):

        cleaned_data = super(MyForm, self).clean()
        errors = []

        begin_date = cleaned_data['begin_date']
        end_date = cleaned_data['end_date']
        #...

        # Test 1
            if begin_date < date.today():
                errors.append(forms.ValidationError(
                "La date de début doit être postérieure à la date actuelle"))
        # Test 2
            if end_date < begin_date:
                errors.append(forms.ValidationError(
                "La date de fin doit être posétieure à la date de début"))

        if errors:
            raise forms.ValidationError(errors)

        return cleaned_data

Upvotes: 4

Views: 4073

Answers (2)

soloidx
soloidx

Reputation: 749

In Django, when you call the super(MyForm, self).clean() the superclass fill the cleaned_data ONLY if the data is already valid this is why in the docs are using the get method (https://docs.djangoproject.com/en/dev/ref/forms/validation/#cleaning-and-validating-fields-that-depend-on-each-other).

As you wan't to compare datetime object together, use this code to ensure date fields are correct:

if 'begin_date' in cleaned_data.keys():
        begin_date = cleaned_data['begin_date']
    else:
        begin_date = None
        errors.append(forms.ValidationError(
            "Bad start date format or empty"))

Upvotes: 3

user3681414
user3681414

Reputation: 109

How about

if all([d in cleaned_data for d in ['begin_date', 'end_date']]):
    # your code
else:
    raise forms.ValidationError("A start date and end date are required")

This checks for the existence of both values before trying to use them, and if one or both are missing returns a suitable error message.

Upvotes: 2

Related Questions