Django 快捷函数¶
包 django.shortcuts
收集了跨越 MVC 多个级别的辅助函数和类。换句话说,这些函数/类为了方便起见引入了受控耦合。
render()
¶
- render(request, template_name, context=None, content_type=None, status=None, using=None)[source]¶
将给定的模板与给定的上下文字典组合,并返回一个包含渲染文本的
HttpResponse
对象。Django 没有提供返回
TemplateResponse
的快捷函数,因为TemplateResponse
的构造函数提供了与render()
相同的便利性。
必需参数¶
request
用于生成此响应的请求对象。
template_name
要使用的模板的完整名称或模板名称序列。如果给定一个序列,则将使用第一个存在的模板。有关如何查找模板的更多信息,请参阅 模板加载文档。
可选参数¶
context
要添加到模板上下文的键值对字典。默认情况下,这是一个空字典。如果字典中的值为可调用对象,则视图将在渲染模板之前调用它。
content_type
用于结果文档的 MIME 类型。默认为
'text/html'
。status
响应的状态代码。默认为
200
。using
用于加载模板的模板引擎的
NAME
。
示例¶
以下示例使用 MIME 类型 application/xhtml+xml 渲染模板 myapp/index.html
from django.shortcuts import render
def my_view(request):
# View code here...
return render(
request,
"myapp/index.html",
{
"foo": "bar",
},
content_type="application/xhtml+xml",
)
此示例等效于
from django.http import HttpResponse
from django.template import loader
def my_view(request):
# View code here...
t = loader.get_template("myapp/index.html")
c = {"foo": "bar"}
return HttpResponse(t.render(c, request), content_type="application/xhtml+xml")
redirect()
¶
- redirect(to, *args, permanent=False, **kwargs)[source]¶
返回一个
HttpResponseRedirect
到传递的参数的相应 URL。参数可以是
模型:将调用模型的
get_absolute_url()
函数。视图名称,可能带参数:
reverse()
将用于反向解析名称。绝对或相对 URL,将按原样用作重定向位置。
默认情况下发出临时重定向;传递
permanent=True
以发出永久重定向。
示例¶
您可以通过多种方式使用 redirect()
函数。
通过传递一些对象;将调用该对象的
get_absolute_url()
方法来确定重定向 URLfrom django.shortcuts import redirect def my_view(request): ... obj = MyModel.objects.get(...) return redirect(obj)
通过传递视图的名称以及可选的一些位置或关键字参数;URL 将使用
reverse()
方法反向解析def my_view(request): ... return redirect("some-view-name", foo="bar")
通过传递要重定向到的硬编码 URL
def my_view(request): ... return redirect("/some/url/")
这也适用于完整 URL
def my_view(request): ... return redirect("https://example.com/")
默认情况下,redirect()
返回临时重定向。以上所有表单都接受 permanent
参数;如果设置为 True
,则将返回永久重定向
def my_view(request):
...
obj = MyModel.objects.get(...)
return redirect(obj, permanent=True)
get_object_or_404()
¶
- aget_object_or_404(klass, *args, **kwargs)¶
异步版本:
aget_object_or_404()
在给定的模型管理器上调用
get()
,但它引发Http404
而不是模型的DoesNotExist
异常。
参数¶
示例¶
以下示例从 MyModel
中获取主键为 1 的对象
from django.shortcuts import get_object_or_404
def my_view(request):
obj = get_object_or_404(MyModel, pk=1)
此示例等效于
from django.http import Http404
def my_view(request):
try:
obj = MyModel.objects.get(pk=1)
except MyModel.DoesNotExist:
raise Http404("No MyModel matches the given query.")
最常见的用例是传递一个 Model
,如上所示。但是,您也可以传递一个 QuerySet
实例
queryset = Book.objects.filter(title__startswith="M")
get_object_or_404(queryset, pk=1)
上面的例子有点牵强,因为它等同于执行
get_object_or_404(Book, title__startswith="M", pk=1)
但如果您从其他地方传递了 queryset
变量,它可能很有用。
最后,您还可以使用 Manager
。例如,如果您有 自定义管理器,这将很有用
get_object_or_404(Book.dahl_objects, title="Matilda")
您还可以使用 相关管理器
author = Author.objects.get(name="Roald Dahl")
get_object_or_404(author.book_set, title="Matilda")
注意:与 get()
一样,如果找到多个对象,则会引发 MultipleObjectsReturned
异常。
aget_object_or_404()
函数已添加。
get_list_or_404()
¶
- aget_list_or_404(klass, *args, **kwargs)¶
异步版本:
aget_list_or_404()
参数¶
示例¶
以下示例获取 MyModel
中所有已发布的对象
from django.shortcuts import get_list_or_404
def my_view(request):
my_objects = get_list_or_404(MyModel, published=True)
此示例等效于
from django.http import Http404
def my_view(request):
my_objects = list(MyModel.objects.filter(published=True))
if not my_objects:
raise Http404("No MyModel matches the given query.")
aget_list_or_404()
函数已添加。