如何在VSCode中运行Python单元测试时设置环境变量区分运行环境

方法一：修改VSCode全局测试配置 #

VSCode的Python插件支持在.vscode/settings.json里统一设置测试运行环境变量，不管是调试还是非调试模式都会生效：

1. 打开VSCode设置（快捷键Ctrl+,），搜索Python > Testing: Env
2. 点击「编辑 in settings.json」，添加目标环境变量：

{
    "python.testing.pytestArgs": ["tests"],
    "python.testing.unittestEnabled": false,
    "python.testing.pytestEnabled": true,
    "python.testing.env": {
        "MY_ENVIRONMENT_SWITCH_FOR_WRITING_JPEGS": "1"
    }
}

注：如果用unittest，只需把unittestEnabled设为true，pytestEnabled设为false即可

配置完成后，不管你点击测试面板的「运行所有测试」，还是右键单个用例选「运行测试」，都会自动带上这个环境变量。

方法二：通过测试框架配置自动识别环境 #

如果不想修改VSCode全局设置，可以用测试框架的配置文件自动判断运行环境，比如pytest的conftest.py：
在项目根目录创建conftest.py，添加以下代码：

import os

def pytest_configure(config):
    # VSCode运行程序时会自动设置VSCODE_PID环境变量
    if os.getenv("VSCODE_PID") is not None:
        os.environ["MY_ENVIRONMENT_SWITCH_FOR_WRITING_JPEGS"] = "1"

这个方法无需手动配置VSCode，通过检测VSCode自带的环境变量自动开启开关，更灵活。

单元测试中的逻辑判断 #

不管用哪种方法，测试代码里只需要读取环境变量做分支判断即可：

import os
import cv2

def test_image_processing():
    # 你的测试逻辑
    img = ... # 处理后的图像
    # 根据环境变量决定是否保存图像
    if os.getenv("MY_ENVIRONMENT_SWITCH_FOR_WRITING_JPEGS") == "1":
        cv2.imwrite("test_output.jpg", img)
    # 断言验证逻辑
    assert ...

命令行/CI环境的自动适配 #

命令行或CI运行测试时，不会带上VSCode的专属环境变量，也不会触发上述配置中的开关逻辑，MY_ENVIRONMENT_SWITCH_FOR_WRITING_JPEGS会处于未定义状态，自然会跳过cv2.imwrite操作，完全符合需求。

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