HTTPretty 高级使用指南：正则匹配与回调机制详解-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00191/article/details/148891378

HTTPretty 高级使用指南：正则匹配与回调机制详解

HTTPretty Intercept HTTP requests at the Python socket level. Fakes the whole socket module 项目地址: https://gitcode.com/gh_mirrors/ht/HTTPretty

HTTPretty 是一个强大的 Python HTTP 模拟库，主要用于测试环境中拦截和模拟 HTTP 请求。本文将深入探讨 HTTPretty 的两个核心高级功能：URL 正则匹配和响应回调机制。

一、URL 正则匹配

在实际测试场景中，我们经常需要拦截特定模式的所有请求，而不是精确匹配某个固定 URL。HTTPretty 提供了基于正则表达式的 URL 匹配功能，这大大增强了其灵活性。

实现原理

HTTPretty 底层使用 Python 的 re 模块进行正则匹配，这意味着你可以利用正则表达式的全部功能来定义复杂的匹配规则。

典型应用场景

拦截特定域名的所有请求
匹配动态路径的 API 请求
批量处理符合某种模式的 URL

示例代码解析

import re
import requests
import httpretty

# 启用 HTTPretty
httpretty.enable()

# 使用正则表达式匹配所有以 'api.github.com' 开头的 URL
httpretty.register_uri(
    httpretty.GET,
    re.compile(r"https://api\.github\.com/.*"),
    body="[{'name': 'HTTPretty'}]"
)

# 发送请求 - 这个会被拦截
response = requests.get('https://api.github.com/users/gabrielfalcao')

# 输出结果
print(response.json())  # 输出: [{'name': 'HTTPretty'}]

在这个例子中，我们使用 re.compile 创建了一个正则表达式模式，匹配所有以 https://api.github.com/ 开头的 GET 请求。这种模式特别适合测试需要与第三方 API 交互的应用。

二、响应回调机制

HTTPretty 的响应回调功能允许你动态生成响应内容，这为创建复杂的测试场景提供了可能。

回调函数规范

一个有效的回调函数必须：

接收三个参数：
- request: 包含请求信息的 HTTPrettyRequest 对象
- uri: 请求的 URI 字符串
- headers: 包含默认响应头的字典
返回一个包含三个元素的元组：
- HTTP 状态码 (整数)
- 响应头 (字典)
- 响应体 (字符串)

内容长度注意事项

特别需要注意的是，回调函数返回的响应头中的 Content-Length 必须与响应体的实际字节长度匹配。不匹配可能导致 HTTP 客户端行为异常。

高级用法示例

from typing import Tuple
from httpretty.core import HTTPrettyRequest

def dynamic_response_callback(
        request: HTTPrettyRequest,
        uri: str,
        headers: dict
    ) -> Tuple[int, dict, str]:
    
    # 根据请求参数动态生成响应
    if 'error' in request.querystring:
        return (400, headers, '{"error": "Bad Request"}')
    
    # 修改响应头
    headers['X-Custom-Header'] = 'Processed'
    
    # 返回响应
    return (200, headers, '{"status": "success"}')

# 注册回调
httpretty.register_uri(
    httpretty.GET,
    "https://api.example.com/resource",
    body=dynamic_response_callback
)

这个示例展示了如何根据请求参数动态生成不同的响应，以及如何修改响应头信息。

三、调试技巧

使用 ipdb 进行交互式调试

在开发复杂的回调函数时，可以使用 ipdb 进行交互式调试：

import ipdb

def debug_callback(request, uri, headers):
    # 设置断点
    ipdb.set_trace()
    return (200, headers, "Debug response")

这种方法特别适合调试复杂的请求处理逻辑，可以实时查看请求对象的所有属性和方法。

四、模拟超时场景

HTTPretty 还可以用来模拟网络超时等异常情况，这对于测试应用的错误处理能力非常有用。

模拟读取超时

import time

def timeout_callback(request, uri, headers):
    # 模拟长时间处理
    time.sleep(10)  # 10秒延迟
    return (200, headers, "Too late response")

httpretty.register_uri(
    httpretty.GET,
    "https://slow.api.example.com",
    body=timeout_callback
)

这个例子展示了如何通过回调函数中的 time.sleep 来模拟服务器响应延迟，测试客户端是否能正确处理超时情况。