讲师中心 微信公众号

工具推荐

视频效率加速
SoundView
SoundView

字幕擦除翻译、配音口型同步

剧云
剧云

中文短剧剧本制作平台

Laper
Laper

剧本策划到成片协作

AniShort
AniShort

AI短剧协同制作平台

Starlette如何使用测试客户端TestClient

胖宇同学_8724

胖宇同学_8724

发布时间:2026-11-18 12:06:42

|

761人浏览过

|

来源于php中文网

原创

starlette 的 testclient 是专门用于测试 asgi 应用的轻量级客户端,它通过直接调用应用实例来模拟 http 请求,从而避免启动本地服务器。要使用它,只需将你的 asgi 应用实例传入 testclient 构造函数,然后像操作 requests 库一样发起 get、post 等请求并检查响应状态码和 json 数据。

Starlette如何使用测试客户端TestClient

如何初始化 TestClient 并发送基本请求

初始化 TestClient 时,必须传入一个实现了 ASGI 接口的应用对象,通常是 Starlette 的 Application 或 Router 实例。发送请求时,你可以指定路径、查询参数、JSON 负载以及自定义头部信息,客户端会返回一个包含 status_code、headers 和 json() 方法的响应对象。

Starlette如何使用测试客户端TestClient

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.testclient import TestClient
from starlette.routing import Route

async def homepage(request):
    return JSONResponse({"message": "Hello World"})

routes = [Route("/", homepage)]
app = Starlette(routes=routes)

# 创建测试客户端
client = TestClient(app)

# 发送 GET 请求
response = client.get("/")
print(response.status_code)  # 输出: 200
print(response.json())       # 输出: {'message': 'Hello World'}

上述代码展示了最基础的用法。首先定义了一个简单的路由函数,然后将其注册到 Starlette 应用中。接着,TestClient(app) 建立了连接。调用 client.get("/") 后,我们直接访问了响应的属性。这种直接调用方式比使用 httpx 连接本地端口要快得多,因为它省去了网络 I/O 开销。

Starlette 1.5.1
Starlette 1.5.1

Starlette 1.5.1 是轻量级 Python ASGI 框架与工具集,提供路由、请求响应、中间件、WebSocket 和后台任务等组件,适合构建异步 Web 服务。本下载为官方 PyPI 通用 wheel 包,可使用 pip 安装,并由包管理器处理依赖;运行应用时还需配置 ASGI 服务器。

下载

如何处理 POST 请求与表单数据

在处理需要提交数据的接口时,TestClient 支持通过 data 参数发送表单编码数据,或通过 json 参数发送 JSON 负载。对于 POST 请求,你需要确保应用端能正确解析这些输入,通常 Starlette 会自动处理 JSON 解析,而表单数据则需要通过 request.form() 获取。

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.testclient import TestClient
from starlette.routing import Route
import json

async def create_user(request):
    if request.method == "POST":
        # 尝试解析 JSON
        try:
            body = await request.json()
            name = body.get("name")
        except Exception:
            # 如果失败,尝试解析表单
            form = await request.form()
            name = form.get("name")
        
        return JSONResponse({"created": True, "user": name})
    return JSONResponse({"error": "Method Not Allowed"}, status_code=405)

routes = [Route("/users", create_user, methods=["GET", "POST"])]
app = Starlette(routes=routes)
client = TestClient(app)

# 发送 JSON POST 请求
resp_json = client.post("/users", json={"name": "Alice"})
print(resp_json.json())  # {'created': True, 'user': 'Alice'}

# 发送表单 POST 请求
resp_form = client.post("/users", data={"name": "Bob"})
print(resp_form.json())  # {'created': True, 'user': 'Bob'}

在这个例子中,create_user 函数同时兼容 JSON 和表单输入。client.post 方法接收 json 字典时会自动设置 Content-Type: application/json 头,而接收 data 字典时则默认为 application/x-www-form-urlencoded。测试时,我们可以分别验证这两种情况,确保后端逻辑的健壮性。注意,TestClient 会自动处理异步循环,因此无需在测试代码中手动管理事件循环。

当请求路径不存在时 TestClient 返回什么

当向未注册的路径发送请求时,Starlette 会触发 404 错误。此时 TestClient 不会抛出异常,而是返回一个状态码为 404 的响应对象。开发者可以通过检查 response.status_code 是否为 404 来验证路由缺失的情况,或者捕获 RuntimeError(如果在调试模式下且配置了特定的错误处理)。通常情况下,标准的 404 响应是预期的行为。

from starlette.applications import Starlette
from starlette.responses import JSONResponse
from starlette.testclient import TestClient
from starlette.routing import Route

async def health_check(request):
    return JSONResponse({"status": "ok"})

routes = [Route("/health", health_check)]
app = Starlette(routes=routes)
client = TestClient(app)

# 访问不存在的端点
response = client.get("/nonexistent")
print(response.status_code)  # 输出: 404
print(response.text)         # 输出: <!DOCTYPE html>... (默认 HTML 错误页)

# 如果启用了 debug 模式,可能会看到更详细的 traceback
# 但在生产配置或标准测试中,通常只关心 404 状态码

在上述代码中,我们只注册了 /health 路由。当请求 /nonexistent 时,Starlette 的路由器无法匹配任何路径,因此返回默认的 404 响应。TestClient 忠实地反映了这一结果。在实际测试中,我们通常会断言 assert response.status_code == 404 来确保非法路径被正确拒绝。如果应用配置了自定义的错误页面,response.text 的内容也会相应改变,但状态码始终保持一致。

