如何在Pytest中高效管理大量测试变量？

我的程序会处理大量对象，程序对这些对象执行的操作取决于对象类型及其配置，该配置可通过配置文件自定义。

编写测试时，我需要为配置文件解析模块编写测试用例：将配置的每个参数名/值对都创建为一个变量，然后在测试的前置步骤（setup）中将这些变量及其值写入配置文件。我这样做的原因是，在验证解析器输出时需要明确知晓配置文件的具体内容；此外，解析器需要适配多种格式（如分隔符、表示空元素的值等）。

示例YAML配置文件 #

all:
  all_setting1: "all_setting1_value"
  all_setting2: "all_setting2_value"

customer:
  all:
    all_customers_setting1: "all_customers_setting1_value"
    all_customers_setting2: "all_customers_setting2_value"
  customer1:
    customer1_setting1: "customer1_setting1_value"
    customer1_setting2: "customer1_setting2_value"

  customer2:
    customer2_setting1: "customer2_setting1_value"
    customer2_setting2: "customer2_setting2_value"  

type:
  all:
    all_types_setting1: "all_types_setting1_value"
    all_types_setting2: "all_types_setting2_value"
  type1:
    type1_setting1: "type1_setting1_value"
    type1_setting2: "type1_setting2_value"
  type2:
    type2_setting1: "type2_setting1_value"
    type2_setting2: "type2_setting2_value"

scope:
  all:
    all_scopes_setting1: "all_scopes_setting1_value"
    all_scopes_setting2: "all_scopes_setting2_value"
  scope1:
    scope1_setting1: "scope1_setting1_value"
    scope1_setting2: "scope1_setting2_value"
  scope2:
    scope2_setting1: "scope2_setting1_value"
    scope2_setting2: "scope2_setting2_value"

原测试前置代码 #

pytest.attribute_all_setting1_name = "all_setting1"
pytest.attribute_all_setting1_value = "all_setting1_value"
pytest.attribute_all_setting2_name = "all_setting2"
pytest.attribute_all_setting2_value = "all_setting2_value"

pytest.attribute1_name = "customer"
pytest.attribute1_all_name = "all"
pytest.attribute1_all_setting1_name = "all_customers_setting1"
pytest.attribute1_all_setting1_value = "all_customers_setting1_value"
...
# 省略剩余变量定义
...
pytest.attribute3_name = "scope"
pytest.attribute3_all_name = "all"
...

现在随机运行所有测试时出现失败，推测是所有测试共用同一全局pytest变量导致的，求更优实现方式。

1. 使用pytest的fixture（推荐） #

把配置数据封装成fixture，通过作用域控制隔离程度，默认function级别的fixture会在每个测试函数前重新初始化，完全避免全局变量污染。

实现示例 #

import pytest
import yaml
import tempfile
import os

@pytest.fixture(scope="function")
def test_config():
    # 定义完整的配置数据结构
    config_data = {
        "all": {
            "all_setting1": "all_setting1_value",
            "all_setting2": "all_setting2_value"
        },
        "customer": {
            "all": {
                "all_customers_setting1": "all_customers_setting1_value",
                "all_customers_setting2": "all_customers_setting2_value"
            },
            "customer1": {
                "customer1_setting1": "customer1_setting1_value",
                "customer1_setting2": "customer1_setting2_value"
            },
            "customer2": {
                "customer2_setting1": "customer2_setting1_value",
                "customer2_setting2": "customer2_setting2_value"
            }
        },
        "type": {
            "all": {
                "all_types_setting1": "all_types_setting1_value",
                "all_types_setting2": "all_types_setting2_value"
            },
            "type1": {
                "type1_setting1": "type1_setting1_value",
                "type1_setting2": "type1_setting2_value"
            },
            "type2": {
                "type2_setting1": "type2_setting1_value",
                "type2_setting2": "type2_setting2_value"
            }
        },
        "scope": {
            "all": {
                "all_scopes_setting1": "all_scopes_setting1_value",
                "all_scopes_setting2": "all_scopes_setting2_value"
            },
            "scope1": {
                "scope1_setting1": "scope1_setting1_value",
                "scope1_setting2": "scope1_setting2_value"
            },
            "scope2": {
                "scope2_setting1": "scope2_setting1_value",
                "scope2_setting2": "scope2_setting2_value"
            }
        }
    }
    # 创建临时配置文件
    with tempfile.NamedTemporaryFile(mode='w', suffix='.yaml', delete=False) as f:
        yaml.dump(config_data, f)
    # 返回配置文件路径和原始数据，方便测试中验证
    yield f.name, config_data
    # 测试结束后清理临时文件
    os.unlink(f.name)

