如何将环境变量传递给pytest

基础概念

环境变量（Environment Variables）是在操作系统中存储的键值对，可以被应用程序访问。它们通常用于配置应用程序的行为，而不需要修改代码。pytest 是一个流行的 Python 测试框架，可以通过环境变量来配置其行为。

传递环境变量的方法

1. 在命令行中设置环境变量

你可以在运行 pytest 命令之前，在命令行中设置环境变量。例如：

export MY_VARIABLE=my_value
pytest

或者在 Windows 命令提示符中：

set MY_VARIABLE=my_value
pytest

2. 在 pytest.ini 文件中设置环境变量

你可以在项目的根目录下创建或编辑 pytest.ini 文件，并使用 [pytest] 部分来设置环境变量。例如：

[pytest]
env =
    MY_VARIABLE=my_value

3. 使用 conftest.py 文件设置环境变量

你可以在项目中的 conftest.py 文件中使用 pytest_configure 钩子来设置环境变量。例如：

def pytest_configure():
    import os
    os.environ['MY_VARIABLE'] = 'my_value'

应用场景

环境变量在以下场景中非常有用：

• 配置管理：通过环境变量来管理不同环境的配置，如开发、测试和生产环境。
• 敏感信息：避免将敏感信息（如数据库密码）硬编码在代码中，而是通过环境变量传递。
• 多租户系统：在不同的租户之间共享代码，但每个租户有不同的配置。

示例代码

假设你有一个简单的 Python 脚本 test_example.py，它依赖于一个环境变量 MY_VARIABLE：

# test_example.py
import os

def test_environment_variable():
    assert os.getenv('MY_VARIABLE') == 'my_value'

你可以通过以下方式运行这个测试：

export MY_VARIABLE=my_value
pytest test_example.py

或者在 pytest.ini 中设置：

[pytest]
env =
    MY_VARIABLE=my_value

然后在项目根目录下运行：

pytest

参考链接

• pytest 官方文档 - 环境变量
• Python 官方文档 - os 模块

通过以上方法，你可以轻松地将环境变量传递给 pytest，并根据需要进行配置和管理。