pytest-benchmark 使用指南：Python 性能测试利器

最新推荐文章于 2025-07-03 15:55:51 发布

邓炜赛Song-Thrush

最新推荐文章于 2025-07-03 15:55:51 发布

阅读量271

点赞数 4

CC 4.0 BY-SA版权

本文链接：https://blog.csdn.net/gitblog_00689/article/details/149015609

pytest-benchmark 使用指南：Python 性能测试利器

项目简介

pytest-benchmark 是一个强大的 Python 性能测试工具，它作为 pytest 插件提供了一套完整的基准测试解决方案。通过简单的 API 设计，开发者可以轻松地对代码片段进行性能测试，并获得详细的统计数据和可视化报告。

核心功能

基础用法

pytest-benchmark 的核心是 benchmark 夹具（fixture），它是一个可调用对象，可以测量任何传递给它的函数的执行时间。

def test_function_performance(benchmark):
    result = benchmark(time.sleep, 0.000001)
    assert result is None

这种直接调用的方式能获得最准确的测量结果，避免了不必要的函数调用开销。

参数传递

支持位置参数和关键字参数：

# 位置参数
def test_positional_args(benchmark):
    benchmark(time.sleep, 0.02)

# 关键字参数
def test_keyword_args(benchmark):
    benchmark(time.sleep, duration=0.02)

精确控制模式

对于需要精细控制测试过程的高级场景，可以使用 pedantic 模式：

def setup_function():
    # 初始化代码
    pass

def test_with_setup(benchmark):
    benchmark.pedantic(
        time.sleep,
        setup=setup_function,
        args=(0.000001,),
        iterations=10,
        rounds=100
    )

命令行选项详解

pytest-benchmark 提供了丰富的命令行选项来控制测试行为：

测试时长选项

--benchmark-min-time: 每轮测试的最小时间（秒）
--benchmark-max-time: 每个测试的最大总运行时间
--benchmark-min-rounds: 最小测试轮数

测试环境控制

--benchmark-disable-gc: 测试期间禁用垃圾回收
--benchmark-warmup: 启用预热阶段（特别适用于 PyPy）
--benchmark-timer: 指定计时器（默认使用 time.perf_counter）

结果输出控制

--benchmark-save: 保存测试结果到文件
--benchmark-json: 生成 JSON 格式报告
--benchmark-histogram: 生成性能变化直方图
--benchmark-compare: 与历史测试结果比较

性能分析

--benchmark-cprofile: 启用 cProfile 分析
--benchmark-cprofile-top: 显示 top N 的性能分析结果

标记(Marker)使用

可以通过 pytest 的 marker 为单个测试设置特定参数：

@pytest.mark.benchmark(
    group="string-operations",
    min_time=0.1,
    max_time=0.5,
    min_rounds=5,
    disable_gc=True,
    warmup=True
)
def test_string_operations(benchmark):
    benchmark("   hello   ".strip)

高级功能

附加信息

可以在测试中添加额外信息，这些信息会保存在结果中：

def test_with_metadata(benchmark):
    benchmark.extra_info['environment'] = 'production'
    benchmark.extra_info['version'] = '1.2.3'
    benchmark(time.sleep, 0.01)

方法织入(Weaving)

对于需要测试类内部方法的情况，可以使用 benchmark_weave 夹具：

def test_internal_method(benchmark_weave):
    benchmark_weave.weave(SomeClass.internal_method, lazy=True)
    obj = SomeClass()
    obj.run()  # 内部会调用被测量的 internal_method