`sh` 模块：将 shell 命令作为 Python 函数调用

好的，各位观众老爷们，欢迎来到今天的Python“一键梭哈”命令行技术讲座！今天我们要聊的是一个神奇的模块，它能让你把命令行当成Python函数来用，就像按个按钮就能发射火箭一样简单——这就是传说中的sh模块。

第一幕：sh模块是个啥？为啥要用它？

想象一下，你是个Python程序员，每天的任务是写脚本来处理各种数据。突然，老板跟你说：“小伙子，给我写个脚本，能自动备份数据库，然后压缩上传到云盘。”

你的内心OS是：“备份数据库？压缩？上传？这不都是命令行工具干的事情吗？我得去subprocess模块里折腾半天，又是Popen，又是communicate，还要处理各种异常，简直要命！”

这时候，sh模块就像一道光，照亮了你的程序人生。它让你能直接在Python代码里调用命令行工具，就像调用普通函数一样。

简单来说，sh模块就是Python和shell之间的“翻译器”，它把shell命令翻译成Python函数，让你直接在Python里“指挥”shell干活。

为啥要用sh？

简洁易懂： 比subprocess模块更加简单易懂，代码更简洁。
链式调用： 可以像流水线一样，把多个命令串起来执行。
实时输出： 可以实时获取命令行的输出，方便调试和监控。
异常处理： 方便地处理命令行执行过程中的错误。

第二幕：安装sh模块，开启你的命令行“梭哈”之旅

要使用sh模块，首先要把它安装到你的Python环境中。这就像你要玩游戏，得先安装游戏客户端一样。

打开你的终端，输入以下命令：

pip install sh

如果你的环境里有多个Python版本，可以使用pip3来安装：

pip3 install sh

安装完成后，就可以在Python代码里导入sh模块了：

import sh

第三幕：sh模块的基本用法，让你“梭哈”起来得心应手

现在，让我们来学习sh模块的基本用法。

1. 调用简单的命令

假设我们要执行ls -l命令，列出当前目录下的文件和目录的详细信息。使用sh模块，可以这样写：

import sh

try:
    output = sh.ls("-l")
    print(output)
except sh.ErrorReturnCode as e:
    print(f"命令执行出错：{e}")

这段代码做了什么？

sh.ls("-l")：这就像调用一个名为ls的Python函数，参数是-l。
output：sh.ls("-l")的返回值就是命令行的输出结果。
print(output)：把输出结果打印出来。
try...except：这是一个异常处理机制，用来捕获命令行执行过程中的错误。

运行这段代码，你就能看到ls -l命令的输出结果了。

2. 链式调用，让你的命令像流水线一样工作

sh模块最强大的功能之一就是链式调用。它可以让你把多个命令串起来执行，就像流水线一样，一个命令的输出作为下一个命令的输入。

例如，我们要先用ls -l命令列出当前目录下的文件和目录的详细信息，然后用grep命令过滤出包含“test”的行。使用sh模块，可以这样写：

import sh

try:
    output = sh.ls("-l") | sh.grep("test")
    print(output)
except sh.ErrorReturnCode as e:
    print(f"命令执行出错：{e}")

这段代码中，sh.ls("-l") | sh.grep("test")表示把sh.ls("-l")的输出作为sh.grep("test")的输入。|符号就像一根管道，把两个命令连接起来。

3. 处理命令行的输入和输出

sh模块提供了多种方式来处理命令行的输入和输出。

标准输入 (stdin)： 可以通过_in参数来指定命令行的输入。
标准输出 (stdout)： 命令行的输出结果就是函数的返回值。
标准错误 (stderr)： 可以通过_stderr参数来指定标准错误输出的处理方式。

例如，我们要把一个字符串作为grep命令的输入：

import sh

try:
    output = sh.grep("test", _in="this is a test string")
    print(output)
except sh.ErrorReturnCode as e:
    print(f"命令执行出错：{e}")

这段代码中，_in="this is a test string"表示把字符串"this is a test string"作为grep命令的输入。

4. 处理命令行的返回值

每个命令行工具都有一个返回值，用来表示命令执行的结果。一般来说，0表示成功，非0表示失败。

sh模块会自动检查命令行的返回值。如果返回值非0，sh模块会抛出一个sh.ErrorReturnCode异常。

例如，我们要执行一个不存在的命令：

import sh

try:
    output = sh.nonexistent_command()
    print(output)
except sh.ErrorReturnCode as e:
    print(f"命令执行出错：{e}")

这段代码会抛出一个sh.ErrorReturnCode异常，因为nonexistent_command命令不存在。

5. 其他常用的参数

sh模块还提供了许多其他常用的参数，可以用来控制命令行的执行过程。

参数	描述
`_bg`	后台运行命令。
`_fg`	前台运行命令。
`_timeout`	设置命令的超时时间，单位是秒。
`_cwd`	设置命令的当前工作目录。
`_env`	设置命令的环境变量。
`_out`	指定标准输出的处理方式。可以是一个函数，用来处理每一行的输出。也可以是一个文件对象，用来把输出写入到文件中。
`_err`	指定标准错误输出的处理方式。可以是一个函数，用来处理每一行的错误信息。也可以是一个文件对象，用来把错误信息写入到文件中。
`_ok_code`	指定哪些返回值表示命令执行成功。默认情况下，只有返回值是0才表示成功。
`_exc_bad_rc`	如果命令执行失败（返回值不在`_ok_code`中），是否抛出异常。默认情况下，会抛出异常。

