什么是conftest.py？

conftest.py是pytest测试框架中的一个特殊文件，用于存放测试套件的共享配置和fixture（夹具）。这个文件的主要作用是：

• 定义项目中多个测试文件共享的fixture
• 配置pytest插件和钩子函数
• 设置项目级别的测试配置
• 简化测试代码的重复设置

conftest.py文件不需要显式导入，pytest会自动发现并加载该文件中的配置。

conftest.py的基本用法

1. 创建conftest.py文件

在项目的测试目录中创建一个名为conftest.py的文件。通常放置在测试文件的根目录或子目录中。

2. 定义fixture

在conftest.py中定义fixture，使其可在多个测试文件中共享：

import pytest

# 定义一个简单的fixture
@pytest.fixture
def sample_data():
    """提供测试数据"""
    return [1, 2, 3, 4, 5]

# 带作用域的fixture
@pytest.fixture(scope="module")
def db_connection():
    """模拟数据库连接"""
    print("\n建立数据库连接")
    conn = "database_connection_object"
    yield conn
    print("\n关闭数据库连接")

# 自动使用的fixture
@pytest.fixture(autouse=True)
def setup_teardown():
    """每个测试自动执行的setup/teardown"""
    print("\n测试开始")
    yield
    print("\n测试结束")

3. 在测试中使用fixture

在任何测试文件中，可以直接使用conftest.py中定义的fixture：

# test_example.py

def test_sample_data(sample_data):
    assert len(sample_data) == 5
    assert sum(sample_data) == 15

def test_db_operations(db_connection):
    assert db_connection == "database_connection_object"
    # 执行数据库操作测试...

高级用法与技巧

1. 作用域(Scope)管理

fixture可以有不同的作用域：

• function (默认): 每个测试函数执行一次
• class: 每个测试类执行一次
• module: 每个测试模块执行一次
• package: 每个测试包执行一次
• session: 整个测试会话执行一次

# 会话级别的fixture
@pytest.fixture(scope="session")
def global_setup():
    print("\n全局测试准备")
    yield
    print("\n全局测试清理")

2. 参数化fixture

使用参数化可以为fixture提供多种配置：

@pytest.fixture(params=["chrome", "firefox", "edge"])
def browser(request):
    """参数化的浏览器fixture"""
    browser_name = request.param
    print(f"\n启动 {browser_name} 浏览器")
    yield browser_name
    print(f"\n关闭 {browser_name} 浏览器")

# 测试会针对每种浏览器参数运行一次
def test_browser_compatibility(browser):
    assert browser in ["chrome", "firefox", "edge"]

3. 使用钩子函数(Hooks)

conftest.py中可以定义pytest钩子函数来自定义测试行为：

def pytest_collection_modifyitems(items):
    """在收集完所有测试用例后修改测试项"""
    for item in items:
        # 为所有测试项添加自定义标记
        item.add_marker("smoke")
        
def pytest_addoption(parser):
    """添加自定义命令行选项"""
    parser.addoption("--env", action="store", default="test", 
                     help="设置测试环境: test, staging 或 prod")

项目目录结构示例

典型的pytest项目结构：

project_root/
│
├── src/                  # 源代码目录
│   └── app.py
│
├── tests/                # 测试目录
│   ├── conftest.py       # 根级conftest - 全局配置
│   ├── test_unit/        # 单元测试目录
│   │   ├── conftest.py   # 单元测试专用配置
│   │   └── test_models.py
│   │
│   ├── test_api/         # API测试目录
│   │   ├── conftest.py   # API测试专用配置
│   │   └── test_api.py
│   │
│   └── test_ui/          # UI测试目录
│       ├── conftest.py   # UI测试专用配置
│       └── test_ui.py
│
├── pytest.ini            # pytest配置文件
└── requirements.txt      # 依赖文件

conftest.py使用最佳实践

• 将通用fixture放在项目根目录的conftest.py中
• 为特定测试类型（如API、UI）创建子目录的conftest.py
• 避免在conftest.py中编写复杂的逻辑
• 合理使用fixture作用域以提高测试性能
• 使用有意义的fixture命名，提高代码可读性
• 为fixture添加文档字符串说明其用途
• 在conftest.py中集中管理测试配置和插件

常见问题与解决方案

Q: conftest.py中的fixture无法被识别

解决方案：

• 确保conftest.py位于正确的目录层级
• 检查文件名是否正确（conftest.py）
• 确认测试文件与conftest.py在同一目录或子目录

Q: fixture作用域不符合预期

解决方案：

• 检查fixture的scope参数设置
• 避免在fixture中使用可变状态
• 使用pytest --setup-show命令查看fixture执行情况

Q: 多个conftest.py冲突

解决方案：

• pytest会合并所有conftest.py中的fixture
• 使用更具体的目录结构隔离fixture
• 为fixture添加唯一的前缀避免命名冲突

总结

conftest.py是pytest测试框架中一个非常强大的功能，它通过集中管理测试配置和共享fixture，极大地提高了测试代码的可维护性和复用性。合理使用conftest.py可以：

• 减少测试代码的重复
• 统一管理测试资源和依赖
• 提高测试执行效率
• 简化测试项目的组织结构
• 支持复杂测试场景的实现

掌握conftest.py的使用技巧，将帮助你构建更健壮、更易维护的测试套件。