pytest中capsys捕获print输出需在测试函数签名显式声明为参数,其作用域限于当前函数,调用readouterr()会清空缓冲区且仅捕获Python进程内标准输出。

pytest里用capsys捕获print()输出,必须在测试函数签名里显式声明参数
很多人写完测试发现capsys没生效,根本原因是忘了把它当参数传进去——它不是全局变量,也不是自动注入的。pytest只对测试函数签名中明确列出的fixture名做依赖注入。
-
capsys是函数作用域fixture,仅在当前测试函数内有效 - 参数名必须严格写成
capsys,不能是cap_sys或capsys_fixture - 如果用了
self(比如在unittest.TestCase子类里),capsys得放在self之后
错误写法:
def test_something(): # 没写 capsys 参数 → 捕获不到
print("hello")
# ...正确写法:def test_something(capsys):
print("hello")
captured = capsys.readouterr()
assert "hello" in captured.out
capsys.readouterr()返回命名元组,.out和.err要分清
调用readouterr()会把当前缓冲区内容“取走”,并清空缓冲区。多次调用时,第二次会拿到空字符串——这点容易被忽略,导致断言失败。
-
captured.out对应print()、sys.stdout.write()等标准输出 -
captured.err对应print(..., file=sys.stderr)、logging.error()等标准错误 - 每次调用
readouterr()都会清空缓冲区,不能靠它“多次读取同一段输出”
常见误用:
def test_twice(capsys):
print("first")
print("second")
assert "first" in capsys.readouterr().out # ✅ 拿到 "first\nsecond\n"
assert "second" in capsys.readouterr().out # ❌ 拿到 "",缓冲区已空
想测中间过程输出?得在print()后立刻调用readouterr()
如果你的函数里有多次print(),又想分别验证每一条,不能等到函数结束再捕获——因为所有输出都混在一起了。必须控制捕获时机。
让 macOS 自动化像说话一样简单 —— 用代码控制你的 Mac,无需学习 AppleScript 系统要求 macOS 14+ (Sonoma) Python 3.9+ 需要开启:辅助功能 + 屏幕录制权限
- 适合场景:调试函数内部逻辑、验证日志顺序、检查进度提示是否按预期打印
- 注意
print()默认带换行,captured.out里会包含\n,断言时别漏掉 - 如果函数用了
end=''或flush=True,行为不变,capsys仍能捕获,但要注意换行符缺失影响匹配
示例:
def noisy_func():
print("step 1", end='')
print(" done")
print("step 2")
<p>def test_step_by_step(capsys):
noisy_func()
captured = capsys.readouterr()
assert captured.out == "step 1 done\nstep 2\n"
不支持捕获子进程或C扩展打印的内容
capsys只接管当前Python进程的sys.stdout和sys.stderr对象。一旦输出来自外部命令(比如os.system("echo hi"))或C写的底层IO(如某些NumPy警告、OpenCV日志),就完全捕获不到。
立即学习“Python免费学习笔记(深入)”;
- 子进程输出:得用
subprocess.run(..., capture_output=True)单独处理 - C扩展/系统级日志:可能需要重定向文件描述符(
os.dup2),或改用capfd(它捕获更低层的fd 1/2,但仍有局限) -
capfd比capsys更底层,能捕获部分绕过Python IO层的输出,但不可移植,Windows上行为不稳定
典型踩坑:
def test_with_subprocess(capsys):
os.system("echo hello from shell") # 这行不会出现在 capsys.out 里
assert "hello" in capsys.readouterr().out # ❌ 总是失败
捕获stdout这事看着简单,但时机、作用域、边界(子进程/C层)三处最容易出问题。尤其当输出来自别人写的库时,先确认它走的是Python的print还是直接写了fd,比硬试capsys更省时间。


















