本文介绍如何使用 pexpect 在 python 中创建可复用的交互式 bash 会话对象，实现在多次调用间保持工作目录、环境变量等上下文，同时实时打印命令输出并完整返回结果。
本文介绍如何使用 `pexpect` 在 python 中创建可复用的交互式 bash 会话对象，实现在多次调用间保持工作目录、环境变量等上下文，同时实时打印命令输出并完整返回结果。
在 Python 中通过 subprocess 启动独立的 bash -c 进程虽能快速执行单条命令，但无法跨调用维持 shell 上下文（如 cd 切换的路径、导出的变量、别名定义等）。直接尝试用 Popen([‘bash’]) + stdin.write() 的方式常导致死锁——根本原因在于：交互式 bash 需要完整的 TTY 行为支持（如行缓冲、提示符等待、信号处理），而裸 pipe 不提供终端语义，导致 readline() 永远阻塞或 expect 无法同步状态。
pexpect 是专为解决此类问题设计的成熟库：它模拟伪终端（PTY），真实复现用户与交互式 shell 的交互流程，天然支持上下文延续、实时输出、命令结果捕获三者统一。
以下是一个生产就绪的 BashSession 类实现：
#!/usr/bin/env python3 import pexpect import sys import time from typing import Optional, List, Union class BashSession: def __init__( self, prompt_regex: str = r"[$#] $", # 匹配常见提示符（$ 或 # 后跟空格） timeout: float = 30.0, encoding: str = "utf-8", logfile=sys.stdout, ): """ 初始化一个持久化的交互式 Bash 会话。 :param prompt_regex: 用于识别命令结束的提示符正则表达式 :param timeout: expect 超时时间（秒） :param encoding: 字符编码 :param logfile: 实时输出目标（设为 None 可禁用屏幕打印） """ self.child = pexpect.spawn( "bash -i", # -i 确保进入交互模式 encoding=encoding, timeout=timeout, logfile=logfile if logfile else None, ) self.prompt = prompt_regex self.timeout = timeout # 等待初始提示符出现，确保会话就绪 try: self.child.expect(self.prompt) except pexpect.TIMEOUT: raise RuntimeError("Failed to start interactive bash session") def run(self, command: str) -> str: """ 执行一条命令，返回其完整输出（不含提示符和命令本身）。 :param command: 要执行的 Bash 命令字符串 :return: 命令的标准输出内容（已去除提示符和命令回显） """ self.child.sendline(command) # 匹配命令执行完毕后的下一个提示符 self.child.expect(self.prompt) # 获取从上一个提示符到当前提示符之间的所有输出 output = self.child.before.strip() # 清理可能混入的 ANSI 转义序列（可选） import re output = re.sub(r"x1b[[0-9;]*m", "", output) # 基础 ANSI 清洗 return output def close(self): """安全关闭会话，释放资源""" if self.child and self.child.isalive(): self.child.sendline("exit") self.child.close() self.child = None def __enter__(self): return self def __exit__(self, exc_type, exc_val, exc_tb): self.close()使用示例
# 方式1：手动管理生命周期 session = BashSession() try: print("当前目录：", session.run("pwd")) session.run("cd /tmp") # 此后上下文保留 print("切换后：", session.run("pwd")) # 输出 /tmp print("临时文件：", session.run("mktemp")) finally: session.close() # 方式2：推荐 —— 使用上下文管理器（自动清理） with BashSession() as s: s.run("export MY_VAR=hello") print("环境变量：", s.run("echo $MY_VAR")) # 输出 hello print("历史命令数：", s.run("history | wc -l")) # 退出 with 块时自动调用 close()关键注意事项
- ✅ 必须使用 bash -i：-i（interactive）标志是启用提示符、历史、作业控制的前提；仅 bash 会降级为非交互模式，导致 expect(PROMPT) 失败。
- ✅ 提示符正则需覆盖实际环境：默认 r”[$#] $” 适配大多数 linux/macos，默认提示符如 user@host:~$ 或 bash-5.2$。若自定义 PS1，请同步更新 prompt_regex。
- ⚠️ 避免 sendline() 后立即 read()：pexpect 的 before/after 属性已封装了安全读取逻辑，直接操作 child.read*() 易破坏状态同步。
- ⚠️ 超时设置合理：长时间运行命令（如 sleep 60）需增大 timeout 参数，否则 expect() 抛异常。
- ? 线程不安全：BashSession 实例不可被多线程共享；如需并发，应为每个线程创建独立实例。
替代方案对比（为何不用纯 subprocess？）
| 方案 | 维持上下文 | 实时输出 | 返回结果 | 实现复杂度 | 推荐度 |
|---|---|---|---|---|---|
| subprocess.Popen([‘bash’, ‘-c’, cmd]) | ❌（每次新进程） | ✅（需 stdout=PIPE + 循环读） | ✅ | 低 | ⚠️ 仅适合单次命令 |
| subprocess.Popen([‘bash’]) + stdin.write() | ⚠️（理论可行但极易死锁） | ⚠️（需复杂流控） | ⚠️（难以界定输出边界） | 高（需处理 EOF/flush/缓冲） | ❌ 不推荐 |
| pexpect.spawn(“bash -i”) | ✅（PTY 完整模拟） | ✅（logfile 直接绑定 stdout） | ✅（before 精确截取） | 中（依赖第三方库） | ✅ 生产首选 |
? 提示：首次使用前请安装依赖：pip install pexpect。在容器或无 TTY 环境中，pexpect 仍能通过内核 PTY 支持正常工作，无需真实终端。
立即学习“Python免费学习笔记（深入）”；
通过 BashSession，你获得的不再是一个命令执行器，而是一个可编程的、有状态的 Bash 环境代理——它让 Python 真正成为 shell 自动化的控制中枢。