python学习之subprocess模块详解

subprocess功能：创建子进程，并连接他的输入、输出和错误管道，获取其返回状态（可以在python代码中执行操作系统级别的命令）

1. subprocess.run()

功能：执行args参数所表示的命令，等待命令结束，并返回一个CompletedProcess类型对象

1.1. 参数介绍

subprocess.run(args,*,stdin=None,input=None,stdout=None,stderr=None,shell=False,timeout=None,check=False,encoding=None,errors=None)

• args：表示要执行的命令，必须是字符串或字符串参数列表
• Stdin, stdout, stderr：子进程的标准输入、输出和错误，其值可以是subprocess.PIPE, subporcess.DEVNULL, 一个已经存在的文件描述符、已经打开的文件对象或者None
• timeout：设置命令超时时间，若超时，子进程将被杀死，并弹出TimeoutExpired异常
• check：若该参数设为true，且进程退出状态码不是0，则弹出CalledProcessError异常
• encoding：若指定了该参数，则stdin,stdout,stderr可以接收字符串数据，并以该编码方式编码，否则只能接收bytes类型的数据
• shell：若该参数为True，将通过操作系统的shell执行指定命令

1.1.1 subprocess.CompletedProcess

run()的返回值，表示一个进程结束了。CompletedProcess类有下面这些属性

• args：启动进程的参数，通常是一个列表或字符串
• returncode：进程结束状态返回码，0表示成功状态
• stdout：获取子进程的stdout，通常为bytes类型序列，None表示没有捕获值。
• stderr：获取子进程的错误信息，通常为bytes类型序列，None表示没有捕获值
• check_returncode()：检查返回码，若返回状态码不为0，弹出calledProcessError异常

1.1.2 subprocess.DEVNULL

特殊值，用于传递给stdout, stdin和stderr参数

1.1.3 subprocess.PIPE

管道，可传递给stdout, stdin, stderr参数

1.1.4 subprocess.STDOUT

特殊值，可传递给stderr参数，表示stdout和stderr合并输出，可以使用read(), readline(), readlines()等方法

1.1.5 args与shell

• args参数可以接收一个字符串，也可以传递字符串分割列表
• shell参数默认为False，设置为True的时候表示使用操作系统的shell执行命令，当args为字符串时，必须指定shell=True；当args是个列表的时候，shell保持默认的False

1.2. 获取执行结果

run()方法返回的是一个completedProcess类型对象，而非执行结果。如果要获取命令执行的结果或信息，在调用run()方法的时候，需要指定stdout=sunprocess.PIPE，结果将会以bytes类型保存在stdout属性中

1.2.1. 交互式输入

run()方法的stdin参数可以接收一个文件句柄，如下

import subprocess
file=open("d:\\1.txt")
ret=subprocess.run('python',stdin=file,stdout=subprocess.PIPE,shell=True)
print(ret.stdout)

2. subprocess.Popen()

其用法和参数与run()基本类同，可创建和管理子进程，但是它的返回值是一个Popen对象，而不是CompletedProcess对象

2.1 参数介绍

class subprocess.Popen(args, bufsize=-1, executable=None, stdin=None, stdout=None, stderr=None, preexec_fn=None, close_fds=True, shell=False, cwd=None, env=None, universal_newlines=False, startupinfo=None, creationflags=0,restore_signals=True, start_new_session=False, pass_fds=(), *, encoding=None, errors=None)

• args：shell命令，可以是字符串或者字符序列
• bufsize：缓冲区大小，默认-1，用于创建标准流的管道对象
  • 0：不使用缓冲区
  • 1：表示行缓冲，仅当universal_newlines=True时可用，即文本模式
  • 正数：表示缓冲区大小
  • 负数：表示使用系统默认的缓冲区大小。
• stdin, stdout, stderr：分别表示程序的标准输入、输出、错误句柄
• preexec_fn：只在 Unix 平台下有效，用于指定一个可执行对象（callable object），它将在子进程运行之前被调用
• shell：如果该参数为 True，将通过操作系统的 shell 执行指定的命令。
• cwd：用于设置子进程的当前目录。
• env：用于指定子进程的环境变量。如果 env = None，子进程的环境变量将从父进程中继承。

2.1.1 subprocess.Popen可调用的方法

• poll()：检查进程是否终止
• wait()：等待子进程终止
• communicate(input, timeout)：和子进程交互，发送和读取数据
  • input的数据类型必须是字节串，若universal_newlines=True，则input参数的数据类型必须是字符串
  • 该方法返回一个元组(stdout_data, stderr_data)，字节串或字符串
  • timeout指定的秒数后该进程还没结束，将会抛出TimeoutExpired异常
• send_signal(signal)：发送信号到子进程
• terminate()：停止子进程，即发送SIGTERM信号到子进程
• kill()：杀死子进程，发送SIGKILL

2.2 实例

Popen对象的stdin, stdout, stderr是三个文件句柄，可以像文件那样读写，通过subprocess.stdin.write()可以输入数据，subprocess.Popen().stdout.read()可以输出数据

import subprocess
s=subprocess.Popen('python3',stdout=subprocess.PIPE,stdin=subprocess.PIPE,shell=True)
s.stdin.write(b'import os\n')
s.stdin.write(b'print(os.environ)')
s.stdin.close()

3. subprocess常用函数

附：python subprocess.run() 执行py脚本并等待该脚本执行完成

要使用 subprocess.run() 执行 Python 脚本并等待脚本执行完成，可以按照以下方式进行：

import subprocess

# 脚本的文件路径
script_path = "/path/to/your/script.py"

# 使用 subprocess.run() 执行脚本
subprocess.run(["python", script_path], capture_output=True, text=True)

# 程序会在这里等待脚本执行完成

在上述代码中：

• "python" 是要执行的命令。
• [script_path] 是命令的参数，即你要执行的Python脚本的路径。
• capture_output=True 参数表示捕获子进程的标准输出和标准错误流。返回的结果将会是一个 CompletedProcess 对象，其 stdout 和 stderr 属性分别包含标准输出和标准错误的内容。
• text=True 参数表示将捕获的输出以文本形式返回（在Python 3.7及以上版本有效）。

subprocess.run() 会阻塞当前进程，直到被调用的命令执行完成。执行完成后，程序才会继续执行后续的代码。如果你不想捕获输出，可以去掉 capture_output 参数。

总结 

到此这篇关于python学习之subprocess模块详解的文章就介绍到这了,更多相关python之subprocess模块内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！