🚀 在 VS Code 中！

容器中的 Python

在本教程中，您将学习如何

  • 创建一个描述简单 Python 容器的 Dockerfile 文件。
  • 构建、运行和验证 Django、Flask 或通用 Python 应用的功能。
  • 调试在容器中运行的应用。

前提条件

  • 在您的机器上安装 Docker 并将其添加到系统路径。

  • 在 Linux 上，您还应该为非 root 用户帐户启用 Docker CLI，该帐户将用于运行 VS Code。

  • Docker 扩展。要安装扩展，请打开“扩展”视图 (⇧⌘X (Windows、Linux Ctrl+Shift+X))，搜索 docker 以筛选结果，然后选择 Microsoft 编写的 Docker 扩展。

    Select Docker extension

创建一个 Python 项目

如果您还没有 Python 项目，请按照Python 入门教程进行操作。

注意：如果您想容器化完整的 Django 或 Flask Web 应用，您可以从以下示例之一开始

注意：对于本教程，请务必使用示例仓库的 tutorial 分支。

在验证您的应用运行正常后，您现在可以容器化您的应用程序。

将 Docker 文件添加到项目

  1. 在 VS Code 中打开项目文件夹。

  2. 打开命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 并选择Docker: 添加 Docker 文件到工作区...

    Add Dockerfile to a Python project

  3. 当提示输入应用类型时，选择Python: Django、Python: Flask 或 Python: General 作为应用类型。在本教程中，我们将重点介绍 Python: General 情况，但也会包含 Django 和 Flask 的说明。

  4. 输入应用入口点的相对路径。这不包括您开始的工作区文件夹。如果您根据Python 入门教程创建了一个名为 hello.py 的 python 应用，请选择该文件。

    Django：选择 manage.py（根文件夹）或 subfolder_name/manage.py。请参阅官方 Django 文档。

    Flask：选择您创建 Flask 实例的路径。请参阅官方 Flask 文档。

    提示：您也可以输入文件夹名称的路径，只要该文件夹包含 __main__.py 文件即可。

  5. 选择端口号。我们建议选择 1024 或以上的端口，以减轻以 root 用户身份运行带来的安全问题。任何未使用的端口都可以，但 Django 和 Flask 使用标准默认端口。

    Django：默认端口 8000。

    Flask：默认端口为 5000。

  6. 当提示包含 Docker Compose 时，如果您不需要 Docker Compose 文件，请选择否。如果您选择是，您将需要在 Dockerfile 中验证 wsgi.py 文件的路径，以成功运行 Compose Up 命令。Compose 通常在一次运行多个容器时使用。

  7. 有了这些信息，Docker 扩展将创建以下文件

    • 一个 Dockerfile。要了解有关此文件中 IntelliSense 的更多信息，请参阅概述。

    • 一个 .dockerignore 文件，通过排除不需要的文件和文件夹（如 .git、.vscode 和 __pycache__）来减小镜像大小。

    • 如果您正在使用 Docker Compose，则会生成 docker-compose.yml 和 docker-compose.debug.yml 文件。

    • 如果 requirements.txt 文件尚不存在，则会创建一个 requirements.txt 文件来捕获所有应用依赖项。

    重要提示：要使用我们的设置，Python 框架 (Django/Flask) 和 Gunicorn 必须包含在 requirements.txt 文件中。如果虚拟环境/主机已经安装了这些先决条件，并且应该与容器环境相同，请通过在终端中运行 pip freeze > requirements.txt 来确保应用依赖项被移植过来。这将覆盖您当前的 requirements.txt 文件。

（可选）向镜像添加环境变量

此步骤不是必需的，但包含此步骤是为了帮助您了解如何添加需要在容器环境中设置的环境变量。

Docker 扩展通过使用 IntelliSense 来帮助您编写 Dockerfile，以提供自动完成和上下文帮助。要查看此功能的实际效果

  1. 打开 Dockerfile。

  2. 在 EXPOSE 语句下方，键入 ⌃Space (Windows、Linux Ctrl+Space) 以触发 IntelliSense 并滚动到 ENV。

    Adding environment variable to Dockerfile

  3. 按 Tab 键或 Enter 键完成语句，然后将 key 设置为变量的名称，并将 value 设置为值。

