Django 快捷功能 — Django 文档

Django 快捷功能

包 django.shortcuts 收集了“跨越”MVC 多个级别的辅助函数和类。 换句话说，为了方便起见，这些函数/类引入了受控耦合。

render()

render(request, template_name, context=None, content_type=None, status=None, using=None)

将给定的模板与给定的上下文字典相结合，并返回一个带有渲染文本的 HttpResponse 对象。

Django 不提供返回 TemplateResponse 的快捷函数，因为 TemplateResponse 的构造函数提供了与 render() 相同级别的便利。

必需参数

request

用于生成此响应的请求对象。

template_name

要使用的模板的全名或模板名称序列。 如果给出序列，则将使用存在的第一个模板。 有关如何找到模板的更多信息，请参阅 模板加载文档 。

可选参数

context

要添加到模板上下文的值字典。 默认情况下，这是一个空字典。 如果字典中的值是可调用的，视图将在渲染模板之前调用它。

content_type

用于结果文档的 MIME 类型。 默认为 :setting:`DEFAULT_CONTENT_TYPE` 设置的值。

status

响应的状态代码。 默认为 200。

using

这 :setting:`名称 ` 用于加载模板的模板引擎。

示例

以下示例使用 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')

render_to_response()

render_to_response(template_name, context=None, content_type=None, status=None, using=None)

自 2.0 版起已弃用。

该函数先于 render() 的引入，并且工作方式类似，只是它不使 request 在响应中可用。

redirect()

redirect(to, *args, permanent=False, **kwargs)

将 HttpResponseRedirect 返回到传递参数的适当 URL。

参数可能是：

• 模型：模型的 get_absolute_url() 函数将被调用。

• 视图名称，可能带有参数： reverse() 将用于反向解析名称。

• 绝对或相对 URL，将按原样用于重定向位置。

默认情况下发出临时重定向； 通过 permanent=True 发出永久重定向。

例子

您可以通过多种方式使用 redirect() 函数。

1. 通过传递一些对象； 将调用该对象的 get_absolute_url() 方法来找出重定向 URL：

   from django.shortcuts import redirect
   
   def my_view(request):
       ...
       obj = MyModel.objects.get(...)
       return redirect(obj)

2. 通过传递视图的名称和可选的一些位置或关键字参数； URL 将使用 reverse() 方法反向解析：

   def my_view(request):
       ...
       return redirect('some-view-name', foo='bar')

3. 通过传递硬编码的 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()

get_object_or_404(klass, *args, **kwargs)

在给定的模型管理器上调用 get()，但它引发 Http404 而不是模型的 DoesNotExist 异常。

必需参数

klass

从中获取对象的 Model 类、Manager 或 QuerySet 实例。

**kwargs

查找参数，应该是get()和filter()接受的格式。

示例

以下示例从 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 异常。

get_list_or_404()

get_list_or_404(klass, *args, **kwargs)

返回给定模型管理器上的 filter() 转换为列表的结果，如果结果列表为空，则引发 Http404。

必需参数

klass

从中获取列表的 Model、Manager 或 QuerySet 实例。

**kwargs

查找参数，应该是get()和filter()接受的格式。

示例

以下示例从 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.")