注意事项

模块目录中的模块必须是标准格式,必须有__init__.py文件

示例:

./src
  |modules
    |__init__.py
    |module1
      |__init__.py
      |module1.py
    |module2.py

VSCode配置文件

全局生效配置

  1. 打开配置文件

    CTRL+SHIFT+P输入open user settings(json)按下回车.

  2. 添加配置

    setting.json中添加3项配置:

    {
        // 添加 PYTHONPATH,Python运行时会从目录中寻找模块
        "terminal.integrated.env.linux": {
            "PYTHONPATH": "${env:PYTHONPATH}:./src/modules1:./src/modules2",
        },
        // 启用VSCode代码自动补全功能
        "python.autoComplete.extraPaths": [
            "./src/modules1",
            "./src/modules2"
        ],
        "python.analysis.extraPaths": [
            "./src/modules1",
            "./src/modules2"
        ],
    }
    

有多种方式添加PYTHONPATH,也可在launch.json配置文件中指定,实现不同启动配置加载不同的模块目录

重新打开VSCode以使配置生效.

单项目生效配置

在工作区添加上述配置,移动到项目根目录:

vim .vscode/setting.json

添加:

{
    // 添加 PYTHONPATH,Python运行时会从目录中寻找模块
    "terminal.integrated.env.linux": {
        "PYTHONPATH": "${env:PYTHONPATH}:./src/modules1:./src/modules2",
    },
    // 启用VSCode代码自动补全功能
    "python.autoComplete.extraPaths": [
        "./src/modules1",
        "./src/modules2"
    ],
    "python.analysis.extraPaths": [
        "./src/modules1",
        "./src/modules2"
    ],
}

重新打开VSCode以使配置生效.

系统Python环境变量

修改~/.profileor/etc/profile文件, 添加以下行

export PYTHONPATH=<自定义绝对路径>:$PYTHONPATH

使配置生效

source ~/.profile

参考链接

  1. https://github.com/microsoft/python-language-server/blob/master/TROUBLESHOOTING.md#common-questions-and-issues

  2. https://xebia.com/blog/setting-python-source-folders-vscode/