有关在 Dockerfile 中设置和使用环境变量的更多信息，请参阅 Docker 文档中的 ENV 指令和 Environment replacement 部分。

Django 和 Flask 应用的 Gunicorn 修改

为了给 Python Web 开发人员提供一个良好的起点，我们选择使用 Gunicorn 作为默认的 Web 服务器。由于默认 Dockerfile 中引用了它，因此它作为依赖项包含在 requirements.txt 文件中。如果您在 requirements.txt 中没有看到它，请运行 pip install gunicorn，然后运行 pip freeze > requirements.txt 以重新生成 requirements.txt 文件。

  • Django：要使用 Gunicorn，它必须绑定到应用程序可调用对象（应用程序服务器用于与您的代码通信的对象）作为入口点。此可调用对象在 Django 应用程序的 wsgi.py 文件中声明。为了完成此绑定，Dockerfile 中的最后一行写道

    CMD ["gunicorn", "--bind", "0.0.0.0:8000", "{workspace_folder_name}.wsgi"]

    如果您的项目不遵循 Django 的默认项目结构（即，一个工作区文件夹和一个 wsgi.py 文件，位于与工作区同名的子文件夹中），您必须覆盖 Dockerfile 中的 Gunicorn 入口点以找到正确的 wsgi.py 文件。

    如果您的 wsgi.py 文件位于根文件夹中，则上述命令中的最后一个参数将是 "wsgi"。在子文件夹中，参数将是 "subfolder1_name.subfolder2_name.wsgi"。

  • Flask：要使用 Gunicorn，它必须绑定到应用程序可调用对象（应用程序服务器用于与您的代码通信的对象）作为入口点。此可调用对象与您创建的 Flask 实例的文件位置和变量名称相对应。根据官方 Flask 文档，用户通常以这种方式在主模块或其包的 __init__.py 文件中创建 Flask 实例

    from flask import Flask
app = Flask(__name__) # Flask instance named app

    为了完成此绑定，Dockerfile 中的最后一行写道

    CMD ["gunicorn", "--bind", "0.0.0.0:5000", "{subfolder}.{module_file}:app"]

    在 Docker: 添加 Docker 文件到工作区... 命令期间，您配置了 Flask 实例的路径，但是，Docker 扩展假设您的 Flask 实例变量名为 app。如果不是这种情况，您必须更改 Dockerfile 中的变量名称。

    如果您的主模块在根文件夹中，文件名为 main.py，并且 Flask 实例变量名为 myapp，则上述命令中的最后一个参数将是 "main:myapp"。在子文件夹中，参数将是 "subfolder1_name.subfolder2_name.main:myapp"。

构建、运行和调试容器

Docker: 添加 Docker 文件到工作区... 命令会自动创建一个 Docker 启动配置，以构建和运行处于调试模式的容器。要调试您的 Python 应用容器

  1. 导航到包含您的应用启动代码的文件，并设置一个断点。

  2. 导航到运行和调试，并根据需要选择 Docker: Python - General、Docker: Python - Django 或 Docker: Python - Flask。

    Selected Docker debug configuration

  3. 使用 F5 键开始调试。

    • Docker 镜像开始构建。
    • Docker 容器开始运行。
    • Python 调试器在断点处停止。

  4. 单步执行此行一次。

  5. 准备就绪后，按继续。

Docker 扩展将启动您的浏览器，并打开一个随机映射的端口

Django website launches

提示：要修改您的 Docker 构建设置，例如更改镜像标签，请导航到 .vscode -> tasks.json，在 docker-build 任务的 dockerBuild 属性下进行修改。在文件中使用 IntelliSense (⌃Space (Windows、Linux Ctrl+Space)) 来显示所有其他有效指令。

使用 Docker 资源管理器

