Allow overriding a widget's attributes without redeclaring the default widget

[Ivan Muller]

Hi guys, I want to improve the way of declear html attrs into a Fields With out declaring the default widget again.

Example:

class ProfileForm(forms.ModelForm):
    class Meta:
        model = Profile
    
    full_name = forms.CharField(widget=forms.TextInput(attrs={'class': Anyclass',}))

As Field documentaiton say into the init:

"""Each Field has a default Widget that it'll use if you don't specify this. n most cases, the default widget is TextInput:"""

Woudl be god to declare it as

full_name = forms.CharField(widget_attrs={'class': Anyclass',})

[Ivan Muller]

Maybe that easy hack may help

diff --git a/django/forms/fields.py b/django/forms/fields.py
index 370f78e..af99d2e 100644
--- a/django/forms/fields.py
+++ b/django/forms/fields.py
@@ -55,7 +55,8 @@ class Field:
-
     def __init__(self, *, required=True, widget=None, label=None, initial=None,
                  help_text='', error_messages=None, show_hidden_initial=False,
-                 validators=(), localize=False, disabled=False, label_suffix=None):
+                 validators=(), localize=False, disabled=False, label_suffix=None,
+                 widget_attrs={}):
         # required -- Boolean that specifies whether the field is required.
         #             True by default.
         # widget -- A Widget class, or instance of a Widget class, that should
@@ -100,6 +101,7 @@ class Field:
-
         # Hook into self.widget_attrs() for any Field-specific HTML attributes.
         extra_attrs = self.widget_attrs(widget)
+        extra_attrs.update(widget_attrs)
         if extra_attrs:
             widget.attrs.update(extra_attrs)

[Carlton Gibson]

Hi @mullerivan,

The docs for ​Styling widget instances give three approaches. The one you'd like to avoid is just the first.

In your case, I guess I'd recommend the second approach, to adjust the widget attrs inline in the form definition:

class ProfileForm(forms.ModelForm):
    full_name = forms.CharField()
    
    full_name.widget.attrs.update({'class': 'Anyclass',})

    class Meta:
        model = Profile    

Given that multiple options already exist, adding yet another keyword argument is not going to be worth it on balance.
(The benefit won't justify the extra API surface area.)

Also see the ModelForm docs on ​Overriding default fields. If it's API you really want in your project there's nothing to stop you creating a base form class or mixin the takes an additional extra_widget_attrs and sets that appropriately during __init__(), as a generalisation of the third strategy outlined in the Styling widget instances docs linked above.

[Ivan Muller]

Thanks a lot! im actually likes the way that you define to handle this scenario

Cheers