subprocess实用手册

Posted 2022-06-14 jwentest

背景

python执行操作系统的命令，如python执行shell命令

subprocess模块主要用于创建子进程，并连接它们的输入、输出和错误管道，获取它们的返回状态。通俗地说就是通过这个模块，你可以在Python的代码里执行操作系统级别的命令，比如“ipconfig”、“du -sh”等等。

 

操作

引用

python自带subprocess包，直接import引入即可

import subprocess

 

常用方法

需要注意2.X版本和3.X版本

3.X版本

推荐使用run方法，3.5版本才新增该方法

大多数情况下，推荐使用run()方法调用子进程，执行操作系统命令。在更高级的使用场景，你还可以使用Popen接口。其实run()方法在底层调用的就是Popen接口。

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

args：表示要执行的命令。必须是一个字符串，字符串参数列表。

stdin、stdout和stderr：子进程的标准输入、输出和错误。其值可以是subprocess.PIPE、subprocess.DEVNULL、一个已经存在的文件描述符、已经打开的文件对象或者None。subprocess.PIPE表示为子进程创建新的管道。subprocess.DEVNULL表示使用os.devnull。默认使用的是None，表示什么都不做。另外，stderr可以合并到stdout里一起输出。

timeout：设置命令超时时间。如果命令执行时间超时，子进程将被杀死，并弹出TimeoutExpired异常。

check：如果该参数设置为True，并且进程退出状态码不是0，则弹出CalledProcessError异常。

encoding:如果指定了该参数，则stdin、stdout和stderr可以接收字符串数据，并以该编码方式编码。否则只接收bytes类型的数据。

shell：如果该参数为True，将通过操作系统的shell执行指定的命令。

实际例子：

 

>>> subprocess.run(["ls", "-l"])  # 没有对输出进行捕获
CompletedProcess(args=[‘ls‘, ‘-l‘], returncode=0)

>>> subprocess.run("exit 1", shell=True, check=True)
Traceback (most recent call last):
  ...
subprocess.CalledProcessError: Command ‘exit 1‘ returned non-zero exit status 1

>>> subprocess.run(["ls", "-l", "/dev/null"], stdout=subprocess.PIPE)
CompletedProcess(args=[‘ls‘, ‘-l‘, ‘/dev/null‘], returncode=0,
stdout=b‘crw-rw-rw- 1 root root 1, 3 Jan 23 16:23 /dev/null\n‘)

>>> subprocess.run("python --version", stdout=subprocess.PIPE)
CompletedProcess(args=‘python --version‘, returncode=0, stdout=b‘Python 3.6.1\r\n‘)

>>>s= subprocess.run("ipconfig", stdout=subprocess.PIPE)    # 捕获输出
>>>print(s.stdout.decode("GBK"))

# 在windows上执行netstat，并打印返回
info = sp.run(["netstat","-ano"], shell=True, stdout=sp.PIPE)
print(info.stdout.decode("GBK"))

 

2.X版本

因为历史问题，实际项目中python还是2.X版本；没有run方法，因此要使用Popen方法

用法和参数与run()方法基本类同，但是它的返回值是一个Popen对象，而不是CompletedProcess对象。

实际例子：

 

ip_info = sp.Popen(["netstat","-ano"], shell=True, stdout=sp.PIPE)
print(ip_info.stdout.read().decode("GBK"))

 

call方法

执行命令，返回命令的结果和执行状态，0或者非0

 

>>> res = subprocess.call(["ls","-l"])
总用量 28
-rw-r--r-- 1 root root   0 6月 16 10:28 1
drwxr-xr-x 2 root root 4096 6月 22 17:48 _1748
-rw-------. 1 root root 1264 4月 28 20:51 anaconda-ks.cfg
drwxr-xr-x 2 root root 4096 5月 25 14:45 monitor
-rw-r--r-- 1 root root 13160 5月  9 13:36 npm-debug.log
# 命令执行状态
>>> res
0

 

 

参考文档

http://www.liujiangblog.com/course/python/55

http://www.manongjc.com/article/2405.html