已配置PYTHONPATH但VSCode测试资源管理器仍无法找到模块

项目结构 #

├── data-quality
│   ├── __pycache__
|   ├── helpers.py
│   └── tests
│       └── __pycache__
|       └── test_helpers.py
├── include
└── share

问题现状 #

已解决CLI下的测试运行问题，但VSCode测试资源管理器无法正常识别helpers.py模块，当前VSCode的settings.json配置如下：

{
    ...
    "python.testing.pytestEnabled": false,
    "python.testing.unittestEnabled": true,
    "python.testing.cwd": "./data-quality/tests"
}

测试发现时的错误日志：

> /usr/local/bin/python3 ~/.vscode/extensions/ms-python.python-2022.20.1/pythonFiles/testing_tools/unittest_discovery.py . *test*.py
cwd: ./data-quality/tests
[ERROR 2022-11-28 11:31:16.278]: Error discovering unittest tests:
 Failed to import test module: test_helpers
Traceback (most recent call last):
  File "/usr/local/Cellar/python@3.10/3.10.8/Frameworks/Python.framework/Versions/3.10/lib/python3.10/unittest/loader.py", line 436, in _find_test_path
    module = self._get_module_from_name(name)
  File "/usr/local/Cellar/python@3.10/3.10.8/Frameworks/Python.framework/Versions/3.10/lib/python3.10/unittest/loader.py", line 377, in _get_module_from_name
    __import__(name)
  File "/Users/b242pn/Documents/SOC/data-quality/data-quality/tests/test_helpers.py", line 1, in <module>
    from helpers import group_columns_by_vendor_product
ModuleNotFoundError: No module named 'helpers'

解决方法 #

方法1：调整测试工作目录 #

将python.testing.cwd改为./data-quality（即helpers.py所在的目录），让Python在测试发现时直接识别到同级的helpers模块。修改后的配置：

{
    ...
    "python.testing.pytestEnabled": false,
    "python.testing.unittestEnabled": true,
    "python.testing.cwd": "./data-quality"
}

方法2：动态添加模块路径到测试文件 #

在test_helpers.py开头添加代码，动态将上级目录加入Python路径，确保VSCode测试发现时能定位到helpers.py：

import sys
from pathlib import Path

# 获取当前测试文件的上级目录（即data-quality目录）并添加到路径
sys.path.append(str(Path(__file__).parent.parent))

from helpers import group_columns_by_vendor_product

方法3：配置项目级PYTHONPATH #

1. 在项目根目录（data-quality的上级目录）创建.env文件，添加以下内容：

PYTHONPATH=${PYTHONPATH}:./data-quality

2. 在VSCode的settings.json中指定读取该环境文件：

{
    ...
    "python.envFile": "${workspaceFolder}/.env"
}

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