|
123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260 |
- """
- Django Admin support for polymorphic inlines.
-
- Each row in the inline can correspond with a different subclass.
- """
- from functools import partial
-
- from django.conf import settings
- from django.contrib.admin.options import InlineModelAdmin
- from django.contrib.admin.utils import flatten_fieldsets
- from django.core.exceptions import ImproperlyConfigured
- from django.forms import Media
-
- from polymorphic.formsets import (
- BasePolymorphicInlineFormSet,
- PolymorphicFormSetChild,
- UnsupportedChildType,
- polymorphic_child_forms_factory,
- )
- from polymorphic.formsets.utils import add_media
-
- from .helpers import PolymorphicInlineSupportMixin
-
-
- class PolymorphicInlineModelAdmin(InlineModelAdmin):
- """
- A polymorphic inline, where each formset row can be a different form.
-
- Note that:
-
- * Permissions are only checked on the base model.
- * The child inlines can't override the base model fields, only this parent inline can do that.
- """
-
- formset = BasePolymorphicInlineFormSet
-
- #: The extra media to add for the polymorphic inlines effect.
- #: This can be redefined for subclasses.
- polymorphic_media = Media(
- js=(
- "admin/js/vendor/jquery/jquery{}.js".format("" if settings.DEBUG else ".min"),
- "admin/js/jquery.init.js",
- "polymorphic/js/polymorphic_inlines.js",
- ),
- css={"all": ("polymorphic/css/polymorphic_inlines.css",)},
- )
-
- #: The extra forms to show
- #: By default there are no 'extra' forms as the desired type is unknown.
- #: Instead, add each new item using JavaScript that first offers a type-selection.
- extra = 0
-
- #: Inlines for all model sub types that can be displayed in this inline.
- #: Each row is a :class:`PolymorphicInlineModelAdmin.Child`
- child_inlines = ()
-
- def __init__(self, parent_model, admin_site):
- super().__init__(parent_model, admin_site)
-
- # Extra check to avoid confusion
- # While we could monkeypatch the admin here, better stay explicit.
- parent_admin = admin_site._registry.get(parent_model, None)
- if parent_admin is not None: # Can be None during check
- if not isinstance(parent_admin, PolymorphicInlineSupportMixin):
- raise ImproperlyConfigured(
- "To use polymorphic inlines, add the `PolymorphicInlineSupportMixin` mixin "
- "to the ModelAdmin that hosts the inline."
- )
-
- # While the inline is created per request, the 'request' object is not known here.
- # Hence, creating all child inlines unconditionally, without checking permissions.
- self.child_inline_instances = self.get_child_inline_instances()
-
- # Create a lookup table
- self._child_inlines_lookup = {}
- for child_inline in self.child_inline_instances:
- self._child_inlines_lookup[child_inline.model] = child_inline
-
- def get_child_inline_instances(self):
- """
- :rtype List[PolymorphicInlineModelAdmin.Child]
- """
- instances = []
- for ChildInlineType in self.child_inlines:
- instances.append(ChildInlineType(parent_inline=self))
- return instances
-
- def get_child_inline_instance(self, model):
- """
- Find the child inline for a given model.
-
- :rtype: PolymorphicInlineModelAdmin.Child
- """
- try:
- return self._child_inlines_lookup[model]
- except KeyError:
- raise UnsupportedChildType(f"Model '{model.__name__}' not found in child_inlines")
-
- def get_formset(self, request, obj=None, **kwargs):
- """
- Construct the inline formset class.
-
- This passes all class attributes to the formset.
-
- :rtype: type
- """
- # Construct the FormSet class
- FormSet = super().get_formset(request, obj=obj, **kwargs)
-
- # Instead of completely redefining super().get_formset(), we use
- # the regular inlineformset_factory(), and amend that with our extra bits.
- # This code line is the essence of what polymorphic_inlineformset_factory() does.
- FormSet.child_forms = polymorphic_child_forms_factory(
- formset_children=self.get_formset_children(request, obj=obj)
- )
- return FormSet
-
- def get_formset_children(self, request, obj=None):
- """
- The formset 'children' provide the details for all child models that are part of this formset.
- It provides a stripped version of the modelform/formset factory methods.
- """
- formset_children = []
- for child_inline in self.child_inline_instances:
- # TODO: the children can be limited here per request based on permissions.
- formset_children.append(child_inline.get_formset_child(request, obj=obj))
- return formset_children
-
- def get_fieldsets(self, request, obj=None):
- """
- Hook for specifying fieldsets.
- """
- if self.fieldsets:
- return self.fieldsets
- else:
- return [] # Avoid exposing fields to the child
-
- def get_fields(self, request, obj=None):
- if self.fields:
- return self.fields
- else:
- return [] # Avoid exposing fields to the child
-
- @property
- def media(self):
- # The media of the inline focuses on the admin settings,
- # whether to expose the scripts for filter_horizontal etc..
- # The admin helper exposes the inline + formset media.
- base_media = super().media
- all_media = Media()
- add_media(all_media, base_media)
-
- # Add all media of the child inline instances
- for child_instance in self.child_inline_instances:
- child_media = child_instance.media
-
- # Avoid adding the same media object again and again
- if child_media._css != base_media._css and child_media._js != base_media._js:
- add_media(all_media, child_media)
-
- add_media(all_media, self.polymorphic_media)
-
- return all_media
-
- class Child(InlineModelAdmin):
- """
- The child inline; which allows configuring the admin options
- for the child appearance.
-
- Note that not all options will be honored by the parent, notably the formset options:
- * :attr:`extra`
- * :attr:`min_num`
- * :attr:`max_num`
-
- The model form options however, will all be read.
- """
-
- formset_child = PolymorphicFormSetChild
- extra = 0 # TODO: currently unused for the children.
-
- def __init__(self, parent_inline):
- self.parent_inline = parent_inline
- super(PolymorphicInlineModelAdmin.Child, self).__init__(
- parent_inline.parent_model, parent_inline.admin_site
- )
-
- def get_formset(self, request, obj=None, **kwargs):
- # The child inline is only used to construct the form,
- # and allow to override the form field attributes.
- # The formset is created by the parent inline.
- raise RuntimeError("The child get_formset() is not used.")
-
- def get_fields(self, request, obj=None):
- if self.fields:
- return self.fields
-
- # Standard Django logic, use the form to determine the fields.
- # The form needs to pass through all factory logic so all 'excludes' are set as well.
- # Default Django does: form = self.get_formset(request, obj, fields=None).form
- # Use 'fields=None' avoids recursion in the field autodetection.
- form = self.get_formset_child(request, obj, fields=None).get_form()
- return list(form.base_fields) + list(self.get_readonly_fields(request, obj))
-
- def get_formset_child(self, request, obj=None, **kwargs):
- """
- Return the formset child that the parent inline can use to represent us.
-
- :rtype: PolymorphicFormSetChild
- """
- # Similar to the normal get_formset(), the caller may pass fields to override the defaults settings
- # in the inline. In Django's GenericInlineModelAdmin.get_formset() this is also used in the same way,
- # to make sure the 'exclude' also contains the GFK fields.
- #
- # Hence this code is almost identical to InlineModelAdmin.get_formset()
- # and GenericInlineModelAdmin.get_formset()
- #
- # Transfer the local inline attributes to the formset child,
- # this allows overriding settings.
- if "fields" in kwargs:
- fields = kwargs.pop("fields")
- else:
- fields = flatten_fieldsets(self.get_fieldsets(request, obj))
-
- if self.exclude is None:
- exclude = []
- else:
- exclude = list(self.exclude)
-
- exclude.extend(self.get_readonly_fields(request, obj))
- # Add forcefully, as Django 1.10 doesn't include readonly fields.
- exclude.append("polymorphic_ctype")
-
- if self.exclude is None and hasattr(self.form, "_meta") and self.form._meta.exclude:
- # Take the custom ModelForm's Meta.exclude into account only if the
- # InlineModelAdmin doesn't define its own.
- exclude.extend(self.form._meta.exclude)
-
- # can_delete = self.can_delete and self.has_delete_permission(request, obj)
- defaults = {
- "form": self.form,
- "fields": fields,
- "exclude": exclude or None,
- "formfield_callback": partial(self.formfield_for_dbfield, request=request),
- }
- defaults.update(kwargs)
-
- # This goes through the same logic that get_formset() calls
- # by passing the inline class attributes to modelform_factory()
- FormSetChildClass = self.formset_child
- return FormSetChildClass(self.model, **defaults)
-
-
- class StackedPolymorphicInline(PolymorphicInlineModelAdmin):
- """
- Stacked inline for django-polymorphic models.
- Since tabular doesn't make much sense with changed fields, just offer this one.
- """
-
- #: The default template to use.
- template = "admin/polymorphic/edit_inline/stacked.html"
|