subprocess库学习之run(函数)

subprocess库学习之run(函数)

一、简介

subprocess.run 是 Python 3.5 及以上版本中的一个函数,用于运行外部命令并等待其完成。该函数是 subprocess 模块中常用的工具之一,取代了早期的 os.system 等方法,提供了更强大的功能和更灵活的参数配置。

二、语法和参数

语法

python 复制代码
subprocess.run(args, *, stdin=None, input=None, stdout=None, stderr=None, capture_output=False, shell=False, cwd=None, timeout=None, check=False, encoding=None, errors=None, text=None, env=None, universal_newlines=None)

参数

  • args: 运行的命令及其参数,通常是一个列表或字符串。
  • stdin : 子进程的标准输入,可设置为 PIPE、文件对象或 None
  • input : 传递给子进程的输入数据,作为 stdin 的内容。
  • stdout : 子进程的标准输出,可设置为 PIPE、文件对象或 None
  • stderr : 子进程的标准错误输出,可设置为 PIPE、文件对象或 None
  • capture_output : 如果设置为 True,则同时捕获 stdoutstderr,等价于设置 stdout=PIPE, stderr=PIPE
  • shell : 如果设置为 True,则通过 shell 执行命令。
  • cwd: 设置子进程的当前工作目录。
  • timeout : 设置子进程的运行时间上限,超时会抛出 TimeoutExpired 异常。
  • check : 如果设置为 True,且子进程退出码非零,则抛出 CalledProcessError 异常。
  • encoding : 如果指定了 text=True,则使用此编码来解码子进程的输出。
  • errors : 处理解码错误的方式,例如 ignorereplace
  • text/universal_newlines : 如果设置为 True,则 stdinstdoutstderr 会以文本模式进行处理。
  • env: 用于设置子进程的环境变量。

返回值

  • CompletedProcess: 该对象包含了子进程的运行结果,例如 argsreturncodestdoutstderr 等。

三、实例

3.1 运行简单的 shell 命令
  • 代码

    • linux

      python 复制代码
      import subprocess
      
      result = subprocess.run(['echo', 'Hello, World!'], capture_output=True, text=True)
      print(result.stdout)
    • Windows

      python 复制代码
      import subprocess
      
      result = subprocess.run('echo Hello, World!', shell=True, capture_output=True, text=True)
      print(result.stdout)
  • 输出

python 复制代码
Hello, World!
3.2 捕获命令的错误输出
  • 代码
python 复制代码
import subprocess

result = subprocess.run(['ls', '/nonexistent'], capture_output=True, text=True)
print("Return code:", result.returncode)
print("Error output:", result.stderr)
  • 输出
python 复制代码
Return code: 2
Error output: ls: cannot access '/nonexistent': No such file or directory
3.3 使用 shell 运行命令
  • 代码
python 复制代码
import subprocess

result = subprocess.run('echo Hello from shell', shell=True, capture_output=True, text=True)
print(result.stdout)
  • 输出
python 复制代码
Hello from shell

四、注意事项

  1. 使用 shell=True 时要特别小心,可能会带来安全风险,特别是在处理不可信的输入时。

  2. timeout 参数可用于限制命令的执行时间,但在超时情况下,需要处理可能残留的子进程。

  3. 默认情况下,subprocess.run 会等待命令执行完毕,如果不需要等待,可以考虑使用 subprocess.Popen

  4. ⭐⭐⭐linux和windows下使用上面方法的不同

    linux下的许多命令(在linux是实际上可执行文件)在 Windows 系统上,是内部命令(built-in command),而非独立的可执行文件。

    因此,不能直接通过 subprocess.run 以这种方式运行。我们可以通过设置 shell=True 来解决此问题,因为在 shell 模式下,Windows 的内部命令将可正常执行。

相关推荐
用户27784491049932 小时前
借助DeepSeek智能生成测试用例:从提示词到Excel表格的全流程实践
人工智能·python
JavaEdge在掘金4 小时前
ssl.SSLCertVerificationError报错解决方案
python
我不会编程5555 小时前
Python Cookbook-5.1 对字典排序
开发语言·数据结构·python
云上艺旅5 小时前
K8S学习之基础七十四:部署在线书店bookinfo
学习·云原生·容器·kubernetes
老歌老听老掉牙5 小时前
平面旋转与交线投影夹角计算
python·线性代数·平面·sympy
满怀10155 小时前
Python入门(7):模块
python
无名之逆5 小时前
Rust 开发提效神器:lombok-macros 宏库
服务器·开发语言·前端·数据库·后端·python·rust
你觉得2055 小时前
哈尔滨工业大学DeepSeek公开课:探索大模型原理、技术与应用从GPT到DeepSeek|附视频与讲义下载方法
大数据·人工智能·python·gpt·学习·机器学习·aigc
啊喜拔牙6 小时前
1. hadoop 集群的常用命令
java·大数据·开发语言·python·scala
A旧城以西7 小时前
数据结构(JAVA)单向,双向链表
java·开发语言·数据结构·学习·链表·intellij-idea·idea