如何在python项目里添加并编辑dockerfile dockerfile应该包括哪些内容

Rhys..

已于 2024-12-17 17:45:12 修改

阅读量1k

点赞数 24

分类专栏：测试集成文章标签： python 服务器 jenkins docker

于 2024-12-17 17:38:09 首次发布

本文链接：https://blog.csdn.net/m0_60008263/article/details/144540523

版权

测试集成专栏收录该内容

1 篇文章

订阅专栏

1. 添加 Dockerfile 到你的项目

2. 编辑 Dockerfile

3. 编写 requirements.txt

4. 复制 requirements.txt 并安装 Python 依赖：

在我们得 Python 项目中添加并编辑 Dockerfile 以创建 Docker 镜像，这个 Dockerfile 应该包含所有必要的步骤来安装应用程序的依赖项，设置环境变量，复制项目文件，执行项目代码以及安装运行时（如 Xvfb）等。

一个典型的 Python 项目 Dockerfile 可以如下所示：

1. 添加 Dockerfile 到你的项目

首先，在你的项目根目录下创建一个名为 Dockerfile 的文件。

2. 编辑 Dockerfile

以下是一个包含 Python 项目、依赖安装、Xvfb 安装和应用运行的示例 Dockerfile：

# 使用官方Python镜像作为基础镜像
FROM python:3.12-slim

# 设置工作目录
WORKDIR /app

# 安装系统依赖
RUN apt-get update && apt-get install -y \
    xvfb \
    x11-utils \
    x11-apps \
    libgl1-mesa-glx \
    && apt-get clean \
    && rm -rf /var/lib/apt/lists/*

# 将 requirements.txt 复制到工作目录
COPY requirements.txt .

# 安装Python依赖
RUN pip install --no-cache-dir -r requirements.txt

# 将项目文件复制到工作目录
COPY . .

# 设置环境变量
ENV DISPLAY=:99

# 启动Xvfb
RUN Xvfb :99 -screen 0 1920x1080x24 &

# 启动应用
CMD ["python", "your_main_script.py"]

3. 编写 `requirements.txt`

确保在项目根目录中有一个 requirements.txt 文件，其中列出了所有 Python 依赖，如：

attrs==24.2.0
certifi==2024.8.30
cffi==1.17.1
charset-normalizer==3.4.0
exceptiongroup==1.2.2
.....

示例 Dockerfile 详细解释

1. 基础镜像：

FROM python:3.12-slim

使用官方的 python:3.12-slim 作为基础镜像。可以根据需要选择其他版本或基础镜像。

2. 工作目录：

WORKDIR /app

设置工作目录 /app。所有接下来的命令都将在这个目录内执行。这个名称目录对于docker容器内部是可以随意命名的，并不一定要与实际的文件路径一致，不过为了方便与清晰，一般会选择与项目结构相关联的名称

3. 安装系统依赖：

RUN apt-get update && apt-get install -y \
    xvfb \
    x11-utils \
    x11-apps \
    libgl1-mesa-glx \
    && apt-get clean \
    && rm -rf /var/lib/apt/lists/*

更新 APT 包列表，并安装 xvfb 和其他必要的 X11 相关工具。注意这些包是基于 Debian/Ubuntu 的包管理系统，如果使用其他带有不同包管理系统的基础镜像，需要相应更改安装指令。

4. 复制 `requirements.txt` 并安装 Python 依赖：

COPY requirements.txt .
RUN pip install --no-cache-dir -r requirements.txt

将 requirements.txt 复制到容器内，并使用 pip 安装 Python 依赖。

5. 复制项目文件：

COPY . .

将项目文件复制到 Docker 容器中的工作目录。

6. 设置环境变量：

ENV DISPLAY=:99

设置 DISPLAY 环境变量，指定 Xvfb 使用的显示名称。

7. 启动 `Xvfb`：

RUN Xvfb :99 -screen 0 1920x1080x24 &

在 Dockerfile 构建阶段启动 Xvfb。

8. 启动应用：

CMD ["python", "your_main_script.py"]

使用 CMD 指令定义容器启动时执行的命令，这里是运行你的 Python 应用的主脚本。

4. 构建并运行 Docker 镜像

在项目目录中，运行以下命令构建 Docker 镜像：

docker build -t your-python-app:latest .

然后，运行构建好的 Docker 镜像：

docker run --rm -it your-python-app:latest

这会启动容器并在后台启动 Xvfb，然后运行你的 Python 应用程序。确保 your_main_script.py 替换为你实际的 Python 脚本文件名。通过这种方式，你就可以在 Docker 环境中运行带有图形界面的 Python 应用，在dockerfile和requirement都完成之后就可以在Jenkins Pipline中构建stage，继续后面的集成测试了