使用方式 #

在测试函数中直接注入fixture：

def test_config_parser(test_config):
    config_path, expected_data = test_config
    # 调用解析器读取配置文件
    parsed_data = your_config_parser.parse(config_path)
    # 验证解析结果与预期一致
    assert parsed_data == expected_data

如果需要修改部分配置参数测试边界情况，可以在fixture基础上派生：

@pytest.fixture(scope="function")
def test_config_with_empty_value(test_config):
    config_path, base_data = test_config
    # 修改部分配置值
    base_data["customer"]["customer1"]["customer1_setting1"] = ""
    # 重新写入临时文件
    with open(config_path, 'w') as f:
        yaml.dump(base_data, f)
    yield config_path, base_data

2. 使用测试类和实例变量 #

如果习惯用类组织测试，可以把配置变量定义为测试类的实例变量，每个测试类实例会独立初始化，避免全局共享。

实现示例 #

import unittest
import yaml
import tempfile
import os

class TestConfigParser(unittest.TestCase):
    def setUp(self):
        # 初始化配置数据
        self.config_data = {
            "all": {
                "all_setting1": "all_setting1_value",
                "all_setting2": "all_setting2_value"
            },
            # 补充其他配置项
            "customer": {
                "all": {
                    "all_customers_setting1": "all_customers_setting1_value",
                    "all_customers_setting2": "all_customers_setting2_value"
                },
                "customer1": {
                    "customer1_setting1": "customer1_setting1_value",
                    "customer1_setting2": "customer1_setting2_value"
                }
            }
        }
        # 创建临时文件
        self.temp_file = tempfile.NamedTemporaryFile(mode='w', suffix='.yaml', delete=False)
        yaml.dump(self.config_data, self.temp_file)
        self.temp_file.close()

    def tearDown(self):
        # 清理临时文件
        os.unlink(self.temp_file.name)

    def test_full_config_parsing(self):
        parsed_data = your_config_parser.parse(self.temp_file.name)
        self.assertEqual(parsed_data, self.config_data)

    def test_empty_value_parsing(self):
        # 修改当前实例的配置数据
        self.config_data["customer"]["customer1"]["customer1_setting1"] = ""
        with open(self.temp_file.name, 'w') as f:
            yaml.dump(self.config_data, f)
        parsed_data = your_config_parser.parse(self.temp_file.name)
        self.assertEqual(parsed_data["customer"]["customer1"]["customer1_setting1"], "")

3. 封装配置数据为模块级常量+动态生成文件 #

如果配置基础数据固定，只是需要动态生成文件，可以把基础配置定义为模块级的字典常量，每个测试函数中独立生成临时文件，避免共享状态。

实现示例 #

import pytest
import yaml
import tempfile
import os

# 模块级常量，只定义一次
BASE_CONFIG = {
    "all": {
        "all_setting1": "all_setting1_value",
        "all_setting2": "all_setting2_value"
    },
    "customer": {
        "all": {
            "all_customers_setting1": "all_customers_setting1_value",
            "all_customers_setting2": "all_customers_setting2_value"
        },
        "customer1": {
            "customer1_setting1": "customer1_setting1_value",
            "customer1_setting2": "customer1_setting2_value"
        }
    }
}

def test_normal_parsing():
    # 复制基础配置，避免修改原常量
    config_data = BASE_CONFIG.copy()
    with tempfile.NamedTemporaryFile(mode='w', suffix='.yaml', delete=False) as f:
        yaml.dump(config_data, f)
    try:
        parsed_data = your_config_parser.parse(f.name)
        assert parsed_data == config_data
    finally:
        os.unlink(f.name)

def test_special_delimiter_parsing():
    # 创建带特殊格式的配置数据
    config_data = {
        "all": {
            "all_setting1": "value_with|delimiter"
        },
        "customer": BASE_CONFIG["customer"]
    }
    with tempfile.NamedTemporaryFile(mode='w', suffix='.yaml', delete=False) as f:
        yaml.dump(config_data, f)
    try:
        parsed_data = your_config_parser.parse(f.name)
        assert parsed_data["all"]["all_setting1"] == "value_with|delimiter"
    finally:
        os.unlink(f.name)

内容的提问来源于stack exchange，提问作者Thomas Vanhelden