在 GitHub Codespaces 中设置 Python 项目

简介

本指南介绍如何使用 Visual Studio Code Web 客户端在 GitHub Codespaces 中设置示例 Python 项目。它将引导您完成在 Codespace 中打开项目以及添加和修改预定义开发容器配置的过程。

完成本教程后，您将能够使用 VS Code Web 客户端或 VS Code 桌面应用程序将开发容器配置添加到您自己的存储库中。

有关开发容器的更多信息，请参阅“开发容器简介”。

步骤 1：在 Codespace 中打开项目

如果您尚未登录 GitHub.com，请登录。
转到 https://github.com/microsoft/vscode-remote-try-python。
点击**使用此模板**，然后点击**在 Codespace 中打开**。

创建 Codespace 时，您的项目将在专用于您的远程虚拟机上创建。默认情况下，Codespace 的容器包含许多语言和运行时，包括 Python。它还包含一组通用的工具，如 git、wget、rsync、openssh 和 nano。

您可以通过调整 vCPU 和 RAM 的数量、添加点文件以个性化您的环境或修改安装的工具和脚本来自定义您的 Codespace。有关更多信息，请参阅“自定义您的 Codespace”。

GitHub Codespaces 使用名为devcontainer.json的文件来配置在 Codespace 中工作时使用的开发容器。每个存储库可以包含一个或多个devcontainer.json文件，以便为您提供在 Codespace 中处理代码所需的开发环境。

启动时，GitHub Codespaces 使用devcontainer.json文件以及构成开发容器配置的任何相关文件来安装工具和运行时，并执行项目所需的其它设置任务。有关更多信息，请参阅“开发容器简介”。

步骤 2：添加开发容器配置

GitHub Codespaces 的默认开发容器或“开发容器”预装了最新的 Python 版本、包管理器（pip、Miniconda）和其他常用工具。但是，我们建议您配置自己的开发容器，以包含项目所需的所有工具和脚本。这将确保存储库中所有 GitHub Codespaces 用户都能获得完全可复制的环境。

要设置您的存储库以使用自定义开发容器，您需要创建一个或多个devcontainer.json文件。您可以从 Visual Studio Code 中的预定义配置模板添加这些文件，也可以自己编写。有关开发容器配置的更多信息，请参阅“开发容器简介”。

访问 Visual Studio Code 命令面板（Shift+Command+P / Ctrl+Shift+P），然后开始键入“add dev”。点击**Codespaces: 添加开发容器配置文件**。
点击**创建新配置**。
在此示例中，您从中创建 Codespace 的模板存储库已包含开发容器配置，因此会显示一条消息，告诉您配置文件已存在。我们将覆盖现有的配置文件，因此请点击**继续**。
点击**显示所有定义**。
开始键入python，然后在列表中点击**Python 3**。如果您的项目使用特定的工具，则可以使用其他选项。例如，Python 3 & PostgreSQL。
选择要用于项目的 Python 版本。在本例中，选择标记为“(默认)”的版本。
将显示一个附加功能列表。我们将安装 Coverage.py，这是一个用于 Python 的代码覆盖率工具。要安装此工具，请键入py，选择Coverage.py (via pipx)，然后点击**确定**。
将显示一条消息，告诉您开发容器配置文件已存在。点击**覆盖**。

将创建一个devcontainer.json文件，并在编辑器中打开。

自定义开发容器配置的详细信息

如果您查看 Visual Studio Code 资源管理器，您会看到项目存储库的根目录中添加了一个.devcontainer目录，其中包含devcontainer.json文件。这是从此存储库创建的 Codespace 的主要配置文件。

devcontainer.json

您添加的devcontainer.json文件将包含name、image和features属性的值。包括了一些您可能觉得有用的其他属性，但已注释掉。

根据您选择的映像，该文件将类似于以下内容

// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python
{
  "name": "Python 3",
  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
  "image": "mcr.microsoft.com/devcontainers/python:0-3.11-bullseye",
  "features": {
    "ghcr.io/devcontainers-contrib/features/coverage-py:2": {}
  }

  // Features to add to the dev container. More info: https://containers.dev/features.
  // "features": {},

  // 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",

  // Configure tool-specific properties.
  // "customizations": {},

  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
  // "remoteUser": "root"
}

