Ticket #14496: 14496.custom-admin-form-exclude.diff

django/contrib/admin/options.py

@@ -428 +428 @@
             exclude = list(self.exclude)
         exclude.extend(kwargs.get("exclude", []))
         exclude.extend(self.get_readonly_fields(request, obj))
+        if hasattr(self.form, '_meta') and self.form._meta.exclude:
+            # Take into account the custom ModelForm's Meta.exclude.
+            exclude.extend(self.form.Meta.exclude)
         # if exclude is an empty list we pass None to be consistant with the
         # default on modelform_factory
         exclude = exclude or None
@@ -1330 +1333 @@
             exclude = list(self.exclude)
         exclude.extend(kwargs.get("exclude", []))
         exclude.extend(self.get_readonly_fields(request, obj))
+        if hasattr(self.form, '_meta') and self.form._meta.exclude:
+            # Take into account the custom ModelForm's Meta.exclude.
+            exclude.extend(self.form.Meta.exclude)
         # if exclude is an empty list we use None, since that's the actual
         # default
         exclude = exclude or None

docs/ref/contrib/admin/index.txt

@@ -293 +293 @@
 
     For an example see the section `Adding custom validation to the admin`_.
 
+    .. admonition:: Note
+    
+        .. versionchanged:: 1.4
+    
+        If your own ``ModelForm`` defines an ``exclude`` list of fields in its
+        ``Meta`` options, then that list of fields will automatically
+        be combined to that of the ``ModelAdmin``'s own ``exclude`` list::
+        
+            class PersonForm(forms.ModelForm):
+                
+                class Meta:
+                    model = Person
+                    exclude = ['name']
+        
+            class PersonAdmin(admin.ModelAdmin):
+                exclude = ['age']
+                form = PersonForm
+                
+        In the above example, the two fields "name" and "age" will be excluded from the
+        generated form.
+
 .. attribute:: ModelAdmin.formfield_overrides
 
     This provides a quick-and-dirty way to override some of the

docs/releases/1.4.txt

@@ -60 +60 @@
 ``template.Library`` to ease the creation of template tags that store some
 data in a specified context variable.
 
+``exclude`` in ``ModelAdmin`` and custom admin forms
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+If you define a custom ``ModelForm`` in a ``ModelAdmin`` and that form
+defines an ``exclude`` list of fields in its ``Meta`` options, then that list
+of fields will automatically be combined to that of the ``ModelAdmin``'s own
+``exclude`` list::
+
+    class PersonForm(forms.ModelForm):
+        
+        class Meta:
+            model = Person
+            exclude = ['name']
+
+    class PersonAdmin(admin.ModelAdmin):
+        exclude = ['age']
+        form = PersonForm
+        
+In the above example, the two fields "name" and "age" will be excluded from the
+generated form.
+
 .. _backwards-incompatible-changes-1.4:
 
 Backwards incompatible changes in 1.4

tests/regressiontests/modeladmin/tests.py

@@ -119 +119 @@
         ma = BandAdmin(Band, self.site)
         self.assertEqual(ma.get_form(request).base_fields.keys(),
             ['name'])
+        
+    def test_custom_form_meta_exclude_with_readonly(self):
+        """
+        Ensure that the custom ModelForm's `Meta.exclude` is respected when
+        used in conjunction with readonly fields.
+        Refs #14496.
+        """
+        # First, with `ModelAdmin` -----------------------
+        
+        class AdminBandForm(forms.ModelForm):
+
+            class Meta:
+                model = Band
+                exclude = ['bio']
 
+        class BandAdmin(ModelAdmin):
+            readonly_fields = ['name']
+            form = AdminBandForm
+        
+        ma = BandAdmin(Band, self.site)
+        self.assertEqual(ma.get_form(request).base_fields.keys(),
+            ['sign_date',])
+    
+        # Then, with `InlineModelAdmin`  -----------------
+        
+        class AdminConcertForm(forms.ModelForm):
+
+            class Meta:
+                model = Concert
+                exclude = ['day']
+        
+        class ConcertInline(TabularInline):
+            readonly_fields = ['transport']
+            form = AdminConcertForm
+            fk_name = 'main_band'
+            model = Concert
+            
+        class BandAdmin(ModelAdmin):
+            inlines = [
+                ConcertInline
+            ]
+
+        ma = BandAdmin(Band, self.site)
+        self.assertEqual(
+            list(ma.get_formsets(request))[0]().forms[0].fields.keys(),
+            ['main_band', 'opening_band', 'id', 'DELETE',])
+        
+    def test_custom_form_meta_exclude(self):
+        """
+        Ensure that the custom ModelForm's `Meta.exclude` is respected.
+        Refs #14496.
+        """
+        # First, with `ModelAdmin` -----------------------
+        
+        class AdminBandForm(forms.ModelForm):
+
+            class Meta:
+                model = Band
+                exclude = ['bio']
+
+        class BandAdmin(ModelAdmin):
+            exclude = ['name']
+            form = AdminBandForm
+        
+        ma = BandAdmin(Band, self.site)
+        self.assertEqual(ma.get_form(request).base_fields.keys(),
+            ['sign_date',])
+        
+        # Then, with `InlineModelAdmin`  -----------------
+        
+        class AdminConcertForm(forms.ModelForm):
+
+            class Meta:
+                model = Concert
+                exclude = ['day']
+        
+        class ConcertInline(TabularInline):
+            exclude = ['transport']
+            form = AdminConcertForm
+            fk_name = 'main_band'
+            model = Concert
+            
+        class BandAdmin(ModelAdmin):
+            inlines = [
+                ConcertInline
+            ]
+
+        ma = BandAdmin(Band, self.site)
+        self.assertEqual(
+            list(ma.get_formsets(request))[0]().forms[0].fields.keys(),
+            ['main_band', 'opening_band', 'id', 'DELETE',])
+        
     def test_custom_form_validation(self):
         # If we specify a form, it should use it allowing custom validation to work
         # properly. This won't, however, break any of the admin widgets or media.