Python pexpect 模块日志记录的三种实现方式

使用 child.logfile 属性记录日志

在 pexpect 模块中，最直接的日志记录方式是利用 spawn 对象的 logfile 属性。该属性允许开发者指定一个文件对象，pexpect 会自动将子进程的所有输出写入该文件。这种方法代码简洁，且无需修改标准输出流。

实现时需要注意文件的打开模式。由于 pexpect 内部处理的是字节流，因此必须以二进制追加模式（'ab'）打开日志文件。若使用文本模式，可能会引发类型错误。

#!/usr/bin/env python
import pexpect
import sys

host="146.11.85.xxx"
user="inteuser"
password="xxxx"
command="ls -l"

# 启动子进程
child = pexpect.spawn('ssh -l %s %s %s'%(user, host, command))

# 等待密码提示并发送密码
child.expect('password:')
child.sendline(password)

# 指定日志文件，必须使用二进制追加模式
childlog = open('promp.log',"ab") 
child.logfile = childlog

# 等待进程结束，使用 pexpect.EOF 避免子进程结束后继续 expect 报错
child.expect(pexpect.EOF)

# 关闭日志文件
childlog.close()

重定向 sys.stdout 记录日志

另一种常见的需求是将子进程的输出重定向到标准输出，以便在控制台查看或记录。可以通过临时替换 sys.stdout 对象来实现。这种方式适合需要同时看到控制台输出和文件记录的场景，但操作相对复杂，需要手动备份和恢复标准输出。

在此方案中，日志文件必须以文本模式（'w'）打开。因为后续通过 print 语句输出的是字符串，若文件以二进制模式打开，Python 会抛出 TypeError: a bytes-like object is required, not 'str' 错误。此外，子进程结束后的输出需要通过 child.before 获取，并可能需要使用 decode() 进行格式化。

#!/usr/bin/env python
import pexpect
import sys

host="146.11.85.xxx"
user="inteuser"
password="xxxx"
command="ls -l"

# 启动子进程
child = pexpect.spawn('ssh -l %s %s %s'%(user, host, command))

# 等待密码提示并发送密码
child.expect('password:')
child.sendline(password)

# 备份当前标准输出
__console__ = sys.stdout 

# 打开日志文件，使用文本模式
childlog = open('promp.log',"w") 

# 将标准输出重定向到日志文件
sys.stdout = childlog   

# 等待进程结束
child.expect(pexpect.EOF)

# 打印子进程的输出，注意可能需要解码
print(child.before.decode()) 

# 关闭日志文件
childlog.close()

# 恢复标准输出为命令行
sys.stdout = __console__

将 Log 打印到文件

除了上述两种 pexpect 内置或标准库支持的方式，开发者也可以选择在代码中显式地将 print 语句的输出重定向到文件。这与重定向 sys.stdout 的原理类似，但更侧重于手动控制打印时机。这种方式灵活性高，可以精确控制哪些信息需要被记录，但需要开发者手动管理文件句柄和标准输出的状态。

总结

在 Python 中使用 pexpect 进行自动化测试或交互时，日志记录是调试和审计的关键环节。选择 logfile 属性适合简单的字节流记录；重定向 sys.stdout 适合需要混合控制台输出和文件记录的复杂场景；而显式打印到文件则提供了最大的灵活性。开发者应根据具体的文件编码要求（二进制 vs 文本）和操作复杂度，选择最适合当前项目的方案。

以上就是对Python pexpect模块取log的几种方式小结的详细内容，更多关于Python pexpect日志记录的资料请关注本站其它相关文章！