Docker 资源管理器提供了一个交互式体验，用于检查和管理 Docker 资产，例如容器、镜像等。要查看示例

  1. 导航到 Docker 资源管理器。

  2. 在容器选项卡中，右键单击您的容器并选择查看日志。

    Viewing the logs of a container

  3. 输出将显示在终端中。

在 Azure 中构建镜像

您可以使用命令Azure Container Registry: 在 Azure 中构建镜像来构建一个镜像，然后您可以将其部署到 Azure 应用服务或 Azure 容器应用。

  1. 安装 Azure Resources 扩展。打开命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 并搜索命令 Azure: 登录。如果您没有 Azure 帐户，您可以注册免费试用版。

  2. 有两种方法可以调用“在 Azure 中构建”命令。您可以右键单击 Dockerfile，然后选择在 Azure 中构建镜像。您也可以使用命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P)) 并搜索命令 Azure Container Registry: 在 Azure 中构建镜像。

    Invoke the command Build Image in Azure

  3. 选择已构建镜像的名称和标签。您将使用它在容器注册表中识别镜像。

    Choose the name and tag for the built image.

  4. 选择您要使用的 Azure 订阅。

  5. 选择现有的 Azure 容器注册表，或创建一个新的注册表。当您创建一个新的注册表时，系统会要求您提供名称、资源组、位置以及定价选项，例如基本、标准或高级。您可以在定价 - 容器注册表中阅读有关这些选项的成本。

  6. 指定基本操作系统，Linux 或 Windows。此选择必须与 Dockerfile 一致。

    Choose the base OS for the built image

构建镜像的过程可能需要几分钟。您可以在终端中跟踪进度。如果您遇到错误 (Error: failed to download context.)，请尝试在容器注册表上使用刷新选项，然后请求再次构建。在重新构建之前，手动删除旧镜像。

部署到 Azure 应用服务或 Azure 容器应用

容器镜像构建完成后，它应该会出现在容器注册表中，并带有您指定的标签。现在它已经构建完成，您可以将其部署到 Azure 应用服务或 Azure 容器应用。建议使用 Azure App Service 扩展 部署到 Azure 应用服务，并且部署到 Azure 容器应用需要 Azure Container Apps 扩展。如果您安装 Azure Tools 扩展包，您可以同时获得这两个扩展，该扩展包包含用于各种 Azure 开发场景的工具包。

  1. 右键单击镜像标签，然后选择部署镜像到 Azure 应用服务或部署镜像到 Azure 容器应用。

    Deploy image to Azure App Service

  2. 提供网站的名称。这必须是一个唯一的名称，对于 Django 应用，它还必须在 settings.py 文件中的 ALLOWED_HOSTS 列表中列为有效的主机名。

  3. 提供资源组、位置和应用服务计划。如果您只是刚开始，可以选择免费计划。

  4. 镜像正在部署；此过程可能需要几分钟。部署完成后，将出现一个通知，其中包含一个可用于访问站点的按钮。您也可以使用站点的地址 {appname}.azurewebsites.net，其中 {appname} 是您在创建时给定的名称。如果一开始不起作用，请在几分钟后重试。最初几次尝试超时或返回错误是很常见的。这只是意味着应用服务尚未准备好接收请求。

  5. 在应用程序代码中进行一个小更改，使其在一个页面上可见，然后保存文件。

  6. 使用 Azure 图标打开资源视图，并展开您的订阅节点以查找您在上一步中部署的应用服务。

  7. 右键单击应用服务节点并查看可用选项。选择部署到 Web 应用，然后指定您的应用文件夹以进行部署。

    Deploy to Web App

    当警告这将覆盖之前的部署时，选择部署以确认。

    这可能需要几分钟；您可以在终端窗口中监控进度。完成后，将提供一个带有站点访问权限的按钮。

    Browse website button

    使用该按钮并验证您的更改是否反映在站点上。

恭喜您，您已使用 VS Code 中的 Python 创建并部署了一个托管在云端并在互联网上运行的网站！

释放资源

在 Azure 门户中，删除资源组以释放您在此练习期间创建的所有资源。

后续步骤

您已完成！现在您的容器已准备就绪，您可能想要

12/1/2023