一文详解Python中的subprocess模块

 更新时间:2024年08月13日 11:17:56   作者:一休哥助手  
subprocess模块是Python标准库的一部分,提供了一个跨平台的方法来生成新进程、连接其输入/输出/错误管道,并获取其返回码,本文小编将和大家一起深入理解Python中的subprocess模块,感兴趣的小伙伴跟着小编一起来看看吧

subprocess模块简介

subprocess模块是Python标准库的一部分,提供了一个跨平台的方法来生成新进程、连接其输入/输出/错误管道,并获取其返回码。该模块旨在替代旧的os.system、os.spawn*、os.popen*和commands模块,提供一个更强大和灵活的接口。

常用函数

subprocess模块中有几个常用的函数和类,它们是进行进程管理和管道通信的核心:

  • subprocess.run()
  • subprocess.Popen()
  • subprocess.call()
  • subprocess.check_call()
  • subprocess.check_output()
  • subprocess.DEVNULL
  • subprocess.PIPE
  • subprocess.STDOUT

示例代码

import subprocess

# 运行一个命令并等待其完成
subprocess.run(["ls", "-l"])

# 使用Popen对象启动和管理进程
process = subprocess.Popen(["ls", "-l"], stdout=subprocess.PIPE)
output, error = process.communicate()
print(output.decode())

执行外部命令

使用subprocess.run()

subprocess.run()是执行外部命令的推荐方式。它接受一个命令序列或字符串,返回一个CompletedProcess实例,包含了命令的执行结果。

示例代码

import subprocess

# 执行命令并等待完成
result = subprocess.run(["echo", "Hello, World!"], capture_output=True, text=True)
print(result.stdout)

使用subprocess.call()

subprocess.call()用于执行命令并返回其退出状态。它类似于subprocess.run(),但不会返回CompletedProcess实例。

示例代码

import subprocess

# 执行命令并返回退出状态
return_code = subprocess.call(["ls", "-l"])
print(f"Return code: {return_code}")

使用subprocess.check_call()

subprocess.check_call()类似于subprocess.call(),但如果命令返回非零退出状态,它会引发CalledProcessError异常。

示例代码

import subprocess

try:
    subprocess.check_call(["ls", "-l"])
except subprocess.CalledProcessError as e:
    print(f"Command failed with return code {e.returncode}")

使用subprocess.check_output()

subprocess.check_output()执行命令并返回其输出。如果命令返回非零退出状态,它会引发CalledProcessError异常。

示例代码

import subprocess

try:
    output = subprocess.check_output(["echo", "Hello, World!"], text=True)
    print(output)
except subprocess.CalledProcessError as e:
    print(f"Command failed with return code {e.returncode}")

管道通信

subprocess模块允许开发者通过管道连接多个进程,实现进程间通信。使用subprocess.PIPE可以将子进程的输入/输出/错误重定向到父进程。

示例代码

import subprocess

# 将子进程的输出重定向到父进程
process = subprocess.Popen(["echo", "Hello, World!"], stdout=subprocess.PIPE)
output, error = process.communicate()
print(output.decode())

管道连接示例

import subprocess

# 使用管道连接两个命令
p1 = subprocess.Popen(["echo", "Hello, World!"], stdout=subprocess.PIPE)
p2 = subprocess.Popen(["grep", "Hello"], stdin=p1.stdout, stdout=subprocess.PIPE)
p1.stdout.close()  # 允许p1关闭它的输出管道
output, error = p2.communicate()
print(output.decode())

子进程管理

终止子进程

可以使用Popen对象的terminate()kill()方法终止子进程。

示例代码

import subprocess
import time

# 启动一个长时间运行的进程
process = subprocess.Popen(["sleep", "10"])

# 等待2秒后终止进程
time.sleep(2)
process.terminate()
process.wait()
print("Process terminated")

获取子进程的返回码

可以使用Popen对象的returncode属性获取子进程的返回码。

示例代码

import subprocess

process = subprocess.Popen(["ls", "-l"], stdout=subprocess.PIPE)
process.wait()
print(f"Return code: {process.returncode}")

错误处理

捕获异常

在执行外部命令时,可能会遇到各种异常情况。subprocess模块提供了CalledProcessErrorTimeoutExpired异常,便于开发者处理错误。

示例代码

import subprocess

try:
    subprocess.check_call(["false"])
except subprocess.CalledProcessError as e:
    print(f"Command failed with return code {e.returncode}")

超时处理

可以使用timeout参数设置命令的超时时间,如果命令在指定时间内没有完成,将引发TimeoutExpired异常。

示例代码

import subprocess

try:
    subprocess.run(["sleep", "10"], timeout=5)
except subprocess.TimeoutExpired:
    print("Command timed out")

实际应用示例

运行shell命令

在实际应用中,subprocess模块常用于运行shell命令。使用shell=True参数可以在shell中执行命令。

示例代码

import subprocess

result = subprocess.run("ls -l | grep .py", shell=True, capture_output=True, text=True)
print(result.stdout)

备份数据库

可以使用subprocess模块执行数据库备份命令,将备份文件保存到指定路径。

示例代码

import subprocess

command = ["mysqldump", "-u", "root", "-p", "database_name"]
with open("backup.sql", "w") as f:
    result = subprocess.run(command, stdout=f)
    if result.returncode == 0:
        print("Backup successful")
    else:
        print("Backup failed")

