现已推出！阅读有关 11 月份的新功能和修复的信息。

容器中的 Python

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

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

先决条件

创建 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 文件不存在，则会创建一个，用于捕获所有应用依赖项。

    重要提示：若要使用我们的设置，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 指令和 环境变量替换 部分。

用于 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"。在子文件夹中，该参数将是 "子文件夹1_名称.子文件夹2_名称.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"。在子文件夹中，该参数将是 "子文件夹1_名称.子文件夹2_名称.main:myapp"。

构建、运行和调试容器

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

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

  2. 导航到运行和调试，并根据需要选择Docker：Python - 通用、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 容器注册表：在 Azure 中构建镜像 来构建一个镜像，然后你可以将其部署到 Azure 应用服务或 Azure 容器应用。

  1. 安装 Azure 资源扩展。打开命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)），并搜索命令 Azure：登录。如果你没有 Azure 帐户，你可以注册一个免费试用版。

  2. 有两种方法可以在 Azure 中调用构建命令。你可以右键单击 Dockerfile，然后选择在 Azure 中构建镜像。你还可以使用命令面板（⇧⌘P (Windows, Linux Ctrl+Shift+P)）并搜索命令 Azure 容器注册表：在 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 应用服务扩展建议用于部署到 Azure 应用服务，而 Azure 容器应用扩展是部署到 Azure 容器应用所必需的。你可以通过安装 Azure 工具扩展包来获取这两个扩展，该扩展包包含一系列用于各种 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