使用VS Code Dev Container时如何修复Python导入错误？

问题描述 #

我在macOS Intel平台的VS Code 1.71.0中打开了一个项目，启用了Dev Container（尝试过微软官方Python 3.9和3.10容器，无论是否使用python3 -m venv创建虚拟环境），项目结构如下：

project/
  .devcontainer/
    devcontainer.json
    Dockerfile
  foo/
    foo/
      tests/
        test_bar.py  <-- IDE在此文件中报告导入错误
      resources/
      __init__.py
      bar.py
    setup.py

在VS Code的终端中，我可以在project/foo目录下通过以下命令成功运行测试：

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

但在VS Code中打开project/foo/foo/tests/test_bar.py时，代码from foo import bar被标记红色下划线，提示错误Unable to import 'foo' pylint(import-error)，通过pip3 install安装的外部包也出现类似错误。

我尝试在devcontainer.json的customizations.vscode.settings中添加python.analysis.extraPaths、python.autoComplete.extraPaths等路径配置，多次重启IDE和重建容器后问题仍未解决。

补充信息 #

测试项目实际名称为vscode-python-dev-container，关键配置文件如下：

devcontainer.json #

// 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)

解决方案 #

1. 同时配置VS Code分析器和Pylint的路径 #

修改devcontainer.json中的customizations.vscode.settings，添加以下配置，确保Pylance和Pylint都能识别模块路径：

"python.analysis.extraPaths": ["/workspaces/vscode-python-dev-container/foo"],
"python.linting.pylintArgs": ["--init-hook", "import sys; sys.path.append('/workspaces/vscode-python-dev-container/foo')"]

2. 将项目安装为可编辑模式 #

在devcontainer.json中启用postCreateCommand，让容器创建后自动安装项目为可编辑包，这样Python会全局识别foo模块：

"postCreateCommand": "cd /workspaces/vscode-python-dev-container/foo && pip install -e ."

3. 确认Python解释器选择 #

点击VS Code左下角的Python版本指示器，确认选中的是容器内的/usr/local/bin/python解释器，避免使用本地环境的解释器。

4. 清理缓存并重建容器 #

• 打开命令面板（快捷键Cmd+Shift+P），执行Dev Containers: Rebuild Container，让配置生效
• 再次打开命令面板，执行Python: Clear Cache and Reload Window，清除分析器缓存

5. 外部包错误处理 #

如果外部包（如requests）也出现导入错误，确保在容器内的Python环境中安装了这些包：

• 在容器终端执行pip install requests
• 或者把依赖写入requirements.txt，修改postCreateCommand为：

"postCreateCommand": "cd /workspaces/vscode-python-dev-container/foo && pip install -e . && pip install -r requirements.txt"

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