告别复杂命令！Python-on-Whales让Docker Compose操作变得简单

【免费下载链接】python-on-whalesAn awesome Python wrapper for an awesome Docker CLI!项目地址: https://gitcode.com/gh_mirrors/py/python-on-whales

Python-on-Whales是一个功能强大的Python包装器，专为简化Docker Compose操作而设计。它让开发者能够用Python代码替代复杂的命令行指令，轻松管理容器化应用的生命周期，无论是构建、启动还是停止服务，都变得前所未有的简单。

为什么选择Python-on-Whales？

传统的Docker Compose操作往往需要记忆大量命令和参数，例如docker compose up -d --build或docker compose down -v。而Python-on-Whales将这些操作转化为直观的Python方法调用，大幅降低了使用门槛，同时保留了Docker Compose的全部功能。

核心优势：

• 简洁易用：用Python代码替代冗长的命令行指令
• 类型安全：提供完整的类型注解，减少开发错误
• 功能完备：支持Docker Compose v2的所有核心功能
• 灵活配置：通过代码轻松管理多个compose文件和环境变量

快速上手：安装与基本配置

要开始使用Python-on-Whales，首先需要安装该库。建议使用pip进行安装：

pip install python-on-whales

安装完成后，您可以通过创建DockerClient实例来配置Compose环境：

from python_on_whales import DockerClient # 基本配置 docker = DockerClient( compose_files=["docker-compose.yml"], compose_project_name="my_project", compose_env_files=[".env"] )

常用Docker Compose操作示例

1. 构建并启动服务

传统命令：

docker compose up -d --build

Python-on-Whales代码：

# 构建服务 docker.compose.build() # 启动服务（后台运行） docker.compose.up(detach=True)

您还可以指定要构建的服务和构建参数：

docker.compose.build( services=["web", "db"], build_args={"PYTHON_VERSION": "3.9"}, cache=False )

2. 查看运行状态

传统命令：

docker compose ps

Python-on-Whales代码：

# 获取所有运行中的容器 containers = docker.compose.ps() for container in containers: print(f"服务: {container.name}, 状态: {container.state.status}")

3. 查看服务日志

传统命令：

docker compose logs -f web

Python-on-Whales代码：

# 实时获取web服务日志 for log in docker.compose.logs(services=["web"], stream=True): print(log)

4. 停止并清理服务

传统命令：

docker compose down -v --rmi all

Python-on-Whales代码：

# 停止服务并清理卷和镜像 docker.compose.down( volumes=True, remove_images="all" )

高级功能：服务扩展与依赖管理

Python-on-Whales提供了丰富的API来管理服务扩展和依赖关系：

# 扩展服务实例数量 docker.compose.up( services=["web"], scales={"web": 3}, detach=True ) # 构建服务及其依赖 docker.compose.build( services=["web"], with_dependencies=True )

项目结构与资源

Python-on-Whales的Compose功能主要实现于以下模块：

• 核心实现：python_on_whales/components/compose/cli_wrapper.py
• 数据模型：python_on_whales/components/compose/models.py
• 官方文档：docs/template/sub-commands/compose.md

总结

Python-on-Whales彻底改变了Docker Compose的使用方式，让容器化应用管理变得更加直观和高效。无论是简单的服务启停，还是复杂的构建部署流程，都可以通过简洁的Python代码完成。对于希望简化DevOps流程、提高开发效率的团队和个人来说，Python-on-Whales无疑是一个值得尝试的强大工具。

要获取更多信息和完整的API文档，请克隆项目仓库进行探索：

git clone https://gitcode.com/gh_mirrors/py/python-on-whales

开始您的Python-on-Whales之旅，体验前所未有的Docker Compose操作便捷性！ 🐳🐍

【免费下载链接】python-on-whalesAn awesome Python wrapper for an awesome Docker CLI!项目地址: https://gitcode.com/gh_mirrors/py/python-on-whales