subprocess.run函数介绍

前言subprocess.run 是 Python 3.5 引入的函数也是目前官方最推荐的用于执行外部命令如 Shell 命令、系统脚本、其他程序的方法。官方文档明确建议在大多数情况下应该优先使用 subprocess.run()而不是旧的 os.system、subprocess.Popen 或subprocess.check_output。 它就像一个“全能瑞士军刀”功能强大且用法灵活。示例importsubprocessdefrun_hive_query(cmd):try:# 执行命令捕获输出转为文本并要求失败时报错resultsubprocess.run(cmd,capture_outputTrue,textTrue,checkTrue,timeout3600# 设置 1 小时超时)# 如果成功返回标准输出returnresult.stdout.strip()exceptsubprocess.CalledProcessErrorase:# 如果 checkTrue 触发了异常可以分别拿到 stdout 和 stderrerror_msge.stderr.strip()ife.stderrelse未知错误raiseException(f命令执行失败 (返回码{e.returncode}):{error_msg})exceptsubprocess.TimeoutExpiredase:raiseException(f命令执行超时)核心参数详解subprocess.run 之所以全能是因为它有几个非常实用的参数1.capture_outputTrue: 同时捕获标准输出stdout和标准错误stderr。Python 3.7 引入以前的写法是stdoutsubprocess.PIPE,stderrsubprocess.PIPE。2.textTrue (或 encoding‘utf-8’): 将输入/输出作为字符串处理而不是字节bytes。3.checkTrue: 非常重要 默认情况下run 遇到命令执行失败返回码非0不会报错只会默默返回一个非0的 returncode。如果加上 checkTrue一旦命令失败它会自动抛出 subprocess.CalledProcessError 异常这就和 check_output 的行为一样了。4.timeoutN: 设置超时时间秒。如果命令执行超过 N 秒还没结束会抛出TimeoutExpired 异常。防止程序卡死。5.shellTrue: 允许你直接传入一个完整的字符串命令比如 “ls -l | grep txt”而不是列表。警告 除非必要尽量少用如果字符串里包含用户输入会有严重的安全漏洞Shell 注入。核心返回值CompletedProcess 对象subprocess.run 执行完毕后会返回一个 CompletedProcess 对象。这个对象包含了命令执行的所有关键信息result.returncode: 退出状态码0 通常表示成功非 0 表示失败。result.stdout: 标准输出的内容需要配合 capture_outputTrue 使用。result.stderr: 标准错误的内容需要配合 capture_outputTrue 使用。result.args: 你原本传递进去的命令subprocess.check_output和subprocess.run的区别run 是 Python 3.5 之后引入的“全能瑞士军刀”而 check_output 是一个专门为了“获取输出”而存在的快捷函数。以下是具体的区别对比返回值不同 (最直观的区别)subprocess.run返回一个 CompletedProcess 对象。这个对象包含了命令执行的所有信息比如返回码 (returncode)、标准输出 (stdout)、标准错误 (stderr)。你需要通过 .stdout 属性才能拿到具体的输出内容。subprocess.check_output直接返回命令的标准输出内容字符串或字节串。默认的错误处理方式不同subprocess.run默认情况下如果外部命令执行失败返回码非 0它不会报错而是正常返回一个 CompletedProcess 对象只是里面的 returncode 不是 0。如果你想让它报错必须手动加上 checkTrue 参数。subprocess.check_output顾名思义带有 check如果命令执行失败它一定会抛出 subprocess.CalledProcessError 异常。importsubprocess# 直接拿到字符串结果如果失败会自动抛出异常result_textsubprocess.check_output([echo,hello],textTrue)print(result_text)# 需要指定 capture_outputTrue 才会捕获输出# 需要指定 checkTrue 才会像 check_output 一样在失败时报错# 最后需要加上 .stdout 才能拿到具体的文本resultsubprocess.run([echo,hello],capture_outputTrue,textTrue,checkTrue)result_textresult.stdoutprint(result_text)