Interactive Docker exec with docker-py-Python教程-PHP中文网

Interactive Docker exec with docker-py

本文详解如何使用 docker-py 实现真正的交互式 docker exec -it 功能，通过底层 socket 操作连接宿主机 stdin/stdout 与容器内进程的 I/O，解决 exec_run 默认非阻塞、不透传终端输入的问题。

本文详解如何使用 docker-py 实现真正的交互式 `docker exec -it` 功能，通过底层 socket 操作连接宿主机 stdin/stdout 与容器内进程的 i/o，解决 `exec_run` 默认非阻塞、不透传终端输入的问题。

要使用 docker-py 实现与 docker exec -it bash 完全等效的交互式终端体验，关键在于：不能依赖 exec_run(..., stdin=True, tty=True) 的返回值直接读写——它返回的是一个非阻塞、不可写（或需特殊处理）的 SocketIO 对象；必须访问其底层原始 socket 并手动管理 recv()/sendall()，同时启用多线程分别处理输入与输出流，以避免 I/O 阻塞导致交互卡死。

以下是一个完整、健壮的实现示例：

import docker
import threading
import queue
import sys

def interactive_exec(container_name: str, command: str = "bash", detach=False):
    client = docker.from_env()
    try:
        container = client.containers.get(container_name)
    except docker.errors.NotFound:
        print(f"❌ 容器 '{container_name}' 未找到")
        return

    # 启动 exec 会话，获取原始 socket（注意：必须指定 socket=True）
    exec_result = container.exec_run(
        cmd=command,
        stdin=True,
        tty=True,
        socket=True  # 关键：启用 socket 模式
    )

    # exec_run 返回 (exit_code, socket_io)，socket_io._sock 是底层 socket
    _, sock_io = exec_result
    sock = sock_io._sock

    # 使用队列解耦输入/输出线程，支持安全退出
    input_queue = queue.Queue()

    def read_output():
        """持续从容器读取 stdout/stderr，并打印到本地终端"""
        try:
            while True:
                # Docker exec socket 的响应前 8 字节是 header（含 stream type），需跳过
                raw = sock.recv(4096)
                if not raw:
                    break
                # 跳过 Docker 流头（8 字节），提取实际 payload
                payload = raw[8:]
                if payload:
                    sys.stdout.write(payload.decode('utf-8', errors='replace'))
                    sys.stdout.flush()
        except OSError:
            pass  # socket 关闭时正常退出

    def write_input():
        """从用户输入读取命令，发送至容器 stdin"""
        try:
            while True:
                cmd = input()  # 注意：此处阻塞在 stdin，但由独立线程执行
                if cmd == 'exit':
                    input_queue.put(None)  # 通知 reader 结束
                    break
                # 添加换行符并编码为字节
                cmd_bytes = (cmd + '\n').encode('utf-8')
                sock.sendall(cmd_bytes)
        except EOFError:
            pass

    # 启动读写线程
    reader_thread = threading.Thread(target=read_output, daemon=True)
    writer_thread = threading.Thread(target=write_input, daemon=True)

    reader_thread.start()
    writer_thread.start()

    # 等待用户输入 exit 或中断
    try:
        writer_thread.join()  # 等待输入线程结束（如用户输入 exit）
    except KeyboardInterrupt:
        print("\n⚠️  用户中断，正在退出...")
    finally:
        # 清理资源
        sock.close()
        reader_thread.join(timeout=1)

if __name__ == "__main__":
    # 替换为你的容器名（可通过 `docker ps --format "{{.Names}}"` 查看）
    interactive_exec("my-bash-container", "bash")

✅ 关键要点说明：

Docker Encyclopedia

Docker 文档优先工作流：针对 Docker 特定问题、故障排除、命令规划、镜像/构建、容器/运行时操作及 Compose 等

下载

socket=True 是启用交互式通信的前提，否则 exec_run 返回的是普通元组，无法获取 socket；
sock._sock 是真实可操作的底层 socket.socket 对象，recv() 和 sendall() 才能真正透传数据；
Docker exec socket 协议中，每帧前 8 字节为 header（含流类型、长度等），实际输出内容从第 9 字节开始，因此需切片 raw[8:]；
必须使用多线程：主线程无法同时阻塞在 input() 和 recv() 上，否则交互将完全停滞；
daemon=True 确保主程序退出时子线程自动终止，避免僵尸线程；
建议显式捕获 docker.errors.NotFound 等异常，提升鲁棒性。

⚠️ 注意事项：