Python-Django系列—视图

一、通用显示视图

以下两个基于类的通用视图旨在显示数据。在许多项目中，它们通常是最常用的视图。

1、DetailView

class django.views.generic.detail.DetailView

当该视图执行时，self.object 将包含该视图正在操作的对象。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.detail.SingleObjectTemplateResponseMixin
• django.views.generic.base.TemplateResponseMixin
• django.views.generic.detail.BaseDetailView
• django.views.generic.detail.SingleObjectMixin
• django.views.generic.base.View

方法流程图

1. setup()
2. dispatch()
3. http_method_not_allowed()
4. get_template_names()
5. get_slug_field()
6. get_queryset()
7. get_object()
8. get_context_object_name()
9. get_context_data()
10. get()
11. render_to_response()

示例 myapp/views.py：

from django.utils import timezone
from django.views.generic.detail import DetailViewfrom articles.models import Articleclass ArticleDetailView(DetailView):model = Articledef get_context_data(self, **kwargs):context = super().get_context_data(**kwargs)context["now"] = timezone.now()return context

 示例 myapp/urls.py：

from django.urls import pathfrom article.views import ArticleDetailViewurlpatterns = [path("<slug:slug>/", ArticleDetailView.as_view(), name="article-detail"),
]

示例 myapp/article_detail.html：

<h1>{{ object.headline }}</h1>
<p>{{ object.content }}</p>
<p>Reporter: {{ object.reporter }}</p>
<p>Published: {{ object.pub_date|date }}</p>
<p>Date: {{ now|date }}</p>

class django.views.generic.detail.BaseDetailView

一个用于显示单个对象的基础视图。它不打算直接使用，而是作为 django.view.generic.detail.DetailView 或其他表示单个对象细节的视图的父类。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.detail.SingleObjectMixin
• django.views.generic.base.View

方法

get(request, *args, **kwargs)

将 object 添加到上下文中。

2、ListView

class django.views.generic.list.ListView

一个表示对象列表的页面。

当该视图执行时，self.object_list 将包含该视图正在操作的对象列表（通常，但不一定是查询集）。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.list.MultipleObjectTemplateResponseMixin
• django.views.generic.base.TemplateResponseMixin
• django.views.generic.list.BaseListView
• django.views.generic.list.MultipleObjectMixin
• django.views.generic.base.View

方法流程图

• setup()
• dispatch()
• http_method_not_allowed()
• get_template_names()
• get_queryset()
• get_context_object_name()
• get_context_data()
• get()
• render_to_response()

示例 views.py：

from django.utils import timezone
from django.views.generic.list import ListViewfrom articles.models import Articleclass ArticleListView(ListView):model = Articlepaginate_by = 100  # if pagination is desireddef get_context_data(self, **kwargs):context = super().get_context_data(**kwargs)context["now"] = timezone.now()return context

示例 myapp/urls.py：

from django.urls import pathfrom article.views import ArticleListViewurlpatterns = [path("", ArticleListView.as_view(), name="article-list"),
]

示例 myapp/article_list.html：

<h1>Articles</h1>
<ul>
{% for article in object_list %}<li>{{ article.pub_date|date }} - {{ article.headline }}</li>
{% empty %}<li>No articles yet.</li>
{% endfor %}
</ul>

class django.views.generic.list.BaseListView
一个用于显示对象列表的基础视图。它不打算直接使用，而是作为 django.view.generic.list.ListView 或其他代表对象列表的视图的父类。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.list.MultipleObjectMixin
• django.views.generic.base.View

方法

get(request, *args, **kwargs)
添加 object_list 到上下文。如果 allow_empty 为 True，则显示一个空列表。如果 allow_empty 为 False，则引发一个 404 错误。

二、通用编辑视图

本页介绍了以下视图，为编辑内容奠定了基础。

• django.views.generic.edit.FormView
• django.views.generic.edit.CreateView
• django.views.generic.edit.UpdateView
• django.views.generic.edit.DeleteView

Note

本页的一些例子假定 Author 模型已在 myapp/models.py 中定义如下：

from django.db import models
from django.urls import reverseclass Author(models.Model):name = models.CharField(max_length=200)def get_absolute_url(self):return reverse("author-detail", kwargs={"pk": self.pk})

1、FormView

class django.views.generic.edit.FormView 

一个显示表单的视图。错误时，重新显示验证错误的表单；成功时，重定向到一个新的 URL。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.base.TemplateResponseMixin
• django.views.generic.edit.BaseFormView
• django.views.generic.edit.FormMixin
• django.views.generic.edit.ProcessFormView
• django.views.generic.base.View

示例 myapp/forms.py：

from django import formsclass ContactForm(forms.Form):name = forms.CharField()message = forms.CharField(widget=forms.Textarea)def send_email(self):# send email using the self.cleaned_data dictionarypass

示例 myapp/views.py：

from myapp.forms import ContactForm
from django.views.generic.edit import FormViewclass ContactFormView(FormView):template_name = "contact.html"form_class = ContactFormsuccess_url = "/thanks/"def form_valid(self, form):# This method is called when valid form data has been POSTed.# It should return an HttpResponse.form.send_email()return super().form_valid(form)

示例 myapp/contact.html：

<form method="post">{% csrf_token %}{{ form.as_p }}<input type="submit" value="Send message">
</form>

class django.views.generic.edit.BaseFormView

一个用于显示表单的基础视图。它不打算直接使用，而是作为 django.view.generic.edit.FormView 或其他显示表单的视图的父类。

祖先（MRO）

该视图从以下视图继承方法和属性：

• django.views.generic.edit.FormMixin
• django.views.generic.edit.ProcessFormView

