当前位置：首页 > news >正文

subprocess模块

news 来源：原创 2024/11/14 13:09:31

subprocess模块允许你去创建一个新的进程让其执行另外的程序，并与它进行通信，获取标准的输入、标准输出、标准错误以及返回码等

subprocess模块（官方文档）

在Python 3.5之后的版本中，官方文档中提倡通过subprocess.run()函数替代其他函数来使用subproccess模块的功能。

函数	描述
subprocess.run()	Python 3.5中新增的函数。执行指定的命令，等待命令执行完成后返回一个包含执行结果的CompletedProcess类的实例。
subprocess.call()	执行指定的命令，返回命令执行状态，其功能类似于os.system(cmd)。
subprocess.check_call()	Python 2.5中新增的函数。执行指定的命令，如果执行成功则返回状态码，否则抛出异常。其功能等价于subprocess.run(…, check=True)。
subprocess.check_output()	Python 2.7中新增的的函数。执行指定的命令，如果执行状态码为0则返回命令执行结果，否则抛出异常。
subprocess.getoutput(cmd)	接收字符串格式的命令，执行命令并返回执行结果，其功能类似于os.popen(cmd).read()和commands.getoutput(cmd)。
subprocess.getstatusoutput(cmd)	执行cmd命令，返回一个元组(命令执行状态, 命令执行结果输出)，其功能类似于commands.getstatusoutput()。

run()

def run(*popenargs,
        input=None, capture_output=False, timeout=None, check=False, **kwargs):
    ...
    return CompletedProcess(process.args, retcode, stdout, stderr)

参数

popenargs：要执行的shell命令，默认应该是一个字符串序列，如[‘df’, ‘-Th’]或(‘df’, ‘-Th’)，也可以是一个字符串，如’df -Th’，但是此时需要把shell参数的值置为True。
shell：如果shell为True，那么指定的命令将通过shell执行。
check：如果check参数的值是True，且执行命令的进程以非0状态码退出，则会抛出一个CalledProcessError的异常，且该异常对象会包含参数、退出状态码、以及stdout和stderr。
stdout, stderr：input：该参数是传递给Popen.communicate()，通常该参数的值必须是一个字节序列，如果universal_newlines=True，则其值应该是一个字符串。
universal_newlines：该参数影响的是输入与输出的数据格式，比如它的值默认为False，此时stdout和stderr的输出是字节序列；当该参数的值设置为True时，stdout和stderr的输出是字符串。

CompletedProcess

表示的是一个已结束进程的状态信息

args：用于加载该进程的参数，这可能是一个列表或一个字符串
2/ returncode：子进程的退出状态码。通常情况下，退出状态码为0则表示进程成功运行了；一个负值-N表示这个子进程被信号N终止了
stdout：从子进程捕获的stdout。这通常是一个字节序列，如果run()函数被调用时指定universal_newlines=True，则该属性值是一个字符串。如果run()函数被调用时指定stderr=subprocess.STDOUT，那么stdout和stderr将会被整合到这一个属性中，且stderr将会为None
stderr：从子进程捕获的stderr。它的值与stdout一样，是一个字节序列或一个字符串。如果stderr没有被捕获的话，它的值就为None
check_returncode()：如果returncode是一个非0值，则该方法会抛出一个CalledProcessError异常。

subprocess.Popen

@overload
        def __new__(
            cls,
            args: _CMD,
            bufsize: int = ...,
            executable: Optional[AnyPath] = ...,
            stdin: Optional[_FILE] = ...,
            stdout: Optional[_FILE] = ...,
            stderr: Optional[_FILE] = ...,
            preexec_fn: Optional[Callable[[], Any]] = ...,
            close_fds: bool = ...,
            shell: bool = ...,
            cwd: Optional[AnyPath] = ...,
            env: Optional[_ENV] = ...,
            universal_newlines: bool = ...,
            startupinfo: Optional[Any] = ...,
            creationflags: int = ...,
            restore_signals: bool = ...,
            start_new_session: bool = ...,
            pass_fds: Any = ...,
            *,
            text: Optional[bool] = ...,
            encoding: str,
            errors: Optional[str] = ...,
        ) -> Popen[str]: ...

