测试工具

Django 提供了一小组在编写测试时派上用场的工具。

测试客户端

测试客户端是一个 Python 类，充当虚拟 Web 浏览器，允许您测试视图并以编程方式与 Django 驱动的应用程序交互。

你可以用测试客户端做的一些事情是：

在 URL 上模拟 GET 和 POST 请求并观察响应——从低级 HTTP（结果标头和状态代码）到页面内容的所有内容。
查看重定向链（如果有）并检查每一步的 URL 和状态代码。
测试给定的请求是否由给定的 Django 模板呈现，模板上下文包含某些值。

请注意，测试客户端并非旨在替代 Selenium 或其他“浏览器内”框架。 Django 的测试客户端有不同的侧重点。简而言之：

使用 Django 的测试客户端来确定正在呈现正确的模板并且向模板传递了正确的上下文数据。
使用 Selenium 等浏览器内框架来测试 渲染的 HTML 和网页的行为，即 JavaScript 功能。 Django 还为这些框架提供了特殊支持；有关更多详细信息，请参阅 LiveServerTestCase 部分。

综合测试套件应结合使用两种测试类型。

概述和快速示例

要使用测试客户端，请实例化 django.test.Client 并检索网页：

>>> from django.test import Client
>>> c = Client()
>>> response = c.post('/login/', {'username': 'john', 'password': 'smith'})
>>> response.status_code
200
>>> response = c.get('/customer/details/')
>>> response.content
b'<!DOCTYPE html...'

正如此示例所建议的，您可以从 Python 交互式解释器的会话中实例化 Client。

请注意有关测试客户端如何工作的一些重要事项：

测试客户端不要求运行 Web 服务器。事实上，它会在没有任何 Web 服务器运行的情况下运行得很好！那是因为它避免了 HTTP 的开销，直接与 Django 框架打交道。这有助于使单元测试快速运行。
检索页面时，请记住指定 URL 的路径，而不是整个域。例如，这是正确的：
```
>>> c.get('/login/')
```
这是不正确的：
```
>>> c.get('https://www.example.com/login/')
```
测试客户端无法检索不是由您的 Django 项目提供支持的网页。如果您需要检索其他网页，请使用 Python 标准库模块，例如 urllib。
为了解析 URL，测试客户端使用 :setting:`ROOT_URLCONF` 设置指向的任何 URLconf。
虽然上面的例子可以在 Python 交互式解释器中工作，但一些测试客户端的功能，特别是与模板相关的功能，只有在测试运行时才可用 '。

这样做的原因是 Django 的测试运行器执行了一些黑魔法，以确定给定视图加载了哪个模板。这种黑魔法（本质上是在内存中修补 Django 的模板系统）仅在测试运行期间发生。
默认情况下，测试客户端将禁用您的站点执行的任何 CSRF 检查。

如果由于某种原因，您希望测试客户端执行 CSRF 检查，您可以创建一个测试客户端的实例来强制执行 CSRF 检查。为此，请在构建客户端时传入 enforce_csrf_checks 参数：
```
>>> from django.test import Client
>>> csrf_client = Client(enforce_csrf_checks=True)
```

提出要求

使用 django.test.Client 类发出请求。

class Client(enforce_csrf_checks=False, json_encoder=DjangoJSONEncoder, **defaults)

它在构建时不需要参数。但是，您可以使用关键字参数来指定一些默认标题。例如，这将在每个请求中发送一个 User-Agent HTTP 标头：

>>> c = Client(HTTP_USER_AGENT='Mozilla/5.0')

来自 extra 关键字参数的值传递给 get()、post() 等。优先于传递给类构造函数的默认值。

enforce_csrf_checks 参数可用于测试 CSRF 保护（见上文）。

json_encoder 参数允许为 post() 中描述的 JSON 序列化设置自定义 JSON 编码器。

raise_request_exception 参数允许控制在请求期间引发的异常是否也应该在测试中引发。默认为 True。

3.0 新功能：增加了 raise_request_exception 参数。

拥有 Client 实例后，您可以调用以下任何方法：

get(path, data=None, follow=False, secure=False, **extra)

对提供的 path 发出 GET 请求并返回 Response 对象，如下所述。

data 字典中的键值对用于创建 GET 数据负载。例如：

>>> c = Client()
>>> c.get('/customers/details/', {'name': 'fred', 'age': 7})

...将导致对 GET 请求的评估相当于：

/customers/details/?name=fred&age=7

extra 关键字参数参数可用于指定要在请求中发送的标头。例如：

>>> c = Client()
>>> c.get('/customers/details/', {'name': 'fred', 'age': 7},
...       HTTP_X_REQUESTED_WITH='XMLHttpRequest')

...将 HTTP 标头 HTTP_X_REQUESTED_WITH 发送到详细信息视图，这是测试使用 django.http.HttpRequest.is_ajax() 方法的代码路径的好方法。

CGI规范

