当前位置：首页 > news >正文

RESPX版本升级指南：如何平滑迁移到最新版本的完整教程

news 2026/7/5 18:21:59

RESPX版本升级指南：如何平滑迁移到最新版本的完整教程

【免费下载链接】respxMock HTTPX with awesome request patterns and response side effects 🦋项目地址: https://gitcode.com/gh_mirrors/re/respx

RESPX是一个强大的HTTPX模拟库，它提供了优雅的请求模式和响应模拟功能。随着RESPX从0.14.0版本升级到0.15.0及以上版本，API发生了重大变化。本指南将帮助您了解这些变化，并提供平滑迁移到最新版本的完整教程。无论您是RESPX的新手还是现有用户，这篇指南都将帮助您顺利完成版本升级。

🚀 为什么要升级到RESPX最新版本？

RESPX 0.15.0版本引入了一系列重要的API改进，使库更加现代化和易用。主要改进包括：

更清晰的API设计：将请求模式参数与响应细节分离
更好的HTTPX兼容性：API更接近HTTPX客户端API
增强的模拟功能：响应模拟更符合Python Mock API
改进的错误处理：更好的异常处理和调试体验

📋 升级前的准备工作

在开始升级之前，请确保您已经：

备份现有代码：确保您的测试代码有版本控制
检查当前版本：运行pip show respx查看当前安装的版本
阅读变更日志：查看 CHANGELOG.md 了解详细变化
准备测试环境：在独立的测试环境中进行升级测试

🔄 主要API变更和迁移步骤

1. 响应模拟方式的变更

这是最重要的变化之一。在0.15.0之前，响应细节与请求模式混合在一起，现在它们被分离了。

旧版本（0.14.0及之前）：

respx.post("https://some.url/", status_code=200, content={"x": 1})

新版本（0.15.0+）：

# 方法1：使用.mock() respx.post("https://some.url/").mock(return_value=Response(200, json={"x": 1})) # 方法2：使用.respond() respx.post("https://some.url/").respond(200, json={"x": 1}) # 方法3：使用%操作符 respx.post("https://some.url/") % dict(json={"x": 1})

2. 路由添加API的变更

.add()API已更名为.route()，提供了更清晰的语义。

旧版本：

respx.add("POST", "https://some.url/", content="foobar")

新版本：

respx.route(method="POST", url="https://some.url/").respond(content="foobar")

3. 回调和异常处理的改进

回调和模拟异常现在作为副作用处理，这与Python的标准Mock API保持一致。

旧版本的回调：

respx.post("https://some.url/", content=callback) respx.post("https://some.url/", content=Exception()) respx.add(callback)

新版本的回调：

respx.post("https://some.url/").mock(side_effect=callback) respx.post("https://some.url/").mock(side_effect=Exception) respx.route().mock(side_effect=callback)

4. 堆叠响应的新方式

重复模拟响应（用于堆叠）现在通过副作用解决。

旧版本的堆叠：

respx.post("https://some.url/", status_code=404) respx.post("https://some.url/", status_code=200)

新版本的堆叠：

respx.post("https://some.url/").mock( side_effect=[ Response(404), Response(200), ], )

重要提示：在0.15.0+版本中，重复具有相同模式的路由会替换现有路由。

5. 别名系统的重命名

别名系统已更改为命名路由，提供更直观的API。

旧版本的别名：

respx.post("https://example.org/", alias="example") assert respx.aliases["example"].called

新版本的命名路由：

respx.post("https://example.org/", name="example") assert respx.routes["example"].called

6. 调用历史的API变更

调用历史相关的API已重命名，使其更符合Python的命名约定。

旧版本的调用历史：

assert respx.stats.call_count == 1

新版本的调用历史：

assert respx.calls.call_count == 1

7. MockTransport的替代方案

respx.MockTransport不再用作模拟路由器，应该使用respx.mock(...)。

旧版本的MockTransport：

my_mock = respx.MockTransport(assert_all_called=False)

新版本的mock函数：

my_mock = respx.mock(assert_all_called=False)

🛠️ 详细的迁移示例

让我们通过一个完整的示例来展示如何迁移现有的测试代码：

迁移前的代码（0.14.0风格）：

import httpx import respx def test_user_api(): # 设置模拟响应 respx.get("https://api.example.com/users/", status_code=200, json=[{"id": 1, "name": "Alice"}]) respx.post("https://api.example.com/users/", status_code=201, json={"id": 2, "name": "Bob"}) # 执行测试 response = httpx.get("https://api.example.com/users/") assert response.status_code == 200 # 检查调用统计 assert respx.stats.call_count == 1

迁移后的代码（0.15.0+风格）：

import httpx import respx from httpx import Response def test_user_api(): # 设置模拟响应 respx.get("https://api.example.com/users/").respond( status_code=200, json=[{"id": 1, "name": "Alice"}] ) respx.post("https://api.example.com/users/").respond( status_code=201, json={"id": 2, "name": "Bob"} ) # 执行测试 response = httpx.get("https://api.example.com/users/") assert response.status_code == 200 # 检查调用统计 assert respx.calls.call_count == 1