各位观众，各位大佬，欢迎来到今天的“Docker SDK for Python：编程控制 Docker 容器与镜像”特别节目！我是你们的老朋友，今天就带大家一起玩转Docker的Python接口，让Docker像小猫一样听你的话！
第一幕：Docker SDK，你是我的眼！
首先，我们要明确一点，Docker SDK for Python 是什么？简单来说，它就是Python语言和Docker引擎之间的桥梁。有了它，你可以用Python代码来创建、启动、停止、删除容器，构建镜像，甚至管理Docker网络和卷！这简直就是给程序员量身定制的“Docker遥控器”啊！
为什么要用SDK呢？直接用命令行不好吗？当然可以！但是，想象一下，如果你要自动化部署几百个容器，或者根据业务逻辑动态调整容器配置，手动敲命令不得敲到手抽筋？这时候，SDK的优势就体现出来了：它可以让你用代码来描述你的部署逻辑，实现自动化、可维护和可扩展的Docker管理。
第二幕：安装与连接，建立爱的连接！
废话不多说，让我们开始实战！第一步，当然是安装docker这个Python包啦！
pip install docker安装完成后，我们就可以用Python代码连接到Docker守护进程了。最简单的方式是连接到本地的Docker守护进程：
import docker
client = docker.from_env()
print(client.version()) # 打印Docker版本信息，验证连接是否成功这段代码就像在说：“喂，Docker守护进程，我是你的Python小弟，快告诉我你的版本号！” 如果一切顺利，你会看到类似这样的输出：
{'Platform': {'Name': 'Docker Engine - Community'}, 'Components': [{'Name': 'Engine', 'Version': '24.0.5', 'Details': {'ApiVersion': '1.43', 'Arch': 'amd64', 'BuildTime': '2023-07-20T15:35:10.000000000+00:00', 'Experimental': 'false', 'GitCommit': '9238c88', 'GoVersion': 'go1.20.5', 'KernelVersion': '5.15.0-76-generic', 'MinAPIVersion': '1.12', 'Os': 'linux'}}], 'Version': '24.0.5', 'ApiVersion': '1.43', 'GitCommit': '9238c88', 'GoVersion': 'go1.20.5', 'Os': 'linux', 'Arch': 'amd64', 'KernelVersion': '5.15.0-76-generic', 'BuildTime': '2023-07-20T15:35:10.000000000+00:00'}如果你需要连接到远程的Docker守护进程，可以使用docker.DockerClient：
client = docker.DockerClient(base_url='tcp://your_docker_host:2375') # 将 your_docker_host 替换为你的 Docker 主机地址
print(client.version()) # 打印Docker版本信息，验证连接是否成功注意，远程连接需要确保Docker守护进程开启了远程访问，并且配置了正确的安全策略。否则，你会收到“连接被拒绝”之类的错误提示，就像被心仪的女神拒绝一样伤心。
第三幕：容器操作，我的容器我做主！
连接成功后，我们就可以开始操作容器了。
- 列出容器：
containers = client.containers.list(all=True) # all=True 显示所有容器，包括停止的容器
for container in containers:
print(f"Container ID: {container.id}, Name: {container.name}, Status: {container.status}")这段代码会列出所有容器的ID、名称和状态。就像点名一样，看看有哪些容器在你的掌控之中。
- 运行容器：
container = client.containers.run("ubuntu:latest", "echo hello world", detach=True) # detach=True 后台运行
print(f"Container ID: {container.id}")这段代码会创建一个基于ubuntu:latest镜像的容器，并在容器中执行echo hello world命令。detach=True表示容器在后台运行，不会阻塞你的Python代码。
- 停止容器：
container.stop()
print(f"Container {container.id} stopped.")- 启动容器：
container.start()
print(f"Container {container.id} started.")- 删除容器：
container.remove()
print(f"Container {container.id} removed.")这几个操作就像对容器进行开关机和清理，非常简单粗暴。
- 查看容器日志：
logs = container.logs(stream=True) #stream=True实时获取日志
for line in logs:
print(line.decode('utf-8'))这段代码可以实时获取容器的日志输出，就像在监控室里观察容器的运行情况。
- 在容器中执行命令：
result = container.exec_run("ls -l")
print(result.output.decode('utf-8'))这段代码可以在容器内部执行ls -l命令，并返回命令的输出结果。就像远程操控一样，你可以让容器帮你完成一些任务。
第四幕：镜像操作，打造专属镜像！
除了容器，镜像也是Docker的核心概念。用SDK，我们也能轻松管理镜像。
- 拉取镜像：
image = client.images.pull("nginx:latest")
print(f"Image ID: {image.id}")这段代码会从Docker Hub上拉取nginx:latest镜像。就像从应用商店下载应用一样，你可以轻松获取各种预先构建好的镜像。
- 构建镜像：
# 创建一个Dockerfile文件
with open('Dockerfile', 'w') as f:
f.write("""
FROM ubuntu:latest
RUN apt-get update && apt-get install -y python3
COPY . /app
WORKDIR /app
CMD ["python3", "my_script.py"]
""")
# 构建镜像
image, build_logs = client.images.build(path='.', tag='my_custom_image')
for line in build_logs:
if 'stream' in line:
print(line['stream'].strip())
print(f"Image ID: {image.id}")这段代码会根据当前目录下的Dockerfile文件构建一个名为my_custom_image的镜像。Dockerfile定义了镜像的构建步骤，就像菜谱一样，告诉Docker如何制作你的专属镜像。
- 推送镜像：
#需要先登录 Docker Hub
#docker login
client.images.push('your_docker_hub_username/my_custom_image', tag='latest')
print("Image pushed successfully.")这段代码会将你的镜像推送到Docker Hub上，与全世界分享你的成果。
- 删除镜像：
client.images.remove("my_custom_image")
print("Image removed.")第五幕：网络与卷，容器间的桥梁！
容器之间需要通信，数据需要持久化存储，这时候就需要网络和卷了。
- 创建网络：
network = client.networks.create("my_network", driver="bridge")
print(f"Network ID: {network.id}")这段代码会创建一个名为my_network的bridge网络。就像搭建一座桥梁，让容器可以互相访问。
- 连接容器到网络：
network.connect(container)
print(f"Container {container.id} connected to network {network.id}.")这段代码会将容器连接到my_network网络。就像让车辆驶上桥梁，实现容器间的通信。
- 创建卷：
volume = client.volumes.create("my_volume")
print(f"Volume name: {volume.name}")这段代码会创建一个名为my_volume的卷。就像创建一个硬盘，用于持久化存储容器的数据。
- 将卷挂载到容器：
container = client.containers.run("ubuntu:latest", "echo hello world", detach=True, volumes={
"my_volume": {'bind': '/data', 'mode': 'rw'} #将my_volume挂载到容器的/data目录，读写权限
})这段代码在运行容器时，将my_volume卷挂载到容器的/data目录下。就像将硬盘连接到电脑，让容器可以使用持久化存储。
第六幕：高级技巧，玩转 Docker 的奇技淫巧！
- 使用资源限制：
container = client.containers.run("ubuntu:latest", "stress --cpu 1", detach=True, mem_limit="1g", cpu_quota=50000) #限制内存 1G, CPU 配额 50%
print(f"Container ID: {container.id}")这段代码在运行容器时，限制了容器的内存使用量为1GB，CPU配额为50%。就像给容器戴上镣铐，防止它占用过多的资源。
- 使用健康检查：
healthcheck = {
"test": ["CMD", "curl", "-f", "http://localhost:80"], #检查 80 端口是否存活
"interval": 5, #每5秒检查一次
"timeout": 3, #超时时间 3秒
"retries": 3 #重试次数 3次
}
container = client.containers.run("nginx:latest", detach=True, ports={'80/tcp': 8080}, healthcheck=healthcheck)
print(f"Container ID: {container.id}")这段代码为容器配置了健康检查，定期检查容器的80端口是否存活。就像给容器配备了医生，及时发现并处理容器的健康问题。
- 使用 Docker Compose (通过 Python 编排):
虽然 Docker Compose 本身有 docker-compose.yml 文件，但是也可以通过 Python 来模拟 Compose 的行为，尽管可能需要更多手动操作。 更好的方式是直接使用 Python 的 subprocess 模块调用 docker-compose 命令。
import subprocess
def docker_compose_up(compose_file="docker-compose.yml"):
"""启动 Docker Compose 项目."""
try:
result = subprocess.run(["docker-compose", "-f", compose_file, "up", "-d"], capture_output=True, text=True, check=True)
print(result.stdout)
except subprocess.CalledProcessError as e:
print(f"Error running docker-compose up: {e.stderr}")
def docker_compose_down(compose_file="docker-compose.yml"):
"""停止 Docker Compose 项目."""
try:
result = subprocess.run(["docker-compose", "-f", compose_file, "down"], capture_output=True, text=True, check=True)
print(result.stdout)
except subprocess.CalledProcessError as e:
print(f"Error running docker-compose down: {e.stderr}")
# 示例用法
docker_compose_up()
# ... 一段时间后
docker_compose_down()这种方法允许你将 docker-compose 的管理集成到 Python 脚本中，虽然不如直接使用 Compose SDK 优雅，但对于简单的编排任务来说足够了。 未来可能会有专门的 Compose SDK for Python，但目前这是一种实用方法。
第七幕：错误处理，不怕BUG来敲门！
在使用Docker SDK的过程中，难免会遇到各种错误。比如，连接失败、镜像不存在、容器已经运行等等。为了保证程序的健壮性，我们需要做好错误处理。
try:
container = client.containers.run("nonexistent_image", "echo hello world", detach=True)
except docker.errors.ImageNotFound as e:
print(f"Error: Image not found - {e}")
except docker.errors.APIError as e:
print(f"Error: Docker API error - {e}")
except Exception as e:
print(f"An unexpected error occurred: {e}")
else:
print(f"Container ID: {container.id}")
finally:
# 无论是否发生异常，都执行清理操作
print("Cleanup complete.")这段代码使用了try...except...finally结构来捕获Docker SDK可能抛出的异常。docker.errors.ImageNotFound表示镜像不存在，docker.errors.APIError表示Docker API调用失败。finally块中的代码会在无论是否发生异常的情况下都会执行，可以用来做一些清理工作。
第八幕：总结与展望，Docker的未来不是梦！
今天，我们一起学习了Docker SDK for Python的基本用法，包括连接Docker守护进程、操作容器、管理镜像、配置网络和卷等等。虽然只是冰山一角，但相信你已经感受到了Docker SDK的强大之处。
| 功能 | 说明 |
|---|---|
| 连接 Docker | 使用 docker.from_env() 或 docker.DockerClient() 连接到本地或远程 Docker 守护进程。 |
| 容器操作 | 列出、运行、停止、启动、删除容器，查看容器日志，在容器中执行命令。 |
| 镜像操作 | 拉取、构建、推送、删除镜像。 |
| 网络与卷管理 | 创建、连接网络，创建、挂载卷。 |
| 资源限制与健康检查 | 限制容器的内存和 CPU 使用量，配置健康检查以监控容器状态。 |
| 错误处理 | 使用 try...except...finally 结构捕获 Docker SDK 可能抛出的异常。 |
未来，Docker在云计算、微服务、DevOps等领域将扮演越来越重要的角色。掌握Docker SDK，就相当于掌握了开启未来之门的钥匙。希望大家能够继续深入学习，将Docker技术应用到实际项目中，创造更多的价值！
感谢大家的观看，祝大家编程愉快，Bug少一点，代码多一点！再见！