**name**：您可以将开发容器命名为任何您想要的名字。提供了一个默认值。
**image**：容器注册表（DockerHub、GitHub 容器注册表或 Azure 容器注册表）中将用于创建 Codespace 的开发容器的映像名称。
**features**：一个或多个对象的列表，每个对象都引用一个可用的开发容器功能。功能是独立的、可共享的安装代码和开发容器配置单元。它们提供了一种简单的方法，可以向您的开发容器添加更多工具、运行时或库功能。您可以在 VS Code 中或 GitHub 上的devcontainer.json编辑器中添加功能。有关更多信息，请在“向 devcontainer.json 文件添加功能”中点击**Visual Studio Code**或**Web 浏览器**选项卡。
**forwardPorts**：此处列出的任何端口都将自动转发。有关更多信息，请参阅“转发 Codespace 中的端口”。
**postCreateCommand**：使用此属性在创建 Codespace 后运行命令。这可以格式化为字符串（如上所示）、数组或对象。有关更多信息，请参阅 Development Containers 网站上的开发容器规范。
**customizations**：此属性允许您在使用特定工具或服务在 Codespace 中工作时对其进行自定义。例如，您可以为 VS Code 配置特定设置和扩展。有关更多信息，请参阅 Development Containers 网站上的“支持工具和服务”。
**remoteUser**：默认情况下，您以 vscode 用户身份运行，但可以选择将其设置为 root。

有关可用属性的完整列表，请参阅 Development Containers 网站上的开发容器规范。

如果您熟悉 Docker，除了devcontainer.json文件之外，您可能还想使用 Dockerfile 或 Docker Compose 来配置 Codespace 环境。您可以通过在devcontainer.json文件旁边添加Dockerfile或docker-compose.yml文件来做到这一点。有关更多信息，请参阅 Development Containers 网站上的“使用映像、Dockerfile 和 Docker Compose”。

步骤 3：修改 devcontainer.json 文件

添加开发容器配置并基本了解所有内容的功能后，您现在可以进行更改以进一步自定义环境。在此示例中，您将添加以下属性：

安装应用程序所需的包。
在此 Codespace 中安装 VS Code 扩展。

在devcontainer.json文件中，在features属性后添加逗号，并删除关于功能的两行注释掉的代码。

JSON

"features": {
  "ghcr.io/devcontainers-contrib/features/coverage-py:2": {}
},

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

"features": {
  "ghcr.io/devcontainers-contrib/features/coverage-py:2": {}
},

// Features to add to the dev container. More info: https://containers.dev/features.
// "features": {},

取消postCreateCommand属性的注释。

JSONC

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

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

取消customizations属性的注释，并按如下方式编辑它以安装“代码拼写检查器”VS Code 扩展。

JSONC

// Configure tool-specific properties.
"customizations": {
  // Configure properties specific to VS Code.
  "vscode": {
    // Add the IDs of extensions you want installed when the container is created.
    "extensions": [
      "streetsidesoftware.code-spell-checker"
    ]
  }
}

// Configure tool-specific properties.
"customizations": {
  // Configure properties specific to VS Code.
  "vscode": {
    // Add the IDs of extensions you want installed when the container is created.
    "extensions": [
      "streetsidesoftware.code-spell-checker"
    ]
  }
}

根据您选择的映像，devcontainer.json文件现在应类似于以下内容

// For format details, see https://aka.ms/devcontainer.json. For config options, see the
// README at: https://github.com/devcontainers/templates/tree/main/src/python
{
  "name": "Python 3",
  // Or use a Dockerfile or Docker Compose file. More info: https://containers.dev/guide/dockerfile
  "image": "mcr.microsoft.com/devcontainers/python:0-3.11-bullseye",
  "features": {
    "ghcr.io/devcontainers-contrib/features/coverage-py:2": {}
  },

  // 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",

  // Configure tool-specific properties.
  "customizations": {
    // Configure properties specific to VS Code.
    "vscode": {
      // Add the IDs of extensions you want installed when the container is created.
      "extensions": [
        "streetsidesoftware.code-spell-checker"
      ]
    }
  }

  // Uncomment to connect as root instead. More info: https://aka.ms/dev-containers-non-root.
  // "remoteUser": "root"
}

保存更改。
访问 VS Code 命令面板（Shift+Command+P / Ctrl+Shift+P），然后开始键入“rebuild”。点击**Codespaces: 重建容器**。

提示

您可能偶尔需要执行完全重建以清除缓存并使用新的映像重建容器。有关更多信息，请参阅“重建 Codespace 中的容器”。在 Codespace 内部重建可确保您的更改在您将更改提交到存储库之前按预期工作。如果某些操作导致失败，您将被置于具有恢复容器的 Codespace 中，您可以从中重建以继续调整容器。

重建开发容器后，Codespace 再次可用，postCreateCommand将已运行，安装requirements.txt文件中列出的包，并且“代码拼写检查器”扩展将可供使用。