第四幕：实战演练，用sh模块解决实际问题

现在，让我们来用sh模块解决一些实际问题。

1. 自动备份数据库

假设我们要写一个脚本，自动备份MySQL数据库，并把备份文件上传到云盘。

import sh
import datetime

# 数据库配置
DB_USER = "root"
DB_PASSWORD = "password"
DB_NAME = "mydatabase"

# 云盘配置
CLOUD_USER = "myclouduser"
CLOUD_PASSWORD = "mycloudpassword"
CLOUD_HOST = "mycloudhost"
CLOUD_PATH = "/backup"

# 备份文件路径
BACKUP_DIR = "/tmp/backup"

try:
    # 创建备份目录
    sh.mkdir("-p", BACKUP_DIR)

    # 生成备份文件名
    now = datetime.datetime.now()
    backup_file = f"{BACKUP_DIR}/{DB_NAME}_{now.strftime('%Y%m%d%H%M%S')}.sql"

    # 备份数据库
    sh.mysqldump(
        "-u", DB_USER,
        f"-p{DB_PASSWORD}",
        DB_NAME,
        _out=backup_file
    )

    # 压缩备份文件
    compressed_file = f"{backup_file}.gz"
    sh.gzip(backup_file)

    # 上传到云盘
    sh.scp(
        compressed_file,
        f"{CLOUD_USER}@{CLOUD_HOST}:{CLOUD_PATH}"
    )

    # 删除本地备份文件
    sh.rm(compressed_file)

    print("数据库备份成功！")

except sh.ErrorReturnCode as e:
    print(f"数据库备份失败：{e}")

这段代码做了什么？

首先，定义了一些数据库和云盘的配置信息。
然后，创建备份目录，并生成备份文件名。
接着，使用mysqldump命令备份数据库，并把输出写入到备份文件中。
然后，使用gzip命令压缩备份文件。
最后，使用scp命令把压缩后的备份文件上传到云盘，并删除本地备份文件。

2. 监控服务器的CPU使用率

假设我们要写一个脚本，监控服务器的CPU使用率，如果CPU使用率超过80%，就发送邮件报警。

import sh
import time
import smtplib
from email.mime.text import MIMEText

# CPU使用率阈值
CPU_THRESHOLD = 80

# 邮件配置
SMTP_SERVER = "smtp.example.com"
SMTP_PORT = 587
SMTP_USER = "[email protected]"
SMTP_PASSWORD = "mypassword"
SENDER = "[email protected]"
RECIPIENT = "[email protected]"

def send_email(subject, body):
    msg = MIMEText(body)
    msg['Subject'] = subject
    msg['From'] = SENDER
    msg['To'] = RECIPIENT

    try:
        server = smtplib.SMTP(SMTP_SERVER, SMTP_PORT)
        server.starttls()
        server.login(SMTP_USER, SMTP_PASSWORD)
        server.sendmail(SENDER, [RECIPIENT], msg.as_string())
        server.quit()
        print("邮件发送成功！")
    except Exception as e:
        print(f"邮件发送失败：{e}")

try:
    while True:
        # 获取CPU使用率
        output = sh.top("-bn1") | sh.grep("Cpu(s)") | sh.awk("{print $2 + $4}")
        cpu_usage = float(output.strip())

        # 判断CPU使用率是否超过阈值
        if cpu_usage > CPU_THRESHOLD:
            subject = "服务器CPU使用率过高"
            body = f"服务器CPU使用率已超过{CPU_THRESHOLD}%，当前使用率为{cpu_usage}%。"
            send_email(subject, body)

        # 休眠一段时间
        time.sleep(60)

except sh.ErrorReturnCode as e:
    print(f"监控脚本出错：{e}")

这段代码做了什么？

首先，定义了一些CPU使用率阈值和邮件配置信息。
然后，定义了一个send_email函数，用来发送邮件。
接着，在一个循环中，使用top命令获取CPU使用率，并使用grep和awk命令提取出CPU使用率的值。
然后，判断CPU使用率是否超过阈值，如果超过，就发送邮件报警。
最后，休眠一段时间，然后继续监控。

第五幕：sh模块的局限性，以及替代方案

虽然sh模块很强大，但它也有一些局限性。

依赖于shell： sh模块依赖于shell环境，如果shell环境不可用，sh模块就无法工作。
安全性问题： 如果你使用sh模块执行用户提供的命令，可能会存在安全风险。

如果你的程序需要在没有shell环境的情况下运行，或者你需要执行用户提供的命令，可以考虑使用subprocess模块或者其他更安全的替代方案。

第六幕：总结与展望

sh模块是一个非常方便的工具，它可以让你在Python代码里轻松地调用命令行工具，提高开发效率。

但是，在使用sh模块的时候，也要注意它的局限性和安全性问题。

希望今天的讲座能帮助你更好地理解和使用sh模块。

各位观众老爷们，下次再见！

发表回复 取消回复

发表回复取消回复