mirrors/wagtail
mirrors/wagtail
0
0
Fork 0
mirror of https://github.com/wagtail/wagtail.git synced 2024-12-01 11:41:20 +01:00
Code Issues Releases Wiki Activity

Move SnippetViewSet template override mechanism to ModelViewSet

Browse Source
This commit is contained in:
Sage Abdullah 2023-08-10 15:24:23 +01:00
parent a2c21798a5
commit f54eb06c2f
No known key found for this signature in database
GPG Key ID: EB1A33CC51CC0217
2 changed files with 164 additions and 47 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

100
wagtail/admin/viewsets/model.py
View File

@ -38,6 +38,9 @@ class ModelViewSet(ViewSet):
#: The view class to use for the delete view; must be a subclass of ``wagtail.admin.views.generic.DeleteView``.
delete_view_class = generic.DeleteView
#: The prefix of template names to look for when rendering the admin views.
template_prefix = ""
def __init__(self, name=None, **kwargs):
super().__init__(name=name, **kwargs)
if not self.model:
@ -66,6 +69,8 @@ class ModelViewSet(ViewSet):
return {
"model": self.model,
"permission_policy": self.permission_policy,
"template_name": self.index_template_name,
"results_template_name": self.index_results_template_name,
"index_url_name": self.get_url_name("index"),
"index_results_url_name": self.get_url_name("index_results"),
"add_url_name": self.get_url_name("add"),
@ -79,6 +84,7 @@ class ModelViewSet(ViewSet):
"model": self.model,
"permission_policy": self.permission_policy,
"form_class": self.get_form_class(),
"template_name": self.create_template_name,
"index_url_name": self.get_url_name("index"),
"add_url_name": self.get_url_name("add"),
"edit_url_name": self.get_url_name("edit"),
@ -91,6 +97,7 @@ class ModelViewSet(ViewSet):
"model": self.model,
"permission_policy": self.permission_policy,
"form_class": self.get_form_class(for_update=True),
"template_name": self.edit_template_name,
"index_url_name": self.get_url_name("index"),
"edit_url_name": self.get_url_name("edit"),
"delete_url_name": self.get_url_name("delete"),
@ -102,6 +109,7 @@ class ModelViewSet(ViewSet):
return {
"model": self.model,
"permission_policy": self.permission_policy,
"template_name": self.delete_template_name,
"index_url_name": self.get_url_name("index"),
"delete_url_name": self.get_url_name("delete"),
"header_icon": self.icon,
@ -139,6 +147,98 @@ class ModelViewSet(ViewSet):
**self.get_delete_view_kwargs(),
)
def get_templates(self, action="index", fallback=""):
"""
Utility function that provides a list of templates to try for a given
view, when the template isn't overridden by one of the template
attributes on the class.
"""
if not self.template_prefix:
return [fallback]
templates = [
f"{self.template_prefix}{self.app_label}/{self.model_name}/{action}.html",
f"{self.template_prefix}{self.app_label}/{action}.html",
f"{self.template_prefix}{action}.html",
]
if fallback:
templates.append(fallback)
return templates
@cached_property
def index_template_name(self):
"""
A template to be used when rendering ``index_view``.
Default: if :attr:`template_prefix` is specified, an ``index.html``
template in the prefix directory and its app_label/model_name
subdirectories will be used. Otherwise, the
``index_view_class.template_name`` will be used.
"""
return self.get_templates(
"index",
fallback=self.index_view_class.template_name,
)
@cached_property
def index_results_template_name(self):
"""
A template to be used when rendering ``index_results_view``.
Default: if :attr:`template_prefix` is specified, a ``index_results.html``
template in the prefix directory and its app_label/model_name
subdirectories will be used. Otherwise, the
``index_view_class.results_template_name`` will be used.
"""
return self.get_templates(
"index_results",
fallback=self.index_view_class.results_template_name,
)
@cached_property
def create_template_name(self):
"""
A template to be used when rendering ``create_view``.
Default: if :attr:`template_prefix` is specified, a ``create.html``
template in the prefix directory and its app_label/model_name
subdirectories will be used. Otherwise, the
``add_view_class.template_name`` will be used.
"""
return self.get_templates(
"create",
fallback=self.add_view_class.template_name,
)
@cached_property
def edit_template_name(self):
"""
A template to be used when rendering ``edit_view``.
Default: if :attr:`template_prefix` is specified, an ``edit.html``
template in the prefix directory and its app_label/model_name
subdirectories will be used. Otherwise, the
``edit_view_class.template_name`` will be used.
"""
return self.get_templates(
"edit",
fallback=self.edit_view_class.template_name,
)
@cached_property
def delete_template_name(self):
"""
A template to be used when rendering ``delete_view``.
Default: if :attr:`template_prefix` is specified, a ``delete.html``
template in the prefix directory and its app_label/model_name
subdirectories will be used. Otherwise, the
``delete_view_class.template_name`` will be used.
"""
return self.get_templates(
"delete",
fallback=self.delete_view_class.template_name,
)
@cached_property
def menu_label(self):
return self.model_opts.verbose_name_plural.title()

111
wagtail/snippets/views/snippets.py
View File

@ -777,27 +777,6 @@ class SnippetViewSet(ModelViewSet):
#: The prefix of template names to look for when rendering the admin views.
template_prefix = "wagtailsnippets/snippets/"
#: The template to use for the index view.
index_template_name = ""
#: The template to use for the results in the index view.
index_results_template_name = ""
#: The template to use for the create view.
create_template_name = ""
#: The template to use for the edit view.
edit_template_name = ""
#: The template to use for the delete view.
delete_template_name = ""
#: The template to use for the history view.
history_template_name = ""
#: The template to use for the inspect view.
inspect_template_name = ""
def __init__(self, **kwargs):
super().__init__(**kwargs)
@ -865,8 +844,6 @@ class SnippetViewSet(ModelViewSet):
def get_index_view_kwargs(self, **kwargs):
return super().get_index_view_kwargs(
queryset=self.get_queryset,
template_name=self.get_index_template(),
results_template_name=self.get_index_results_template(),
filterset_class=self.filterset_class,
index_url_name=self.get_url_name("list"),
index_results_url_name=self.get_url_name("list_results"),
@ -884,7 +861,6 @@ class SnippetViewSet(ModelViewSet):
def get_add_view_kwargs(self, **kwargs):
return super().get_add_view_kwargs(
template_name=self.get_create_template(),
panel=self._edit_handler,
index_url_name=self.get_url_name("list"),
preview_url_name=self.get_url_name("preview_on_add"),
@ -893,7 +869,6 @@ class SnippetViewSet(ModelViewSet):
def get_edit_view_kwargs(self, **kwargs):
return super().get_edit_view_kwargs(
template_name=self.get_edit_template(),
panel=self._edit_handler,
index_url_name=self.get_url_name("list"),
history_url_name=self.get_url_name("history"),
@ -912,7 +887,6 @@ class SnippetViewSet(ModelViewSet):
def get_delete_view_kwargs(self, **kwargs):
return super().get_delete_view_kwargs(
template_name=self.get_delete_template(),
index_url_name=self.get_url_name("list"),
usage_url_name=self.get_url_name("usage"),
**kwargs,
@ -1205,76 +1179,119 @@ class SnippetViewSet(ModelViewSet):
def get_export_filename(self):
return self.export_filename or self.model_opts.db_table
def get_templates(self, action="index", fallback=""):
"""
Utility function that provides a list of templates to try for a given
view, when the template isn't overridden by one of the template
attributes on the class.
"""
templates = [
f"{self.template_prefix}{self.app_label}/{self.model_name}/{action}.html",
f"{self.template_prefix}{self.app_label}/{action}.html",
f"{self.template_prefix}{action}.html",
]
if fallback:
templates.append(fallback)
return templates
@cached_property
def index_template_name(self):
return self.get_index_template()
def get_index_template(self):
"""
Returns a template to be used when rendering ``index_view``. If a
template is specified by the ``index_template_name`` attribute, that will
be used. Otherwise, a list of preferred template names are returned.
**Deprecated** - the preferred way to customise this is to define an ``index_template_name`` property.
"""
return self.index_template_name or self.get_templates("index")
return self.get_templates("index")
@cached_property
def index_results_template_name(self):
return self.get_index_results_template()
def get_index_results_template(self):
"""
Returns a template to be used when rendering ``index_results_view``. If a
template is specified by the ``index_results_template_name`` attribute, that will
be used. Otherwise, a list of preferred template names are returned.
**Deprecated** - the preferred way to customise this is to define an ``index_results_template_name`` property.
"""
return self.index_results_template_name or self.get_templates("index_results")
return self.get_templates("index_results")
@cached_property
def create_template_name(self):
return self.get_create_template()
def get_create_template(self):
"""
Returns a template to be used when rendering ``create_view``. If a
template is specified by the ``create_template_name`` attribute, that will
be used. Otherwise, a list of preferred template names are returned.
**Deprecated** - the preferred way to customise this is to define a ``create_template_name`` property.
"""
return self.create_template_name or self.get_templates("create")
return self.get_templates("create")
@cached_property
def edit_template_name(self):
return self.get_edit_template()
def get_edit_template(self):
"""
Returns a template to be used when rendering ``edit_view``. If a
template is specified by the ``edit_template_name`` attribute, that will
be used. Otherwise, a list of preferred template names are returned.
**Deprecated** - the preferred way to customise this is to define an ``edit_template_name`` property.
"""
return self.edit_template_name or self.get_templates("edit")
return self.get_templates("edit")
@cached_property
def delete_template_name(self):
return self.get_delete_template()
def get_delete_template(self):
"""
Returns a template to be used when rendering ``delete_view``. If a
template is specified by the ``delete_template_name`` attribute, that will
be used. Otherwise, a list of preferred template names are returned.
**Deprecated** - the preferred way to customise this is to define a ``delete_template_name`` property.
"""
return self.delete_template_name or self.get_templates("delete")
return self.get_templates("delete")
@cached_property
def history_template_name(self):
"""
A template to be used when rendering ``history_view``.
Default: if :attr:`template_prefix` is specified, a ``history.html``
template in the prefix directory and its app_label/model_name
subdirectories will be used. Otherwise, the
``history_view_class.template_name`` will be used.
"""
return self.get_history_template()
def get_history_template(self):
"""
Returns a template to be used when rendering ``history_view``. If a
template is specified by the ``history_template_name`` attribute, that will
be used. Otherwise, a list of preferred template names are returned.
**Deprecated** - the preferred way to customise this is to define a ``history_template_name`` property.
"""
return self.history_template_name or self.get_templates("history")
return self.get_templates("history")
@cached_property
def inspect_template_name(self):
"""
A template to be used when rendering ``inspect_view``.
Default: if :attr:`template_prefix` is specified, an ``inspect.html``
template in the prefix directory and its app_label/model_name
subdirectories will be used. Otherwise, the
``inspect_view_class.template_name`` will be used.
"""
return self.get_inspect_template()
def get_inspect_template(self):
"""
Returns a template to be used when rendering ``inspect_view``. If a
template is specified by the ``inspect_template_name`` attribute, that will
be used. Otherwise, a list of preferred template names are returned.
**Deprecated** - the preferred way to customise this is to define an ``inspect_template_name`` property.
"""
return self.inspect_template_name or self.get_templates(
return self.get_templates(
"inspect", fallback=self.inspect_view_class.template_name
)