VS Code pylint（import-error）“无法导入”自定义目录中的子模块

Question

我将我自己编写的 Python 脚本组织在一个包含多个子目录的树中， 从已经包含在 settings-json 中的"python.autoComplete.extraPaths" 中的父目录“Scripts”开始：

"python.autoComplete.extraPaths": ["/home/andylu/Dokumente/Allgemeines_material/Sonstiges/Programming/Python/Scripts",
                                       "/home/andylu/anaconda3/lib/python3.7/site-packages"]

除此之外，我还包含了一个 Python 环境文件：

"python.envFile": "/home/andylu/Dokumente/Allgemeines_material/Sonstiges/Programming/Visual_studio_code/vscode_own_scripts.env"

其中包含该行

export PYTHONPATH=/home/andylu/Dokumente/Allgemeines_material/Sonstiges/Programming/Python/Scripts:/home/andylu/anaconda3/lib/python3.7/site-packages

所有这些在之前都做得很好，我的所有脚本都分布在超过 1 个单一目录级别，如下所示：

+---Scripts
|   +---General
|   |   +---script_one.py
|   |   +---script_two.py

当我在任何 python 脚本中导入时，例如script_one.py, 我用

开始了脚本

import sys
sys.path.append(
    "/home/andylu/Dokumente/Allgemeines_material/Sonstiges/Programming/Python/Scripts/"
)

import General.script_one as one

并且 pylint 正确地识别了这个导入的脚本没有抛出前面提到的VS Code pylint(import-error)。

---

现在情况不同了。脚本变得如此之多，我将子文件夹General 拆分为包含一个额外的子目录级别让脚本更清晰地组织：

+---Scripts
|   +---General
|   |   +---Plotting
|   |   |   +---script_one.py
|   |   |   +---script_two.py
|   |   +---Misc
|   |   |   +---script_three.py
|   |   |   +---script_four.py
....

当使用例如启动 Python 脚本时以下几行，我得到以下每个导入的VS Code pylint(import-error)。

# Package importing

import sys
sys.path.append(
    "/home/andylu/Dokumente/Allgemeines_material/Sonstiges/Programming/Python/Scripts/"
)

import General.Plotting.auxiliary_plotting_functions as aux_plot
import General.Plotting.plotting as plot

#%%
# TIME MEASUREMENT for the entire code/function
import General.Misc.timing

我不知道为什么 pylint 突然停止识别导入，只是因为我添加了一个额外的子目录级别。我希望这些无意义的 pylint 导入错误消失，因为在执行代码时有效地正确导入了子子模型。

我什至尝试修改.pylintrc - 文件，它位于 /home/andylu/anaconda3/pkgs/pylint-2.3.1-py37_0/lib/python3.7/site-packages/pylint/test/regrtest_data/.pylintrc：

[MASTER]

optimize-ast=no

init-hook='import sys; sys.path.append("/home/andylu/Dokumente/Allgemeines_material/Sonstiges/Programming/Python/Scripts")'

添加init-hook - 行也没有效果。

Answer 1

另一个答案（受@andreas-l 启发）：

在我受影响的项目的 .pylintrc 中（问题是如何以及何时开始的，我不知道0），我找到了以下“消息控制”部分并在其中添加了“导入错误”：

[MESSAGES CONTROL]

  disable=
    missing-docstring
    import-error

重新启动 VSCode 并没有更多错误消息。

Answer 2

我找到了解决this answer 问题的好方法。 它指向message control part of the pylint-docs。

实际上，我只需在我的自定义导入后面添加注释 # pylint: disable=import-error，如下所示：

import General.Plotting.auxiliary_plotting_functions as aux_plot  # pylint: disable=import-error

这完美地解决了我的问题，因为老实说，我没有通过配置找到一个简单的解决方案，例如.pylintrc 文件，更不用说我所有的尝试都无济于事，涉及 PYTHONPATH 和环境文件等。

简单地说，在 VS Code 中执行脚本时，我的自定义模块会正确导入，但唯一烦人的细节是 pylint 没有得到它，并向我显示了无用的导入错误。现在，pylint 不再显示这种无意义的东西了，这就是我想要的 :)

我确信可能会有更优雅的解决方案，但到目前为止，上述解决方法派上了用场。如果有人提出“更好”的解决方案，请在此处发布，我会将答案更改为您的。

---

PS 对于那些在 VS-Code 中使用 pylance 作为替代 linter 的人：

我发现here 的类似解决方法（与上述pylint 相关）工作正常（将# type: ignore 附加到导入语句），我在this question 中也提到过：

import General.Misc.general_tools as tools  # type: ignore

很可能它与settings.json - VS-Code 的文件有关，因为使用VS-Code 是这里的常数因素。

Answer 3

两件事。一、将__init__.py文件添加到你所有的子目录中，使它们成为正确的包。

二，您不需要直接添加site-packages 目录。如果这是您使用的 Python 环境，那么您需要确保从扩展中选择它。