python如何使用subprocess模块连接主机来执行linux命令

原创

mob649e815375e5 2023-10-09 03:42:07 ©著作权

文章标签 文件列表本地文件示例代码 文章分类 Python 后端开发

©著作权归作者所有：来自51CTO博客作者mob649e815375e5的原创作品，请联系作者获取转载授权，否则将追究法律责任

使用subprocess模块连接主机来执行Linux命令

简介

在Python中，使用subprocess模块可以方便地连接主机来执行Linux命令。subprocess模块提供了一种创建和管理新进程的方式，并且可以与这些新进程进行通信。

本文将介绍如何使用subprocess模块连接主机来执行Linux命令，并解决一个实际问题。我们将使用一个示例来说明如何使用subprocess模块。

实际问题

假设我们需要从远程主机上获取某个目录下的文件列表，并保存到本地文件中。我们可以通过连接远程主机，执行Linux命令ls来获取文件列表，并将结果保存到本地文件。

解决方案

我们可以使用subprocess模块来连接远程主机，并执行Linux命令。下面是使用subprocess模块解决这个问题的示例代码：

import subprocess

# 连接远程主机
host = 'example.com'
username = 'user'
password = 'password'
command = f'sshpass -p {password} ssh {username}@{host}'

# 执行Linux命令
remote_command = 'ls /path/to/directory'
output_file = '/path/to/output/file.txt'

try:
    # 执行命令并获取输出
    result = subprocess.run(f'{command} "{remote_command}"', shell=True, capture_output=True, text=True, check=True)
    output = result.stdout

    # 将输出保存到本地文件
    with open(output_file, 'w') as f:
        f.write(output)

    print('文件列表已保存到本地文件')
except subprocess.CalledProcessError as e:
    print('执行命令出错:', e)

代码说明

上述示例代码使用了subprocess.run()函数来执行命令，并获取输出。以下是代码的详细说明：

首先，我们需要连接远程主机。在示例代码中，我们使用sshpass命令来提供密码，并使用ssh命令连接远程主机。你可以根据实际情况来连接远程主机，例如使用SSH秘钥等方式。
接下来，我们定义要执行的Linux命令。在示例代码中，我们执行了ls /path/to/directory来获取文件列表。
我们还定义了一个本地文件路径，用于保存文件列表。
使用subprocess.run()函数来执行命令。其中，shell=True表示在shell中执行命令，capture_output=True表示捕获命令的输出，text=True表示输出以文本形式返回，check=True表示如果命令执行出错，则抛出异常。
通过result.stdout获取命令的输出。
最后，将输出保存到本地文件中。

类图

以下是使用Mermaid语法绘制的示例类图：

classDiagram
    class subprocess
    class subprocess.Popen
    class subprocess.CompletedProcess

    subprocess --> subprocess.Popen
    subprocess --> subprocess.CompletedProcess
    subprocess.CompletedProcess --> subprocess.run