Python子进程输出时间戳：利用Pexpect和Logging实现高效日志记录

pip install pexpect

import logging
import pexpect
import sys

# 1. 配置日志系统
# 设置日志的基本配置：
# - filename: 日志将写入的文件名。
# - encoding: 文件编码。
# - format: 日志消息的格式。'%(asctime)s' 会自动添加时间戳。
#           '%(levelname)-8s' 添加日志级别，并左对齐占用8个字符。
#           '%(message)s' 添加实际的日志内容。
# - level: 设置最低的日志级别，只有达到或高于此级别的消息才会被记录。
logging.basicConfig(
    filename='subprocess_output.log',  # 将日志输出到文件
    encoding='utf-8',
    format='%(asctime)s %(levelname)-8s %(message)s',
    level=logging.INFO  # 记录INFO级别及以上的消息
)

# 也可以配置同时输出到控制台，方便实时查看
# console_handler = logging.StreamHandler(sys.stdout)
# console_handler.setFormatter(logging.Formatter('%(asctime)s %(message)s'))
# logging.getLogger().addHandler(console_handler)


def run_command_and_log_output(command: str):
    """
    运行指定的shell命令，并将其每行输出通过logging模块记录，自动添加时间戳。

    Args:
        command (str): 要执行的shell命令字符串。
    """
    logging.info(f"--- 正在执行命令: {command} ---")
    process = None
    try:
        # 2. 使用pexpect.spawn启动子进程
        # pexpect.spawn() 接收一个命令字符串，它会像在终端中一样执行该命令。
        # encoding="utf-8" 确保正确处理输出字符编码。
        process = pexpect.spawn(command, encoding="utf-8", timeout=3600) # 设置超时时间，防止无限等待

        # 3. 逐行读取子进程输出并记录
        while True:
            try:
                # readline() 方法读取一行输出，直到遇到换行符或EOF。
                # 如果没有更多行，它会返回一个空字符串。
                line = process.readline()
                if not line:  # 遇到EOF (End Of File)，表示子进程输出结束
                    break
                # 使用strip()去除行尾的换行符，避免日志中出现多余空行
                logging.info(line.strip())
            except pexpect.exceptions.TIMEOUT:
                # 处理超时异常
                logging.warning(f"命令 '{command}' 执行超时，可能仍在运行或已挂起。")
                break # 退出循环，或根据需要进行其他处理
            except pexpect.exceptions.EOF:
                # 处理EOF异常，通常表示进程已结束
                logging.info(f"命令 '{command}' 输出已结束 (EOF)。")
                break
            except Exception as e:
                # 捕获其他可能的异常
                logging.error(f"处理命令 '{command}' 输出时发生错误: {e}")
                break

        # 4. 获取子进程的退出状态
        process.close() # 关闭pexpect进程对象，释放资源
        if process.exitstatus is not None:
            logging.info(f"命令 '{command}' 已完成，退出状态码: {process.exitstatus}")
        elif process.signalstatus is not None:
            logging.warning(f"命令 '{command}' 被信号 {process.signalstatus} 终止。")

    except pexpect.exceptions.ExceptionPexpect as e:
        # 捕获pexpect特有的异常，例如命令找不到等
        logging.error(f"启动命令 '{command}' 时发生Pexpect错误: {e}")
    except Exception as e:
        # 捕获其他通用异常
        logging.error(f"执行命令 '{command}' 时发生未知错误: {e}")
    finally:
        if process and process.isalive():
            # 确保进程被终止，防止僵尸进程
            process.terminate()
            logging.warning(f"命令 '{command}' 在清理阶段被强制终止。")
        logging.info(f"--- 命令 '{command}' 执行结束 ---")


# 示例用法
if __name__ == "__main__":
    print("日志将输出到 'subprocess_output.log' 文件中。")
    print("请查看该文件以获取带时间戳的输出。")

    # 示例1: 简单的ls命令
    run_command_and_log_output("ls -l")

    # 示例2: 模拟一个长时间运行的命令
    # (在Unix/Linux上运行，Windows上可能需要不同的命令，如 ping -n 5 127.0.0.1)
    run_command_and_log_output("sh -c 'for i in $(seq 1 3); do echo \"Line $i from long running task\"; sleep 1; done'")

    # 示例3: 原始问题中提到的docker build命令（假设docker已安装并配置）
    # run_command_and_log_output("docker build .")

    # 示例4: 一个不存在的命令，用于测试错误处理
    run_command_and_log_output("this_command_does_not_exist_12345")