subprocess的popen函数

Posted 2023-03-18

参考技术A subprocess的进程创建和管理由Popen类处理。原型： （原型中参数带有的值都是默认值）

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=None ,  startupinfo=None ,  creationflags=0 ,  restore_signals=True ,  start_new_session=False ,  pass_fds=() ,  * ,  group=None ,  extra_groups=None ,  user=None ,  umask=-1 ,  encoding=None ,  errors=None ,  text=None )

args参数： 一个需要运行的参数序列；默认情况下，如果args是序列，则运行的程序是这个序列中的第一项，比如[“python”，“--version”]，运行的cmd就是这个列表中的第一项python；但是如果args是字符串，具体如何实现依赖于具体平台。如果在Windows 上  shell  为 False 并且序列包含字节串和路径类对象则  args  形参可以接受一个  path-like object 。 参数  shell  （默认为 False）指定是否使用 shell 执行程序。如果  shell  为 True，更推荐将  args  作为字符串传递而非序列。 如果  args  是一个字符串，则字符串的格式必须和在命令行中所输出的完全相同。在 Windows，使用  shell=True，环境变量 COMSPEC 指定了默认 shell。在 Windows 唯一需要指定 shell=True 的情况是想要执行内置在 shell 中的命令（例如  dir  或者  copy ）。在运行一个批处理文件或者基于控制台的可执行文件时，不需要 shell=True。

def cmd_run(cmd):

    print("the cmd is ".format(cmd))

   subproc = subprocess.Popen(cmd, stdin=subprocess.PIPE, stdout=subprocess.PIPE, stderr=subprocess.STDOUT, universal_newlines=True, creationflags=subprocess.CREATE_NEW_PROCESS_GROUP, shell=True ) #设置shell为true

    while True:

        out = subproc.stdout.readline()

        if out:

            print(out)

        else:

            break

cmd_run("dir")

输出：

如果没有设置shell为True，则在windows上无法运行这个cmd。

executable  参数 指定一个要执行的替换程序，比较少用到这个参数。当 shell=True，  executable  替换  args  指定运行的程序。但是，原始的  args  仍然被传递给程序。

在 3.6 版更改: 在POSIX 上  executable  形参可以接受一个  path-like object 。

在 3.8 版更改: 在Windows 上  executable  形参可以接受一个字节串和  path-like object 。

stdin ,  stdout  和  stderr  分别指定被运行的程序的标准输入、输出和标准错误的文件句柄。合法的值有  PIPE  ，  DEVNULL  ， 一个存在的文件描述符（一个正整数），一个存在的  文件对象  以及 None。  PIPE  表示应创建一个新的对子进程的管道。  DEVNULL  表示使用特殊的  os.devnull  文件。使用默认的 None，则不进行成定向；子进程的文件流将继承自父进程。另外，  stderr  可设为  STDOUT ，表示应用程序的标准错误数据应和标准输出一同捕获。

如果  close_fds  为真 ，所有文件描述符除了 0, 1, 2 之外都会在子进程执行前关闭。而当  close_fds  为假时，文件描述符遵守它们继承的标志如  文件描述符的继承  所述。在 Windows，如果  close_fds  为真， 则子进程不会继承任何句柄，除非在  STARTUPINFO.IpAttributeList 的  handle_list的键中显式传递，或者通过标准句柄重定向传递。

如果  cwd  不为 None，此函数在执行子进程前会将当前工作目录改为  cwd 。  cwd  可以是一个字符串、字节串或  路径类对象  。 特别地，当可执行文件的路径为相对路径时，此函数会相对于*cwd* 来查找  executable  (或  args  中的第一个条目)。

在 3.6 版更改: 在 POSIX 上  cwd  形参接受一个  path-like object 。

在 3.7 版更改: 在 Windows 上  cwd  形参接受一个  path-like object 。

在 3.8 版更改: 在 Windows 上  cwd  形参接受一个字节串对象。

如果  encoding  或  errors  被指定，或者  text  为 true，则文件对象  stdin ,  stdout  和  stderr  将会以指定的编码和  errors  以文本模式打开 ，如同  常用参数  所述。 

universal_newlines  参数 等同于  text  并且提供向后兼容性。默认情况下，文件对象都以二进制模式打开。

如果给出，   startupinfo  将是一个将被传递给底层的 CreateProcess 函数的  STARTUPINFO  对象。

creationflags ，如果给出，可以是一个或多个以下标志之一：

CREATE_NEW_CONSOLE

CREATE_NEW_PROCESS_GROUP

ABOVE_NORMAL_PRIORITY_CLASS

BELOW_NORMAL_PRIORITY_CLASS

HIGH_PRIORITY_CLASS

IDLE_PRIORITY_CLASS

NORMAL_PRIORITY_CLASS

REALTIME_PRIORITY_CLASS

CREATE_NO_WINDOW

DETACHED_PROCESS

CREATE_DEFAULT_ERROR_MODE

CREATE_BREAKAWAY_FROM_JOB

Popen 对象支持通过  with  语句作为上下文管理器，在退出时关闭文件描述符并等待进程:。

在 3.6 版更改: 现在，如果 Popen 析构时子进程仍然在运行，则析构器会发送一个  ResourceWarning  警告。

在 3.8 版更改: 在某些情况下 Popen 可以使用  os.posix_spawn()  以获得更好的性能。在适用于 Linux 的 Windows 子系统和 QEMU 用户模拟器上，使用  os.posix_spawn()  的 Popen 构造器不再会因找不到程序等错误而引发异常，而是上下级进程失败并返回一个非零的  returncode 。

异常

在子进程中抛出的异常，在新的进程开始执行前，将会被再次在父进程中抛出。

最常见的被抛出异常是  OSError 。例如，当尝试执行一个不存在的文件时就会发生。应用程序需要为  OSError  异常做好保护。

如果  Popen  调用时有无效的参数，则一个  ValueError  将被抛出 。

check_all() 与  check_output()  在调用的进程返回非零退出码时将 抛出  CalledProcessError 。

所有接受  timeout  形参的函数与方法，例如  call()  和  Popen.communicate()  将会在进程退出前超时到期时 抛出  TimeoutExpired 。

此模块中定义的异常都继承自  SubprocessError 。