参数

args：要执行的shell命令，可以是字符串，也可以是命令各个参数组成的序列。当该参数的值是一个字符串时，该命令的解释过程是与平台相关的，因此通常建议将args参数作为一个序列传递。
bufsize：指定缓存策略，0表示不缓冲，1表示行缓冲，其他大于1的数字表示缓冲区大小，负数表示使用系统默认缓冲策略。
stdin, stdout, stderr：分别表示程序标准输入、输出、错误句柄。
preexec_fn：用于指定一个将在子进程运行之前被调用的可执行对象，只在Unix平台下有效。
close_fds：如果该参数的值为True，则除了0,1和2之外的所有文件描述符都将会在子进程执行之前被关闭。
shell：该参数用于标识是否使用shell作为要执行的程序，如果shell值为True，则建议将args参数作为一个字符串传递而不要作为一个序列传递。
cwd：如果该参数值不是None，则该函数将会在执行这个子进程之前改变当前工作目录。
env：用于指定子进程的环境变量，如果env=None，那么子进程的环境变量将从父进程中继承。如果env!=None，它的值必须是一个映射对象。
universal_newlines：如果该参数值为True，则该文件对象的stdin，stdout和stderr将会作为文本流被打开，否则他们将会被作为二进制流被打开。
startupinfo和creationflags：这两个参数只在Windows下有效，它们将被传递给底层的CreateProcess()函数，用于设置子进程的一些属性，如主窗口的外观，进程优先级等。

Popen 对象方法

with subprocess.Popen(["pwd"], shell=True, stderr=subprocess.PIPE, stdout=subprocess.PIPE) as process:
    pass

poll(): 检查进程是否终止，如果终止返回 returncode，否则返回 None。
wait(timeout): 等待子进程终止。
communicate(input,timeout): 和子进程交互，发送和读取数据。
send_signal(singnal): 发送信号到子进程。
terminate(): 停止子进程,也就是发送SIGTERM信号到子进程。
kill(): 杀死子进程。发送 SIGKILL 信号到子进程。

>>> obj = subprocess.Popen(["python"], stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.PIPE)
>>> out,err = obj.communicate(input="print(1)")
>>> print(out)
1

信号

SIGHUP 	终止进程 终端线路挂断
SIGINT 	终止进程 中断进程
SIGQUIT 	建立CORE文件终止进程，并且生成core文件
SIGILL 		建立CORE文件 非法指令
SIGTRAP 	建立CORE文件 跟踪自陷
SIGBUS 		建立CORE文件 总线错误
SIGSEGV 	建立CORE文件 段非法错误
SIGFPE 		建立CORE文件 浮点异常
SIGIOT 		建立CORE文件 执行I/O自陷
SIGKILL 		终止进程 杀死进程
SIGPIPE 		终止进程 向一个没有读进程的管道写数据
SIGALARM 	终止进程 计时器到时
SIGTERM 		终止进程 软件终止信号
SIGSTOP		停止进程     非终端来的停止信号
SIGTSTP   		停止进程     终端来的停止信号
SIGCONT   		忽略信号     继续执行一个停止的进程
SIGURG   		忽略信号     I/O紧急信号
SIGIO     			忽略信号     描述符上可以进行I/O
SIGCHLD   		忽略信号     当子进程停止或退出时通知父进程
SIGTTOU   		停止进程     后台进程写终端
SIGTTIN   		停止进程     后台进程读终端
SIGXGPU   		终止进程     CPU时限超时
SIGXFSZ   		终止进程     文件长度过长
SIGWINCH   	忽略信号     窗口大小发生变化
SIGPROF   		终止进程     统计分布图用计时器到时
SIGUSR1   		终止进程     用户定义信号1
SIGUSR2   		终止进程     用户定义信号2
SIGVTALRM 终止进程     虚拟计时器到时