避免 pytest hook 覆盖：快用hookwrapper 守护 session 完整性

用户12558604

发布于 2026-06-17 17:24:24

140

在 pytest 测试项目中，我遇到过这样的场景内外层同时写environment.properties，内层hook的将会被覆盖掉

project/
├── conftest.py            # 外层 hook
└── module/
    └── conftest.py        # 内层 hook

当外层定义了 pytest_sessionfinish 时，它会完全覆盖内层的同名 hook。这会导致：

1. 内层的某些逻辑被跳过
2. 测试报告生成中断

解决方案：使用hookwrapper 模式

伪代码

# module/conftest.py
import pytest

@pytest.hookimpl(hookwrapper=True)
def pytest_sessionfinish(session, exitstatus):
    # 执行外层和其他插件的 sessionfinish
    yield
    
    # 追加自定义行为（安全区域）
    # your_code

示例两个conftest都会修改到 environment.properties

# module/conftest.py
import os
import pytest
from pathlib import Path

def merge_properties(base: dict, new: dict) -> dict:
    """智能合并属性字典"""
    merged = base.copy()
    for k, v in new.items():
        # 处理数组型属性（如 tags）
        if k in merged andisinstance(merged[k], list):
            ifisinstance(v, list):
                merged[k] = merged[k] + v
            else:
                merged[k] = merged[k] + [v]
        else:
            merged[k] = v
    return merged

@pytest.hookimpl(hookwrapper=True)
def pytest_sessionfinish(session, exitstatus):
    yield # 等待其他 hook 完成
    
    report_dir = session.config.option.allure_report_dir
    if not report_dir:
        return
    
    prop_file = Path(report_dir) / "environment.properties"
    
    # 读取现有属性
    existing_props = {}
    if prop_file.exists():
        with open(prop_file, "r") as f:
            for line in f:
                if"="in line:
                    key, value = line.strip().split("=", 1)
                    existing_props[key] = value
    
    # 定义要追加/修改的属性
    new_props = {
        "MODULE_LEVEL": "inner_module",
        "EXTRA_TAGS": ["stability", "performance"],
        "CONFTEST_VERSION": os.getenv("CONFTEST_VERSION", "1.0.0")
    }
    
    # 智能合并
    merged_props = merge_properties(existing_props, new_props)
    
    # 重写文件
    withopen(prop_file, "w") as f:
        for key, value in merged_props.items():
            ifisinstance(value, list):
                # 处理数组属性
                for item in value:
                    f.write(f"{key}={item}\n")
            else:
                f.write(f"{key}={value}\n")

执行流程

简单画了个原理图

执行顺序保障：

• 外层 hook 优先执行
• 自定义逻辑最后执行

扩展:

1. 错误隔离：

try:
    yield
finally:
    # 即使外层hook崩溃也会执行
    log_cleanup_actions()

2. 上下文访问：

@pytest.hookimpl(hookwrapper=True)
def pytest_sessionfinish(session, exitstatus):
    # 获取yield前的结果
    result = yield
    
    # 检查外层hook的执行结果
    if result.excinfo:
        send_alert("外层hook执行失败")