尝试在 VS Code 中使用 ！

容器中的 Python

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

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

先决条件

创建一个 Python 项目

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

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

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

验证应用正常运行后，现在可以将应用容器化。

向项目添加 Docker 文件

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

  2. 打开命令面板 (⇧⌘P (Windows、Linux Ctrl+Shift+P))，然后选择容器：将 Docker 文件添加到工作区...

    Add Dockerfile to a Python project

  3. 当提示选择应用类型时，选择 Python：Django、Python：Flask 或 Python：通用 作为应用类型。在本教程中，我们将重点介绍 Python：通用 案例，但也会包含关于 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. 有了这些信息，容器工具扩展会创建以下文件

    • 一个 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 文件。

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

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

容器工具扩展通过使用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"。在子文件夹内，参数将是 "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 文件添加到工作区... 命令期间，你会配置 Flask 实例的路径，但是，容器工具扩展假定你的 Flask 实例变量名为 app。如果不是这种情况，你必须更改 Dockerfile 中的变量名。

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

构建、运行和调试容器

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

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

  2. 导航到运行和调试，然后根据情况选择容器：Python - 通用、容器：Python - Django 或容器：Python - Flask。

    Selected container debug configuration

  3. 使用 F5 键开始调试。

    • 容器镜像正在构建。
    • 容器正在运行。
    • python 调试器在断点处停止。

  4. 跳过此行一次。

  5. 准备好后，按继续。

容器工具扩展将打开你的浏览器，并连接到一个随机映射的端口

Django website launches

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

使用容器资源管理器

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

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

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

    Viewing the logs of a container

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

在 Azure 中构建镜像

你可以使用命令 Azure Container Registry：在 Azure 中构建镜像 来构建一个镜像，然后将其部署到 Azure App Service 或 Azure Container Apps。

  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 Container Registry，或创建一个新的。创建新注册表时，系统会要求你提供名称、资源组、位置以及定价选项，例如基本、标准或高级。你可以在 定价 - Container Registry 中阅读有关这些选项成本的信息。

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

    Choose the base OS for the built image

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

部署到 Azure App Service 或 Azure Container Apps

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

  1. 右键单击镜像标签，然后选择部署镜像到 Azure App Service 或部署镜像到 Azure Container Apps。

    Deploy image to Azure App Service

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

  3. 提供一个资源组、位置和 App Service 计划。如果你刚刚入门，可以选择免费计划。

  4. 镜像已部署；此过程可能需要几分钟。部署完成后，会出现一个通知，其中包含一个按钮，你可以使用该按钮访问网站。你也可以使用网站地址 {appname}.azurewebsites.net，其中 {appname} 是创建时你给的名称。如果一开始无法访问，请稍等几分钟再试。前几次尝试超时或返回错误是很常见的情况。这只是意味着 App Service 尚未准备好接收请求。

  5. 对应用代码进行一个小的更改，使其在某个页面上可见，并保存文件。

  6. 使用 Azure 图标打开资源视图，并展开你的订阅节点，以找到你在上一步中部署的 App Service。

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

    Deploy to Web App

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

    这可能需要几分钟；你可以在终端窗口中监视进度。完成后，会提供一个按钮，可用于访问网站。

    Browse website button

    使用该按钮并验证你的更改是否已反映在网站上。

恭喜！你已使用 VS Code 中的 Python 创建并部署了一个托管在云中且可在 Internet 上访问的网站！

释放资源

在 Azure 门户中，删除资源组以释放你在本练习中创建的所有资源。

后续步骤

你完成了！现在你的容器已准备好，你可能想

12/1/2023