How to add required attribute to a Django form field

Question

I would like to have a Django form field render as:

<input type="text" name="username" required>

but when I try username.widget.attrs['required'] = '' I get something like:

<input type="text" name="username" required="">

Is there a way in which the standalone HTML5 attributes like required can be shown in the resulting HTML form?

I am using Django 1.6 on Python 2.6, for what it's worth.

score 6 · Accepted Answer · edited May 23 '17 at 10:29

6

You need to define the required attribute in a valid format.

username.widget.attrs['required'] = 'required'

Take a look here for more details: https://stackoverflow.com/a/3012975/1566605

edited May 23 '17 at 10:29

Community

1
1

answered Mar 07 '15 at 17:19

mariodev

13,928
3
49
61

8

It would be useful to explain where this line should be added to those that are learning Django. – Mike Stoddart May 14 '20 at 15:12

score 5 · Answer 2 · edited May 23 '17 at 10:29

@mariodev is correct. If you want a more elegant way to do this, refer to https://stackoverflow.com/a/37738828/2812260 (relevant part copied below):

If you really want to write elegant, DRY code, you should make a base form class that dynamically looks for all your required fields and modifies their widget required attribute for you (you can name it whatever you wish, but "BaseForm" seems apt):

from django.forms import ModelForm

class BaseForm(ModelForm):
    def __init__(self, *args, **kwargs):
        super(BaseForm, self).__init__(*args, **kwargs)
        for bound_field in self:
            if hasattr(bound_field, "field") and bound_field.field.required:
                bound_field.field.widget.attrs["required"] = "required"

And then have all your Form objects descend from it:

class UserForm(BaseForm):
    class Meta:
        model = User
        fields = []

    first_name = forms.CharField(required=True)
    last_name = forms.CharField(required=True)
    email = forms.EmailField(required=True, max_length=100)

score 1 · Answer 3 · answered Oct 20 '21 at 16:02

If you want a declarative option on a per-form rather than a per-model basis this was my solution:

from django import forms

class RequiredFieldsModelForm(forms.ModelForm):
    def __init__(self, *args, **kwargs):
        super(RequiredFieldsModelForm, self).__init__(*args, **kwargs)
        for bound_field in self:
            if (
                hasattr(bound_field, "field") and
                bound_field.name in self.Meta.required_fields
            ):
                bound_field.field.widget.attrs["required"] = "required"


# Your forms
class UserForm(RequiredFieldsModelForm):
    class Meta:
        required_fields = ['username']
        model = User

score 0 · Answer 4 · answered Jan 27 '23 at 11:57

0

Just set required attribute to widget like this:

self.fields['field_name'].widget = forms.TextInput(attrs={'required':'required'})

answered Jan 27 '23 at 11:57

Orlando filipe Vilanculos

41
1
6

1

You should place this in __init__ method – Orlando filipe Vilanculos Jan 27 '23 at 11:59

How to add required attribute to a Django form field

4 Answers4