在容器中使用 Python

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

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

先决条件

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

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

• 容器工具扩展。要安装此扩展，请打开“扩展”视图（⇧⌘X（Windows、Linux Ctrl+Shift+X）），搜索 container tools 以筛选结果，然后选择由 Microsoft 创作的“容器工具”扩展。

  

创建 Python 项目

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

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

• python-sample-vscode-django-tutorial，这是遵循Django 教程的结果

• python-sample-vscode-flask-tutorial，这是遵循Flask 教程的结果

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

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

向项目添加 Docker 文件

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

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

   

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. 有了所有这些信息，容器工具扩展会创建以下文件

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

   

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

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

Gunicorn 对 Django 和 Flask 应用程序的修改

为了给 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"]
  

  在 Containers: Add Docker Files to Workspace... 命令期间，您配置 Flask 实例的路径，但是，容器工具扩展假定您的 Flask 实例变量命名为 app。如果不是这种情况，您必须更改 Dockerfile 中的变量名称。

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

构建、运行和调试容器

Containers: Add Docker Files to Workspace... 命令会自动创建一个 Docker 启动配置，用于以调试模式构建和运行容器。要调试您的 Python 应用程序容器

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

2. 导航到运行和调试并选择容器: Python - General、容器: Python - Django 或 容器: Python - Flask（视情况而定）。

   

3. 使用 F5 键开始调试。

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

4. 单步跳过此行。

5. 准备好后，按继续。

容器工具扩展将向您的浏览器启动一个随机映射端口的浏览器

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

使用容器资源管理器

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

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

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

   

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

在 Azure 中构建映像

您可以使用命令 Azure 容器注册表: 在 Azure 中构建映像来构建一个映像，然后您可以将其部署到 Azure App Service 或 Azure 容器应用。

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

2. 有两种方法可以调用在 Azure 中构建命令。您可以右键单击 Dockerfile 并选择在 Azure 中构建映像。您也可以使用命令面板（⇧⌘P（Windows、Linux Ctrl+Shift+P））并搜索命令 Azure 容器注册表: 在 Azure 中构建映像。

   

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

   

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

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

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

   

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

部署到 Azure App Service 或 Azure 容器应用

容器映像构建完成后，它应带有您指定的标签出现在容器注册表中。现在它已经构建好了，您可以将其部署到 Azure App Service 或 Azure 容器应用。推荐使用Azure App Service 扩展进行到 Azure App Service 的部署，并且部署到 Azure 容器应用需要Azure 容器应用扩展。如果您安装了Azure 工具扩展包，其中包含用于各种 Azure 开发场景的工具包，则可以同时获取这两个扩展。

1. 右键单击映像标签并选择将映像部署到 Azure App Service 或 将映像部署到 Azure 容器应用。

   

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

3. 提供资源组、位置和 App Service 计划。如果您刚开始，可以选择免费计划。

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

5. 对应用程序代码中在某个页面上可见的更改进行少量修改，然后保存文件。

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

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

   

   当系统警告这将覆盖以前的部署时，选择部署进行确认。

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

   

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

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

释放资源

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

后续步骤

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

• 了解 Docker Compose 的使用
• 使用 Docker Compose 调试
• 自定义如何在容器中调试 Python 应用程序
• 自定义你的 Docker 生成和运行任务
• 将您的 Django 映像推送到 Azure 容器注册表
• 部署到 Azure 容器应用