Django 5.2.dev 文档

Home | Table of contents | Index | Modules

« previous | up | next »

测试工具¶

Django提供了一组在编写测试时很有用的工具。

测试客户端¶

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

您可以对测试客户机执行以下操作：

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

注意，测试客户机并不打算替代 Selenium 或其他“浏览器内”框架。Django的测试客户机有不同的关注点。简而言之：

使用Django的测试客户机来确定正在呈现正确的模板，并传递正确的上下文数据。
使用 RequestFactory 直接测试视图功能，绕过路由层和中间件层。
使用浏览器内框架，如 Selenium 为了测试 rendered 超文本标记语言和 behavior 网页的特性，也就是脚本功能。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...'

如本例所示，您可以实例化 Client 在Python交互式解释器的会话中。

注意一些关于测试客户机如何工作的重要事项：

测试客户端执行以下操作 not 要求Web服务器正在运行。事实上，在根本不运行Web服务器的情况下，它将运行得很好！这是因为它避免了HTTP的开销，直接处理Django框架。这有助于快速运行单元测试。
在检索页面时，请记住指定 path URL，而不是整个域。例如，这是正确的：
```
>>> c.get("/login/")
```
这是不正确的：
```
>>> c.get("https://www.example.com/login/")
```
测试客户端无法检索未由您的Django项目提供支持的网页。如果需要检索其他网页，请使用如下所示的Python标准库模块 urllib 。
为了解析URL，测试客户机使用您的 ROOT_URLCONF 设置。
尽管上面的示例可以在Python交互式解释器中使用，但是测试客户机的一些功能，特别是与模板相关的功能，仅可用。 测试运行时 .

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

如果，出于某种原因，你 want 要执行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, raise_request_exception=True, json_encoder=DjangoJSONEncoder, *, headers=None, query_params=None, **defaults)[源代码]¶

一个测试的HTTP客户端。采用几个可以自定义行为的参数。

headers 允许您指定将随每个请求一起发送的默认标头。例如，要设置一个 User-Agent 标题：：

client = Client(headers={"user-agent": "curl/7.79.1"})

query_params 允许您指定将在每个请求上设置的默认查询字符串。

中的任意关键字参数 **defaults 设置WSGI environ variables 。例如，要设置脚本名称：：

client = Client(SCRIPT_NAME="/app/")

备注

开头的关键字参数 HTTP_ 前缀被设置为标头，但 headers 参数应优先用于可读性。

中的值 headers ， query_params ，以及 extra 传递给的关键字参数 get() ， post() 等优先于传递给类构造函数的默认值。

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

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

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

Changed in Django 5.1:

这个 query_params 添加了参数。

一旦你拥有了 Client 实例中，可以调用以下任何方法：

get(path, data=None, follow=False, secure=False, *, headers=None, query_params=None, **extra)[源代码]¶

在提供的上发出获取请求 path 返回一个 Response 对象，见下文。

中的键-值对 query_params 字典用于设置查询字符串。例如：

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

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

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

也可以将这些参数传递到 data 参数。然而， query_params 是首选的，因为它适用于任何HTTP方法。

这个 headers 参数可用于指定要在请求中发送的标头。例如：

>>> c = Client()
>>> c.get(
...     "/customers/details/",
...     query_params={"name": "fred", "age": 7},
...     headers={"accept": "application/json"},
... )

...将发送HTTP标头 HTTP_ACCEPT 到详细信息视图，这是测试使用 django.http.HttpRequest.accepts() 方法。

任意关键字参数集WSGI environ variables 。例如，用于设置脚本名称的Header：

>>> c = Client()
>>> c.get("/", SCRIPT_NAME="/app/")

如果您已经有URL编码形式的GET参数，则可以使用该编码而不是使用Data参数。例如，前一个GET请求也可以被伪装成：

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

如果您提供的URL同时具有编码的GET数据和QUERY_PARAMS或DATA参数，则这些参数将优先。

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

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

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

如果你设置 secure 到 True 客户端将模拟一个HTTPS请求。

Changed in Django 5.1:

这个 query_params 添加了参数。

post(path, data=None, content_type=MULTIPART_CONTENT, follow=False, secure=False, *, headers=None, query_params=None, **extra)[源代码]¶

在提供的 path 返回一个 Response 对象，见下文。

中的键-值对 data 词典用于提交帖子数据。例如：

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

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

/login/

...使用此帖子数据：

name=fred&passwd=secret

如果你提供 content_type 作为 application/json , the data 使用序列化 json.dumps() 如果是dict、list或tuple。使用执行序列化 DjangoJSONEncoder 默认情况下，可以通过提供 json_encoder 参数 Client . 此序列化也发生在 put() ， patch() 和 delete() 请求。

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

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

为给定的键提交多个值——例如，为 <select multiple> --将值作为所需键的列表或元组提供。例如，此值为 data 将为名为的字段提交三个选定值 choices ：：

{"choices": ["a", "b", "d"]}

提交文件是一种特例。要发布文件，只需提供文件字段名作为键，以及要上载的文件的文件句柄作为值。例如，如果您的表单包含字段 name 和 attachment ，后者是 FileField ：

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

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

>>> from io import BytesIO
>>> img = BytesIO(
...     b"GIF89a\x01\x00\x01\x00\x00\x00\x00!\xf9\x04\x01\x00\x00\x00"
...     b"\x00,\x00\x00\x00\x00\x01\x00\x01\x00\x00\x02\x01\x00\x00"
... )
>>> img.name = "myimage.gif"

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

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

这个 headers ， query_params ，以及 extra 参数的作用与 Client.get() 。

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

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

…处理此请求的视图可以询问request.post以检索用户名和密码，还可以询问request.get以确定用户是否是访问者。

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

如果你设置 secure 到 True 客户端将模拟一个HTTPS请求。

Changed in Django 5.1:

这个 query_params 添加了参数。

head(path, data=None, follow=False, secure=False, *, headers=None, query_params=None, **extra)[源代码]¶: 在提供的 path 并返回一个 Response 对象。此方法的工作原理与 Client.get() ，包括 follow ， secure ， headers ， query_params ，以及 extra 参数，除非它不返回消息体。

Changed in Django 5.1:
这个 query_params 添加了参数。

options(path, data='', content_type='application/octet-stream', follow=False, secure=False, *, headers=None, query_params=None, **extra)[源代码]¶

在提供的 path 返回一个 Response 对象。用于测试RESTful接口。

什么时候？ data 提供，它用作请求主体，以及 Content-Type 标题设置为 content_type .