vscode导入自定义模块报错ModuleNotFoundError解决方案

问题描述

我的项目为great_gas_or_agents，目录结构如下：

• log_data_extract
  • main.py
• math_algorithm

现在我运行main.py，报错：from math_algorithm.utils import parse_month_match_request，ModuleNotFoundError: No module named ‘math_algorithm’。

我打印os.getcwd()，输出为C:\Users\pengkangzhen\PycharmProjects\wk-projects\great_gas_or_agents\log_data_extract

原因

假设项目目录结构如下：

project/
│
├── main.py
├── data/
│   └── datafile.txt
└── scripts/
    └── script.py

当前工作目录是project/，那么在main.py中读取datafile.txt，使用相对路径就是data/datafile.txt
在terminal中，可以运行python ./main.py。

假设项目目录结构如下：

project/
│
├── script.py
├── data/
│   └── datafile.txt
└── scripts/
    └── main.py

在main.py中打印os.getcwd()，执行main.py，显示os.getcwd()为当前project，在main.py中读取datafile.txti相对路径是 ./data/datafile.txt而不是../data/datafile.txt。因为相对目录是os.getcwd()为起点，而不是当前.py脚本的位置为起点。
main.py如下：

with open("./data/datafile.txt", 'r', encoding="utf-8") as f:
    data = f.read()
print(data)

若此时在terminal执行python ./scripts/main.py，输出datafile.txt中的内容。
若在main.py中我还引入其他模块（script.py中的do_sth方法）：

import script
with open("./data/datafile.txt", 'r', encoding="utf-8") as f:
    data = f.read()
print(data)
script.do_sth()

此时在terminal中执行python .\scripts\main.py则报错ModuleNotFoundError: No module named ‘script’，找不到自定义模块。这是因为Python 解释器的当前工作目录是 project/，但它不会自动将 project/ 添加到 sys.path 中。所以解决方案如下。

解决方法

方法一：使用相对导入

确保 project/ 目录包含一个 init.py 文件（即使是空文件），以使其成为一个包：

project/
│
├── __init__.py
├── script.py
├── data/
│   └── datafile.txt
└── scripts/
    ├── __init__.py
    └── main.py

运行时需要使用 -m 选项从项目根目录运行（在terminal）：

python -m scripts.main

方法二：修改 sys.path

在 scripts/main.py 中手动修改 sys.path，将项目根目录添加到 sys.path 中：

import os
import sys
# 获取项目根目录
project_root = os.path.abspath(os.path.join(os.path.dirname(__file__), '..'))
# 将项目根目录添加到 sys.path
sys.path.append(project_root)


import script

with open("./data/datafile.txt", 'r', encoding="utf-8") as f:
    data = f.read()
print(data)
script.do_sth()

这样在运行 python .\scripts\main.py 即可。

方法三：使用环境变量

1. 在vscode通过快捷键 Ctrl + （反引号）打开终端，或者通过菜单 View > Terminal 打开。
2. 设置 PYTHONPATH 环境变量：$env:PYTHONPATH="C:\Users\PycharmProjects\projects"针对我的问题就是：$env:PYTHONPATH="C:\Users\pengkangzhen\PycharmProjects\wk-projects\great_gas_or_agents"
3. 运行main.py，大功告成

配置launch.json

此时可以运行代码，但debug不行，需要配置launch.json：

{
    // Use IntelliSense to learn about possible attributes.
    // Hover to view descriptions of existing attributes.
    // For more information, visit: https://go.microsoft.com/fwlink/?linkid=830387
    "version": "0.2.0",
    "configurations": [
        {
            "name": "Python Debugger: Current File",
            "type": "debugpy",
            "request": "launch",
            "program": "${file}",
            "console": "integratedTerminal"
        }
    ]
}