设置 Docker 化的 Python 环境 — 优雅的方式

原文towardsdatascience.com/setting-a-dockerized-python-environment-the-elegant-way-f716ef85571d?sourcecollection_archive---------1-----------------------#2024-04-02本文提供了一个逐步指南介绍如何使用 VScode 和 Dev Containers 扩展设置一个 Python Docker 化开发环境。https://medium.com/rami.krispin?sourcepost_page---byline--f716ef85571d--------------------------------https://towardsdatascience.com/?sourcepost_page---byline--f716ef85571d-------------------------------- Rami Krispin·发表于 Towards Data Science ·阅读时间 9 分钟·2024 年 4 月 2 日–在上一篇关于此主题的文章中设置 Docker 化的 Python 环境 — 较为困难的方式我们讲解了如何通过命令行界面CLI设置 Docker 化的 Python 开发环境。在这篇文章中我们将回顾一种更优雅且更稳健的方法通过使用 VScode 和 Dev Containers 扩展来设置 Docker 化的 Python 开发环境。相关文章## 设置 Docker 化的 Python 环境 — 较为困难的方式本文将回顾通过命令行CLI运行 Docker 化的 Python 环境的不同方法。我是否……towardsdatascience.com到本教程结束时你将能够使用 VScode 和 Dev Containers 扩展设置一个简单的 Python 开发环境。https://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/8cbb25bfdc0e8741de15e6c984e79491.pngVScode 插图由作者使用 Midjourney 创建前提条件要跟随本教程你需要准备以下内容如果你使用的是 macOS 或 Windows 操作系统请安装 Docker Desktop或等效工具如果你使用的是 Linux 操作系统请安装 Docker。Docker Hub 账户用于拉取镜像安装了 VScode IDE 和 Dev Containers 扩展在本教程中我们将使用官方 Python 镜像 —python:3.10。本文中的所有代码示例可以在这里找到[## GitHub - RamiKrispin/vscode-python-medium: 支持 Medium 文章的代码支持 Medium 文章的代码。通过创建账户来贡献 RamiKrispin/vscode-python-medium 的开发…github.com](https://github.com/RamiKrispin/vscode-python-medium?sourcepost_page-----f716ef85571d--------------------------------)Dev Containers 扩展在开始之前让我们解释一下什么是 Dev Containers 扩展以及何时应该考虑使用它。简而言之VScode Dev Containers 扩展使您能够在 Docker 容器内无缝地打开一个隔离的 VScode 会话。隔离的层级包括以下三层环境VScode 设置VScode 扩展devcontainer.json文件定义了会话设置使我们能够设置和定义上述三层。要在容器内设置并启动项目文件夹使用 Dev Containers 扩展您需要以下两个组件安装 Dev Containers 扩展在您的项目文件夹中创建一个名为.devcontainer的文件夹并设置一个devcontainer.json文件以下图示描述了 Dev Containers 的总体架构https://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/fd24fddd18b426e7269fa83217b55ce0.pngDev Containers 扩展架构致谢 Rami Krispin启动时Dev Containers 扩展会在容器内启动一个新的 VScode 会话。默认情况下它会将本地文件夹挂载到容器中这样可以保持代码的持久性并与本地文件夹同步。您可以挂载其他文件夹但这超出了本教程的范围。在下一部分我们将看到如何使用devcontainer.json文件设置 Python 环境。设置一个 Docker 化的 Python 环境在开始使用devcontainer.json设置之前让我们首先定义开发环境的范围。它应包括以下功能Python 3.10支持 Jupyter 笔记本安装所需的库 — Pandas 和 VScode Jupyter 支持库安装支持的扩展 — Python 和 Jupyter在接下来的部分我们将深入探讨devcontainer.json文件的核心功能。我们将从一个最简化的 Python 环境开始展示如何通过添加不同的自定义层来进行定制。构建与镜像启动一个容器化会话的主要要求是定义镜像设置。设置镜像有两种方法在容器启动时使用build参数构建镜像并运行。此参数使你能够为构建定义一个 Dockerfile并将参数传递给docker build函数。构建过程完成后它将启动容器内部的会话使用image参数启动现有镜像的会话根据不同的使用场景每种方法都有其优缺点。你应该在镜像完全满足环境需求时考虑使用image参数。同样当你有一个基础镜像但需要添加一些小的自定义设置时build参数是一个很好的选择。在接下来的部分我们将通过一个简单的例子开始使用image参数导入官方 Python 镜像python:3.10来启动 Python 环境。基本的 Docker 化 Python 环境以下devcontainer.json文件提供了一个简单的示例用于设置 Python 环境。它使用image参数将python:3.10镜像定义为会话环境devcontainer.json{name:Python Development Environment,image:python:3.10}name参数定义了环境名称。在此示例中我们将其设置为Python 开发环境。在启动环境之前请确保你的 Docker Desktop或同等软件已打开你已登录到 Docker Hub或提前拉取 Python 镜像devcontainer.json文件位于项目文件夹中的.devcontainer文件夹下.└──.devcontainer └── devcontainer.json此示例的代码可在 此处 获取。要启动会话请点击左下角的 Dev Container图标并选择下方截图所示的Reopen in Container选项https://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/9f199cefb98a0b705fb23d9eadfcc058.png使用 Dev Containers 扩展启动容器内部的会话作者截图请注意在首次启动会话时Dev Containers 扩展将查找由image参数定义的镜像在此例中是python:3.10。如果镜像在本地不可用它将从 Docker Hub 拉取可能需要几分钟时间。之后启动会话通常只需几秒钟。https://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/b4479a50c69ef05d66d4b3fb41943214.png容器内的 VScode 会话作者截图在上面的截图中你可以看到devcontainer.json参数与会话设置之间的映射。会话名称现在显示在右下角紫色标记并与name参数的值对齐。同样会话现在运行在python:3.10容器内你可以从终端启动 Python。Python 容器带有默认的 Python 库。在接下来的部分我们将展示如何通过build参数在 Python 基础镜像上添加更多层。使用 Dockerfile 自定义 Python 环境现在让我们通过修改devcontainer.json来定制上述环境。我们将把image参数替换为build参数。build参数使我们能够在会话启动时通过 Dockerfile 构建镜像并向docker build函数传递参数。我们将遵循这篇文章中展示的方法来设置 Python 环境导入python:3.10作为基础镜像设置虚拟环境安装所需的库我们将使用以下 Dockerfile 来设置 Python 环境DockerfileFROM python:3.10ARG PYTHON_ENVmy_env ENV PYTHON_ENV$PYTHON_ENV RUN mkdir requirements COPY requirements.txt set_python_env.sh/requirements/RUN bash./requirements/set_python_env.sh $PYTHON_ENV我们使用FROM参数来导入 Python 镜像并使用ARG和ENV参数来设置虚拟环境作为参数和环境变量。此外我们还使用以下两个辅助文件来设置虚拟环境并安装所需的库requirements.txt— 一个设置文件其中列出了所需的库。在本演示中我们将安装 Pandas 库版本 2.0.3和 Jupyter 支持库ipykernel、ipywidgets、jupyter。wheels 库是一个支持库用于处理 C 依赖关系。set_python_env.sh— 一个辅助的 Bash 脚本用于设置虚拟环境并通过requirements.txt文件安装所需的库requirements.txtwheel0.40.0pandas2.0.3ipykernel ipywidgets jupyterset_python_env.sh#!/usr/bin/env bashPYTHON_ENV$1python3-m venv/opt/$PYTHON_ENV \export PATH/opt/$PYTHON_ENV/bin:$PATH \echosource /opt/$PYTHON_ENV/bin/activate~/.bashrc source/opt/$PYTHON_ENV/bin/activate pip3 install-r./requirements/requirements.txt最后我们将使用以下测试文件来评估 Pandas 库是否正确安装并打印Hello World!消息test1.pyimportpandasaspdprint(Hello World!)让我们在devcontainer.json文件中进行修改将image参数替换为build参数devcontainer.json{name:Python Development Environment,build:{dockerfile:Dockerfile,context:.,args:{PYTHON_ENV:my_python_dev}}}本示例的文件可以在这里找到。build子参数使我们能够通过向docker build函数传递参数来自定义镜像构建。我们使用以下参数来构建镜像dockerfile— Dockerfile 的路径和名称context— 设置本地文件系统的路径以便在构建时通过COPY参数访问文件。在这种情况下我们使用devcontainer.json文件的当前文件夹例如.devcontainer文件夹。args— 在构建过程中设置并传递参数给容器。我们使用PYTHON_ENV参数来设置虚拟环境并命名为my_python_dev你应该将这三个文件 —Dockerfile、requirements.txt和set_python_env.sh存储在.devcontainer文件夹下并与devcontainer.json文件一起使用.├──.devcontainer │ ├── Dockerfile │ ├── devcontainer.json │ ├── requirements.txt │ └── set_python_env.sh └── test2.py现在让我们使用新设置启动会话并使用test1.py文件进行测试https://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/839afb5683f5adfe2c5732bd9a28f5bd.png运行一个 Python 脚本以测试环境截图来自作者如上图所示我们成功地从终端标记为紫色运行了测试脚本并且它按预期打印出了**Hello World!**消息标记为绿色。此外我们在镜像中设置的虚拟环境my_python_dev默认已加载标记为黄色。在下一部分中我们将看到如何自定义 Dev Containers 会话的 VScode 设置。自定义 VScode 设置Dev Containers 扩展的一个重要特点是它将会话设置与主要的 VScode 设置隔离开来。这意味着你可以在项目级别完全自定义 VScode 设置。它扩展了开发环境的可复现性不仅限于 Python 或操作系统设置。最后但同样重要的是它使得与他人协作或在多台机器上工作变得无缝且高效。我们将在接下来的示例中结束本教程看看如何使用customizations参数自定义 VScode 设置。我们将向前面的示例添加该参数并使用vscode子参数设置环境默认的 Python 解释器和所需的扩展devcontainer.json{name:Python Development Environment,build:{dockerfile:Dockerfile,context:.,args:{PYTHON_ENV:my_python_dev}},customizations:{vscode:{settings:{python.defaultInterpreterPath:/opt/my_python_dev/bin/python3,python.selectInterpreter:/opt/my_python_dev/bin/python3},extensions:[ms-python.python,ms-toolsai.jupyter]}}}该示例的文件可以在这里找到。我们使用settings参数来定义镜像中定义的 Python 虚拟环境。此外我们使用extensions参数安装Python和Jupyter支持扩展。注意虚拟环境的路径由用于设置环境的应用程序类型定义。当我们使用venv并将其命名为my_python_dev时路径为opt/my_python_dev/bin/python3。在添加 Python 扩展后我们可以使用扩展插件启动 Python 脚本如下图所示。此外我们还可以利用 Jupyter 扩展以交互模式执行 Python 代码https://github.com/OpenDocCN/towardsdatascience-blog-zh-2024/raw/master/docs/img/4c8bda14019b0f7f505bb1532d14321c.png总结在本教程中我们回顾了如何使用 VScode 和 Dev Containers 扩展设置一个 Docker 化的 Python 环境。Dev Containers 扩展使得容器与开发工作流的集成变得无缝且高效。我们了解了如何通过几个简单的步骤使用devcontainer.json文件来设置和自定义 Docker 化的 Python 环境。我们回顾了两种设置会话镜像的方法通过image和build参数以及通过customizations参数来设置扩展。还有其他自定义选项未在本教程中涉及我建议查看这些选项定义环境变量挂载额外的卷设置docker run命令的参数启动后运行命令如果你有兴趣深入了解更多细节我推荐查看这个教程[## GitHub - RamiKrispin/vscode-python: 使用 VScode 和 Docker 设置 Python 开发环境的教程…使用 VScode 和 Docker 设置 Python 开发环境的教程 - RamiKrispin/vscode-pythongithub.com](https://github.com/RamiKrispin/vscode-python?sourcepost_page-----f716ef85571d--------------------------------)资源代码示例 —github.com/RamiKrispin/vscode-python-mediumVScode —code.visualstudio.com/开发容器 —code.visualstudio.com/docs/devcontainers/containers设置一个 Docker 化的 Python 开发环境使用 GitHub 模板 —medium.com/rami.krispin/setting-a-dockerized-python-development-environment-template-de2400c4812b