PyCharm 2026.3 Help

教程:开始使用开发容器

在本教程中,将为本地项目创建开发容器配置、构建容器,并在其中打开项目。 最后,将获得一个正在运行的容器,以及一个连接到该容器的 IDE 窗口。

在开始之前

  • Docker 已安装在计算机上,并且 Docker 守护进程正在运行。 PyCharm 通过 Docker 构建容器,因此如果守护进程已停止,构建将失败。

  • 已安装并启用了 Docker 插件。

  • 已在 PyCharm 中打开一个本地项目。

有关完整的要求列表,包括远程 Dev Containers,请参阅 先决条件。

步骤 1。 准备项目

由于 devcontainer.json 是构建开发容器所需的配置文件,因此项目中应包含该文件。 该文件位于项目根目录中的 .devcontainer 文件夹;中间可能还有其他文件夹,例如 .devcontainer/.../.../devcontainer.json。

有两个选项可用于快速开始创建开发容器:创建简单文件,或使用 IDE 内功能基于模板创建配置文件。

开发容器的最低要求是用于构建它的镜像。

  1. 在项目视图中,右键点击项目名称并选择 新建 | 文件。

  2. 输入 .devcontainer/devcontainer.json ,以在项目根目录下的 .devcontainer 目录中创建配置。

  3. 在编辑器中打开文件并添加以下代码:

    { image: "ubuntu:latest" }
  1. 在项目视图中,右键点击项目名称并选择 新建 | Dev Container 配置。

  2. 在打开的对话框中,PyCharm 会显示默认容器配置。 默认模板足以创建开发容器,但如有必要,可以从 Dev Container 模板 下拉列表中选择任何其他特定于语言的模板。

    点击 确定 以创建一个相对简单(但包含大量注释)的 devcontainer.json:

    // Default Ubuntu-based DevContainer Template. // For more customization options, see https://containers.dev/implementors/json_reference { name: "Default", image: "ubuntu:latest", customizations : { // Configure JetBrains IDE-specific properties jetbrains : { backend : "IntelliJ", settings : { // IDE settings can be added via “Show context actions”|“Add currently modified settings from IDE”. // A complete list of supported settings is also available through auto-completion }, plugins: [ // A set of plugin IDs. // Plugin ID can be found on the corresponding plugin’s page at https://plugins.jetbrains.com. ] } }, features: { "ghcr.io/devcontainers/features/git" : {}, // Add additional features to your project using auto-completion. }, // Comment out to connect as the root user. remoteUser: "ubuntu" }

步骤 2。 为构建过程做准备

构建 Dev Container 之前,请考虑将使用哪种 Dev Container 实现:

  • 对于 Remote Development 旧版实现,请确保已禁用 设置 | 高级设置 中的 原生打开 devcontainer 项目 选项。

  • 如果使用原生模式实现,请在 设置 | 高级设置 中启用 原生打开 devcontainer 项目 选项。

此外,使用 Remote Development 实现时,建议设置 IDE 以提供扩展的后端选择。

为 Dev Containers 选择特定的 IDE 后端版本

  1. 按下 Ctrl+Alt+S 以打开设置,然后选择 高级设置。

  2. 在右侧选项中,在 开发容器 部分下,禁用 自动选择后端版本 ,然后点击 确定 以保存更改。

  3. 禁用此选项后,构建 Dev Container 后将提供多个版本的后端。

要使用自定义远程开发后端(例如,检查未发布的 IDE 构建版本中的问题),请执行以下操作:

手动下载 IDE 后端

  1. 打开 下载 页面。

  2. 选择 Linux 作为操作系统,因为 Dev Containers 目前仅支持基于 Linux 的镜像。

  3. 下载与运行 Docker Engine 的主机架构对应的归档文件。

  4. 在主菜单中,转到 导航 | 随处搜索 ,或按两次 Shift 打开搜索窗口。

  5. 输入 registry 并选择 注册表…… 选项。

  6. 在打开的窗口中,搜索 devcontainers.use.separate.project.panel 键并启用它。 点击 关闭。

  7. 重新启动 IDE。

  8. 启用注册表键后,启动 Dev Container 构建。

  9. 当 选择 IDE 和项目 窗口打开时,点击 安装选项 链接并选择 上传安装程序文件 操作。

  10. IDE 版本 字段将变为 选择归档 文件。

  11. 指定已下载的 IDE 后端归档文件的路径。

  12. 继续 Dev Container 构建过程。

步骤 3。 启动开发容器构建

  1. 打开 .devcontainer/devcontainer.json 。 点击装订区域中的 Dev Containers 图标,然后选择 创建 Dev Container 并挂载源代码…。 如果系统提示选择后端 IDE,请选择 PyCharm。

  2. 构建开始后,服务视图应会自动打开以显示构建过程:

  3. 根据所选实现(远程开发与原生模式),以下流程会略有不同。

    从列表中选择后端版本,并等待其和客户端下载:

    在某些情况下,如果开发容器构建和后端部署过程超过 10 秒,客户端将不会打开;而是在 IDE 中显示带有 连接 按钮的通知。 按下该按钮。

    在以下窗口中按 信任项目 按钮,并等待客户端打开:

    如何判断打开的是否已经是开发容器中的项目? 通过左上角的 后端状态详细信息 微件。

    由于没有后端部署步骤,开发容器项目会立即在 IDE 中打开。 如果 在 中打开项目 选项在 设置 | 外观与行为 | 系统设置 中设置为 询问 ,项目将在确认后打开。

    要判断项目是否在使用原生模式的开发容器中打开,请检查异常的项目根路径,以及编辑器左上角显示开发容器信息的微件。

    开发容器微件
2026年 11月 3日