通过 **extra 发送的标头应遵循 CGI 规范。例如，模拟从浏览器到服务器的 HTTP 请求中发送的不同“主机”标头应作为 HTTP_HOST 传递。

如果您已经有 URL 编码形式的 GET 参数，则可以使用该编码而不是使用数据参数。例如，之前的 GET 请求也可以是：

>>> c = Client()
>>> c.get('/customers/details/?name=fred&age=7')

如果您提供的 URL 包含编码的 GET 数据和数据参数，则数据参数将优先。

如果将 follow 设置为 True，客户端将遵循任何重定向，并且 redirect_chain 属性将在包含中间 URL 和状态代码元组的响应对象中设置。

如果您有一个重定向到 /next/ 的 URL /redirect_me/，然后重定向到 /final/，这就是您会看到的：

>>> response = c.get('/redirect_me/', follow=True)
>>> response.redirect_chain
[('http://testserver/next/', 302), ('http://testserver/final/', 302)]

如果您将 secure 设置为 True，客户端将模拟 HTTPS 请求。

post(path, data=None, content_type=MULTIPART_CONTENT, follow=False, secure=False, **extra)

对提供的 path 发出 POST 请求并返回 Response 对象，如下所述。

data字典中的键值对用于提交POST数据。例如：

>>> c = Client()
>>> c.post('/login/', {'name': 'fred', 'passwd': 'secret'})

...将导致评估对此 URL 的 POST 请求：

/login/

...使用此 POST 数据：

name=fred&passwd=secret

如果您提供 content_type 作为 application/json，则 data 使用 json.dumps() 序列化，如果它是一个字典、列表或元组。默认情况下使用 DjangoJSONEncoder 执行序列化，并且可以通过向 Client 提供 json_encoder 参数来覆盖。这种序列化也适用于 put()、patch() 和 delete() 请求。

2.2 版更改： JSON 序列化扩展为支持列表和元组。在旧版本中，只有 dicts 被序列化。

如果您提供任何其他 content_type（例如 text/xml 用于 XML 负载），data 的内容在 POST 请求中按原样发送，在 HTTP Content-Type 中使用 content_type标题。

如果您不为 content_type 提供值，则 data 中的值将以 multipart/form-data 的内容类型传输。在这种情况下，data 中的键值对将被编码为多部分消息并用于创建 POST 数据负载。

要为给定键提交多个值 - 例如，指定 <select multiple> 的选择 - 以列表或元组的形式提供所需键的值。例如，data 的这个值将为名为 choices 的字段提交三个选定的值：

{'choices': ('a', 'b', 'd')}

提交文件是一种特殊情况。要发布文件，您只需要提供文件字段名称作为键，并提供您希望上传的文件的文件句柄作为值。例如：

>>> c = Client()
>>> with open('wishlist.doc') as fp:
...     c.post('/customers/wishes/', {'name': 'fred', 'attachment': fp})

（此处的名称 attachment 无关紧要；使用文件处理代码期望的任何名称。）

您还可以提供任何类似文件的对象（例如，StringIO 或 BytesIO）作为文件句柄。如果您上传到 ImageField，则对象需要一个 name 属性，该属性通过 validate_image_file_extension 验证器。例如：

>>> from io import BytesIO
>>> img = BytesIO(b'mybinarydata')
>>> img.name = 'myimage.jpg'

请注意，如果您希望对多个 post() 调用使用相同的文件句柄，则您需要在帖子之间手动重置文件指针。最简单的方法是在文件提供给 post() 后手动关闭文件，如上所示。

您还应该确保以允许读取数据的方式打开文件。如果您的文件包含二进制数据，例如图像，这意味着您需要以 rb（读取二进制）模式打开文件。

extra 参数的作用与 Client.get() 相同。

如果您使用 POST 请求的 URL 包含编码参数，则这些参数将在 request.GET 数据中可用。例如，如果您要提出请求：

>>> c.post('/login/?visitor=true', {'name': 'fred', 'passwd': 'secret'})

... 处理这个请求的视图可以询问 request.POST 来检索用户名和密码，并且可以询问 request.GET 来确定用户是否是访客。

如果将 follow 设置为 True，客户端将遵循任何重定向，并且 redirect_chain 属性将在包含中间 URL 和状态代码元组的响应对象中设置。

如果您将 secure 设置为 True，客户端将模拟 HTTPS 请求。

head(path, data=None, follow=False, secure=False, **extra): 对提供的 path 发出 HEAD 请求并返回 Response 对象。此方法的工作方式与 Client.get() 类似，包括 follow、secure 和 extra 参数，只是它不返回消息正文。

options(path, data=, content_type='application/octet-stream', follow=False, secure=False, **extra)

对提供的 path 发出 OPTIONS 请求并返回 Response 对象。用于测试 RESTful 接口。

当提供 data 时，将其用作请求正文，并将 Content-Type 标头设置为 content_type。