2、CreateView

class django.views.generic.edit.CreateView

一个显示表单的视图，用于创建对象，重新显示带有验证错误（如果有）的表单并保存对象。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.detail.SingleObjectTemplateResponseMixin
• django.views.generic.base.TemplateResponseMixin
• django.views.generic.edit.BaseCreateView
• django.views.generic.edit.ModelFormMixin
• django.views.generic.edit.FormMixin
• django.views.generic.detail.SingleObjectMixin
• django.views.generic.edit.ProcessFormView
• django.views.generic.base.View

属性

template_name_suffix

对 GET 请求显示的 CreateView 页面使用 '_form' 的 template_name_suffix。例如，将这个属性改为 '_create_form'，为 Author 模型创建对象的视图将导致默认的 template_name 为 'myapp/author_create_form.html'。

object

当使用 CreateView 时，你可以访问 self.object，也就是正在创建的对象。如果对象还没有被创建，其值将是 None。

示例 myapp/views.py：

from django.views.generic.edit import CreateView
from myapp.models import Authorclass AuthorCreateView(CreateView):model = Authorfields = ["name"]

示例 myapp/author_form.html：

<form method="post">{% csrf_token %}{{ form.as_p }}<input type="submit" value="Save">
</form>

class django.views.generic.edit.BaseCreateView

一个用于创建新对象实例的基础视图。它不打算直接使用，而是作为 django.view.generic.edit.CreateView 的父类。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.edit.ModelFormMixin
• django.views.generic.edit.ProcessFormView

方法

get(request, *args, **kwargs)
将当前对象实例（self.object）设置为 None。

post(request, *args, **kwargs)
将当前对象实例（self.object）设置为 None。

3、UpdateView

class django.views.generic.edit.UpdateView

显示用于编辑现有对象的表单视图，重新显示带有验证错误（如果有）的表单并保存对对象的更改。该视图使用从对象的模型类自动生成的表单（除非手动指定了表单类）。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.detail.SingleObjectTemplateResponseMixin
• django.views.generic.base.TemplateResponseMixin
• django.views.generic.edit.BaseUpdateView
• django.views.generic.edit.ModelFormMixin
• django.views.generic.edit.FormMixin
• django.views.generic.detail.SingleObjectMixin
• django.views.generic.edit.ProcessFormView
• django.views.generic.base.View

属性

template_name_suffix
显示在 GET 请求中的 UpdateView 页面使用 '_form' 的 template_name_suffix。例如，将这个属性改为 '_update_form'，对于一个更新对象的视图，例如 Author 模型，将导致默认的 template_name 为``'myapp/author_update_form.html'``。

object
当使用 UpdateView 时，你可以访问 self.object，也就是被更新的对象。

示例 myapp/views.py：

from django.views.generic.edit import UpdateView
from myapp.models import Authorclass AuthorUpdateView(UpdateView):model = Authorfields = ["name"]template_name_suffix = "_update_form"

示例 myapp/author_update_form.html：

<form method="post">{% csrf_token %}{{ form.as_p }}<input type="submit" value="Update">
</form>

class django.views.generic.edit.BaseUpdateView
一个用于更新现有对象实例的基础视图。它不打算直接使用，而是作为 django.view.generic.edit.UpdateView 的父类

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.edit.ModelFormMixin
• django.views.generic.edit.ProcessFormView

方法

get(request, *args, **kwargs)

设置当前对象实例（self.object）。

post(request, *args, **kwargs)

设置当前对象实例（self.object）。

4、DeleteView

class django.views.generic.edit.DeleteView
显示确认页面并删除现有对象的视图。只有当请求方法是 POST 时，给定的对象才会被删除。如果这个视图是通过 GET 获取的，它将显示一个确认页面，该页面应该包含一个 POST 到同一 URL 的表单。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.detail.SingleObjectTemplateResponseMixin
• django.views.generic.base.TemplateResponseMixin
• django.views.generic.edit.BaseDeleteView
• django.views.generic.edit.DeletionMixin
• django.views.generic.edit.FormMixin
• django.views.generic.base.ContextMixin
• django.views.generic.detail.BaseDetailView
• django.views.generic.detail.SingleObjectMixin
• django.views.generic.base.View

属性

form_class
从 BaseDeleteView 继承而来。将用于确认请求的表单类。默认 django.forms.Form，结果是一个空的表单，总是有效的。

通过提供你自己的 Form 子类，你可以添加额外的要求，比如说，确认复选框。

template_name_suffix
对 GET 请求显示的 DeleteView 页面使用 '_confirm_delete' 的 template_name_suffix。例如，将这个属性改为 '_check_delete'，对于一个为 Author 模型删除对象的视图，将导致默认的 template_name 为 'myapp/author_check_delete.html'。

示例 myapp/views.py：

from django.urls import reverse_lazy
from django.views.generic.edit import DeleteView
from myapp.models import Authorclass AuthorDeleteView(DeleteView):model = Authorsuccess_url = reverse_lazy("author-list")

示例 myapp/author_confirm_delete.html：

<form method="post">{% csrf_token %}<p>Are you sure you want to delete "{{ object }}"?</p>{{ form }}<input type="submit" value="Confirm">
</form>

class django.views.generic.edit.BaseDeleteView
一个用于删除对象实例的基础视图。它不打算直接使用，而是作为 django.view.generic.edit.DeleteView 的父类。

祖先（MRO）

该视图从以下视图继承方法和属性。

• django.views.generic.edit.DeletionMixin
• django.views.generic.edit.FormMixin
• django.views.generic.detail.BaseDetailView