发布于 2年前

Python3.5使用subprocess.run调用外部程序

Python 3.5的subprocess模块新增了run()函数,大部分调用子进程的场景都推荐使用run()函数,一些高级的用法则可以直接调用Popen 接口。

run()函数

run函数常用参数如下:

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

基本用法

运行的命令使用args传给run()函数。args可以是字符串,也可以是一个字符串列表。

[Linux]

subprocess.run("echo 'hi'",shell=True)

subprocess.run(["echo","hi"])

run()函数返回一个CompletedProcess,它包含了命令的参数,返回状态等信息。


>>> run("echo 'hi'",shell=True)
'hi'
CompletedProcess(args="echo 'hi'", returncode=0)

shell

执行命令分为两种情况:

  1. 调用可执行文件执行命令,此时为文件的路径
  2. 执行的是系统Path里的命令,此时为命令名,而非文件路径。

run()函数使用shell来指示这两种情况:

shell=True:表示执行的是系统Path里的命令,python会在命令前加上shell进程(一般情况下,Linux为/bin/sh,Windows为cmd.exe)

subprocess.run("echo 'hi'",shell=True)

shell=False:表示是一个可执行文件,是shell的默认值

在Windows下,执行

subprocess.run("echo 'hi'")

得到报错信息:

FileNotFoundError: [WinError 2] 系统找不到指定的文件。

这个原因是python把echo作为文件来执行。

注意:当shell=True时需要避免shell注入漏洞。

timeout

我们可以给执行的命令指定timeout时间,单位为秒,超时会抛出TimeoutExpired异常。

subprocess.run("echo 'hi'",shell=True,timeout=1)

check

run()函数的check参数是为了替换check_call()函数。ubproces,如果返回的status为非0,则会抛出CalledProcessError

subprocess.run('exit 1', check=True, shell=True)
# subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1.
subprocess.check_call('exit 1', shell=True)
# subprocess.CalledProcessError: Command 'exit 1' returned non-zero exit status 1.

cwd

可以使用cwd指定命令的工作目录。

[Windows]

subprocess.run('dir', shell=True, cwd="C:\\")

标准流

run()函数提供了stdout,stdin和stderr,让我们可以和标准流交互。

subprocess.run('sh info_gathering.sh', stdout=open('comp_info.txt', 'w'), shell=True, encoding='utf-8', bufsize=4096)
©2020 edoou.com   京ICP备16001874号-3