热门AI工具

更多
创客贴AI

创客贴AI是一款AI图像与设计工具,AI辅助的智能在线设计工具。

WorkBuddy

一款AI办公效率工具,主要用于腾讯云推出的AI原生桌面智能体工作台,适合需要提升相关任务效率的用户。

SkildArt
SkildArt Hot

SkildArt是一款AI文本写作工具,一站式 AI 视觉创作平台。

Flowith
Flowith Hot

Flowith是一款基于画布和智能体工作流的 AI 协作工作空间。

豆包大模型

豆包大模型是一款由字节跳动推出的企业级大语言模型服务平台。

蛙蛙写作

一款AI论文写作工具,主要用于超级AI智能写作助手,适合需要提升相关任务效率的用户。

笔灵降AI

一款AI论文写作工具,主要用于论文降AI神器,适配知网及维普!一键降至安全线,100%保留原文格式;无口语化问题,文风更学术,降后字数控制最佳!,适合需要提升相关任务效率的用户。

DeepSeek

DeepSeek是一款面向对话、写作、编程和推理场景的AI大模型工具。

码上飞
码上飞 Hot

一款基于自然语言的AI应用开发平台,可根据用户描述自动生成应用程序,帮助个人和团队快速完成应用原型与开发。

相关专题

更多
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API
Python FastAPI异步API开发_Python怎么用FastAPI构建异步API

Python FastAPI 异步开发利用 async/await 关键字,通过定义异步视图函数、使用异步数据库库 (如 databases)、异步 HTTP 客户端 (如 httpx),并结合后台任务队列(如 Celery)和异步依赖项,实现高效的 I/O 密集型 API,显著提升吞吐量和响应速度,尤其适用于处理数据库查询、网络请求等耗时操作,无需阻塞主线程。

119

2025.12.22

Python 微服务架构与 FastAPI 框架
Python 微服务架构与 FastAPI 框架

本专题系统讲解 Python 微服务架构设计与 FastAPI 框架应用,涵盖 FastAPI 的快速开发、路由与依赖注入、数据模型验证、API 文档自动生成、OAuth2 与 JWT 身份验证、异步支持、部署与扩展等。通过实际案例,帮助学习者掌握 使用 FastAPI 构建高效、可扩展的微服务应用,提高服务响应速度与系统可维护性。

594

2026.02.06

Python Web框架FastAPI 全栈开发教程合集
Python Web框架FastAPI 全栈开发教程合集

以 FastAPI 为核心,讲解现代 Python Web API 的高效开发方式,涵盖路由定义与路径参数/查询参数/请求体绑定、Pydantic 模型的数据校验与序列化、依赖注入(Depends)系统的分层设计、中间件与 CORS 配置、OAuth2 + JWT 认证流程、后台任务(BackgroundTasks)、WebSocket 实时通信、SQLAlchemy 异步 ORM 集成、自动生成 OpenAPI/Swagger 交互文

796

2026.05.09

Python FastAPI异步微服务与高性能接口设计
Python FastAPI异步微服务与高性能接口设计

本专题聚焦 Python FastAPI 框架在高性能接口与微服务开发中的应用,讲解异步请求处理、依赖注入机制、路由设计、数据库异步操作以及接口性能优化策略。结合实际项目案例,帮助开发者构建高并发、低延迟的现代化后端服务架构。

679

2026.06.16

GoFrame框架Web开发与路由中间件
GoFrame框架Web开发与路由中间件

本专题聚焦GoFrame框架的Web开发,拆解路由注册与匹配规则、请求参数获取、参数校验与中间件执行顺序,说明统一响应、JWT鉴权、文件上传与接口文档生成的落地方式,并补充优雅重启与测试实践。

0

2026.11.17

GoFrame框架安装与gf命令行工具
GoFrame框架安装与gf命令行工具

本专题围绕GoFrame框架的安装与工具链配置展开,讲清Go版本要求、gf命令行的安装方式、代理镜像与依赖准备,说明项目初始化、热编译、交叉编译打包的做法,并整理安装阶段的常见报错与验证步骤。

0

2026.11.17

GoFrame框架零基础入门
GoFrame框架零基础入门

本专题整理GoFrame框架的入门知识,从模块化设计理念、环境准备到跑通第一个Web服务,讲清目录分层、配置加载、日志与中间件的用法,并对比Gin、Go-Zero的差异,帮助Go开发者建立整体认知。

0

2026.11.17

SQLAlchemy 一对多关系怎么建立
SQLAlchemy 一对多关系怎么建立

SQLAlchemy 一对多关系怎么建立?本专题整理父子表外键、relationship 双向映射、关联查询、级联删除和加载优化等相关文章,帮助你理解并实现常见的 ORM 关系建模。

0

2026.11.17

SQLAlchemy 如何增删改查
SQLAlchemy 如何增删改查

SQLAlchemy 如何增删改查?本专题整理 ORM 新增记录、条件查询、更新和删除、Session 事务提交与批量处理等实用文章,帮助你掌握 Python 数据库操作流程。

0

2026.11.17

热门下载

更多
网站特效
/
网站源码
/
网站素材
/
前端模板

精品课程

更多
相关推荐
/
热门推荐
/
最新课程
关于我们 免责申明 举报中心 意见反馈 讲师合作 广告合作 最新更新
php中文网:公益在线php培训,帮助PHP学习者快速成长!
关注服务号
PHP中文网订阅号
每天精选资源文章推送

Copyright 2014-2026 https://www.php.cn/ All Rights Reserved | php.cn