使用 Dev Container 时如何修复 VS Code 编辑器中的 Python 导入错误？

Question

我已经在 VS Code 中打开了一个具有以下结构的项目（macOS 上的 1.71.0，Intel）并激活了一个 Dev Container（我尝试了 Microsoft 的默认 Python 3.9 和 3.10 容器，使用和不使用 python3 -m venv ...） ：

project/
  .devcontainer/
    devcontainer.json
    Dockerfile
  foo/
    foo/
      tests/
        test_bar.py  <-- IDE reports import error in this file
      resources/
      __init__.py
      bar.py
    setup.py

在 VS Code 的终端窗口中，我可以从目录project/foo 成功运行test_bar.py，其中：

python3 -m unittest discover foo/tests -p 'test_*.py'

所以该项目是有效的，并且可以从命令行运行。

但是当我在 VS Code 中打开文件 project/foo/foo/tests/test_bar.py 时，我看到以下行的错误 Unable to import 'foo' pylint(import-error) 带有红色下划线：

from foo import bar

对于使用pip3 install 安装的外部软件包，我看到了类似的假定错误。

我试图通过在project/.devcontainer.json 的各个位置添加各种相对和绝对路径（例如/workspaces/project/foo）来通知 VS Code，例如：

• customizations.vscode.settings
  • python.analysis.extraPaths
  • python.autoComplete.extraPaths
  • python.testing.unittestargs

但到目前为止我没有运气（在许多 IDE 重新启动和容器映像重建之后）。

所以我很想知道；在使用开发容器时，应该如何修复 VS Code 中这种带有 IDE 标记的导入错误？

附加信息

由于在 cmets 中请求了一个文件，这里是我使用的关键测试项目文件（我没有修复任何路径；我的最后一个测试项目名为 vscode-python-dev-container，而不是 project，我在上面用作简写）。

devcontainer.json（为建议的PYTHONPATH 更改添加了containerEnv 部分）：

// For format details, see https://aka.ms/devcontainer.json. For config options, see the README at:
// https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/python-3
{
    "name": "Python 3",
    "build": {
        "dockerfile": "Dockerfile",
        "context": "..",
        "args": { 
            // Update 'VARIANT' to pick a Python version: 3, 3.10, 3.9, 3.8, 3.7, 3.6
            // Append -bullseye or -buster to pin to an OS version.
            // Use -bullseye variants on local on arm64/Apple Silicon.
            "VARIANT": "3.10-bullseye",
            // Options
            "NODE_VERSION": "lts/*"
        }
    },

    "containerEnv": {
        "PYTHONPATH": "/workspaces/vscode-python-dev-container/foo"
    },

    // Configure tool-specific properties.
    "customizations": {
        // Configure properties specific to VS Code.
        "vscode": {
            // Set *default* container specific settings.json values on container create.
            "settings": { 
                "python.defaultInterpreterPath": "/usr/local/bin/python",
                "python.linting.enabled": true,
                "python.linting.pylintEnabled": true,
                "python.formatting.autopep8Path": "/usr/local/py-utils/bin/autopep8",
                "python.formatting.blackPath": "/usr/local/py-utils/bin/black",
                "python.formatting.yapfPath": "/usr/local/py-utils/bin/yapf",
                "python.linting.banditPath": "/usr/local/py-utils/bin/bandit",
                "python.linting.flake8Path": "/usr/local/py-utils/bin/flake8",
                "python.linting.mypyPath": "/usr/local/py-utils/bin/mypy",
                "python.linting.pycodestylePath": "/usr/local/py-utils/bin/pycodestyle",
                "python.linting.pydocstylePath": "/usr/local/py-utils/bin/pydocstyle",
                "python.linting.pylintPath": "/usr/local/py-utils/bin/pylint"
            },
            
            // Add the IDs of extensions you want installed when the container is created.
            "extensions": [
                "ms-python.python",
                "ms-python.vscode-pylance"
            ]
        }
    },

    // Use 'forwardPorts' to make a list of ports inside the container available locally.
    // "forwardPorts": [],

    // Use 'postCreateCommand' to run commands after the container is created.
    // "postCreateCommand": "pip3 install --user -r requirements.txt",

    // Comment out to connect as root instead. More info: https://aka.ms/vscode-remote/containers/non-root.
    "remoteUser": "vscode"
}

Dockerfile:

# See here for image contents: https://github.com/microsoft/vscode-dev-containers/tree/v0.245.2/containers/python-3/.devcontainer/base.Dockerfile

# [Choice] Python version (use -bullseye variants on local arm64/Apple Silicon): 3, 3.10, 3.9, 3.8, 3.7, 3.6, 3-bullseye, 3.10-bullseye, 3.9-bullseye, 3.8-bullseye, 3.7-bullseye, 3.6-bullseye, 3-buster, 3.10-buster, 3.9-buster, 3.8-buster, 3.7-buster, 3.6-buster
ARG VARIANT="3.10-bullseye"
FROM mcr.microsoft.com/vscode/devcontainers/python:0-${VARIANT}

# [Choice] Node.js version: none, lts/*, 16, 14, 12, 10
ARG NODE_VERSION="none"
RUN if [ "${NODE_VERSION}" != "none" ]; then su vscode -c "umask 0002 && . /usr/local/share/nvm/nvm.sh && nvm install ${NODE_VERSION} 2>&1"; fi

# [Optional] If your pip requirements rarely change, uncomment this section to add them to the image.
# COPY requirements.txt /tmp/pip-tmp/
# RUN pip3 --disable-pip-version-check --no-cache-dir install -r /tmp/pip-tmp/requirements.txt \
#    && rm -rf /tmp/pip-tmp

# [Optional] Uncomment this section to install additional OS packages.
# RUN apt-get update && export DEBIAN_FRONTEND=noninteractive \
#     && apt-get -y install --no-install-recommends <your-package-list-here>

# [Optional] Uncomment this line to install global node packages.
# RUN su vscode -c "source /usr/local/share/nvm/nvm.sh && npm install -g <your-package-here>" 2>&1

bar.py:

"""An example module."""
JSON_STR = '{"a": 1}'

test_bar.py:

"""An example test."""
import json
import unittest
import requests  # test external lib access
from foo import bar

class TestFooBar(unittest.TestCase):
    """An example test class."""
    a = requests.__name__  # to eliminate warning above that package isn't used
    def test_foo_bar_json(self):
        """An example test."""
        data = json.loads(bar.JSON_STR)
        self.assertEqual(data['a'], 1)

Answer 1

我经常在 Python+Devcontainer 上遇到同样的问题。对我有用的是：

1. 设置此环境变量：export PYTHONPATH=/workspace，您也可以尝试使用/workspaces 或/yourProjectName，具体取决于您的设置。

2. 使用 Ctrl+Shift+P > Python: Restart Language Server 重新启动 Python 语言服务器。

   请注意，您不需要重建容器。当您找到 PYTHONPATH 的正确值时，您可以将其添加到您的 Devcontainer configuration。

Answer 2

这个问题完全解决了吗？ 我相信它必须与您的目录结构有关。

请看一下推荐的目录结构here

.devcontainer/
  devcontainer.json
.devcontainer/
  Dockerfile
README.rst
LICENSE
setup.py
requirements.txt
foo/
  __init__.py
foo/
  bar.py
tests/
  test_bar.py
docs/
  conf.py    // optional
docs/
  index.rst  // optional

如果您不想打乱您的目录结构，您可以考虑以下两个条目：

1. 在devcontainer.json文件中，给context:"."
2. 在Dockerfile 中，为WORKDIR 添加适当的条目