自动化脚本

subprocess模块可以用于编写自动化脚本,执行一系列的命令完成特定任务。

示例代码

import subprocess

def run_commands(commands):
    for command in commands:
        result = subprocess.run(command, shell=True, capture_output=True, text=True)
        if result.returncode != 0:
            print(f"Command failed: {command}")
            print(result.stderr)
            break
        else:
            print(result.stdout)

commands = [
    "echo 'Starting automation script'",
    "mkdir -p /tmp/test_directory",
    "touch /tmp/test_directory/test_file",
    "echo 'Automation script completed'"
]

run_commands(commands)

最佳实践

  1. 避免使用shell=True: 除非必要,否则尽量避免使用shell=True,以减少安全风险。
  2. 使用完整路径: 在命令中使用完整路径,以确保命令能够正确执行。
  3. 处理异常: 始终捕获并处理可能出现的异常,确保程序的健壮性。
  4. 设置超时: 对长时间运行的命令设置超时,以避免程序挂起。
  5. 使用上下文管理器: 使用上下文管理器管理文件对象,确保资源正确释放。

示例代码

import subprocess

def safe_run_command(command, timeout=10):
    try:
        result = subprocess.run(command, capture_output=True, text=True, timeout=timeout)
        result.check_returncode()
        return result.stdout
    except subprocess.CalledProcessError as e:
        print(f"Command '{e.cmd}' failed with return code {e.returncode}")
    except subprocess.TimeoutExpired as e:
        print(f"Command '{e.cmd}' timed out after {e.timeout} seconds")

output = safe_run_command(["ls", "-l"])
print(output)

结论

subprocess模块是Python中执行外部命令和管理子进程的强大工具。通过学习并掌握subprocess模块的使用,可以编写出高效、可靠的自动化脚本和系统

管理工具。本文详细介绍了subprocess模块的基本概念、常用函数、管道通信、子进程管理、错误处理及实际应用示例,希望对读者有所帮助。通过不断实践和应用这些知识,开发者能够提高代码质量,减少错误,提升开发效率。

以上就是一文详解Python中的subprocess模块的详细内容,更多关于Python subprocess模块的资料请关注脚本之家其它相关文章!

相关文章

  • 使用Pyinstaller的最新踩坑实战记录

    使用Pyinstaller的最新踩坑实战记录

    这篇文章主要给大家介绍了最近在使用Pyinstaller的踩坑实战记录,主要介绍了PYTHON2X.DLL缺失和WINDOWS2003 32BIT提示程序无效这两个问题的解决方法,文中给出了详细的解决方法,需要的朋友们下面来一起看看吧。
    2017-11-11
  • python 添加用户设置密码并发邮件给root用户

    python 添加用户设置密码并发邮件给root用户

    这篇文章主要介绍了python 添加用户设置密码并发邮件给root用户的相关资料,非常不错,具有参考借鉴价值,需要的朋友可以参考下
    2016-07-07
  • 用Python Turtle画棵樱花树送给自己

    用Python Turtle画棵樱花树送给自己

    心情不好的时候,来用Python和Turtle库画棵樱花树送给自己吧,自己也要好好爱自己才对!文中的示例代码讲解详细,感兴趣的小伙伴可以动手试一试
    2022-02-02
  • Python爬虫利用多线程爬取 LOL 高清壁纸

    Python爬虫利用多线程爬取 LOL 高清壁纸

    这篇文章主要介绍了Python爬虫利用多线程爬取 LOL 高清壁纸,通过网站爬取每一个英雄的所有皮肤图片,全部下载下来并保存到本地,下文爬取过程感兴趣的朋友可以参考一下
    2022-06-06
  • Python 调用GPT-3 API实现过程详解

    Python 调用GPT-3 API实现过程详解

    这篇文章主要为大家介绍了Python 调用GPT-3 API实现过程详解,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-02-02
  • Python反向传播实现线性回归步骤详细讲解

    Python反向传播实现线性回归步骤详细讲解

    回归是监督学习的一个重要问题,回归用于预测输入变量和输出变量之间的关系,特别是当输入变量的值发生变化时,输出变量的值也随之发生变化。回归模型正是表示从输入变量到输出变量之间映射的函数
    2022-10-10
  • Python读取CSV文件并计算某一列的均值和方差

    Python读取CSV文件并计算某一列的均值和方差

    这篇文章主要介绍了利用Python读取CSV文件并计算某一列的均值和方差,这里利用了csv模块来对文件进行处理,文章通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2021-12-12
  • python+django+mysql开发实战(附demo)

    python+django+mysql开发实战(附demo)

    本文主要介绍了python+django+mysql开发实战(附demo),文中通过示例代码介绍的非常详细,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2022-01-01
  • 解决Django cors跨域问题

    解决Django cors跨域问题

    这篇文章主要介绍了解决Django cors跨域问题,本文给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友可以参考下
    2022-06-06
  • django+celery如何实现定时拉取阿里云rocketmq实例信息

    django+celery如何实现定时拉取阿里云rocketmq实例信息

    这篇文章主要介绍了django+celery如何实现定时拉取阿里云rocketmq实例信息,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
    2025-07-07

最新评论