每日一模块：sh

李, 若俞 • 2024年5月28日下午10:59 • 技术漫谈 • 阅读 154

Python模块sh（通常指的是sh库，也被称为python-sh或sh.py）是一个用于在Python中直接调用shell命令的库。它允许你像调用Python函数一样调用shell命令，并且具有一些额外的功能，如命令链式调用、管道、捕获输出等。

一、简介

sh库提供了一种方便的方式来在Python脚本中执行shell命令，并且无需手动处理输入/输出流或错误。这使得在Python中执行复杂的shell任务变得更加简单和直观。

二、安装

你可以使用pip来安装sh库：

pip install sh

三、基本使用

3.1 导入`sh`模块

首先，你需要在Python脚本中导入sh模块：

from sh import ls, cat, grep

注意，sh模块允许你通过导入的方式直接访问常用的shell命令。在这个例子中，我们导入了ls、cat和grep命令。

3.2 执行命令

你可以像调用Python函数一样调用shell命令：

# 执行ls命令并打印输出
print(ls('-l'))

# 执行cat命令并读取文件内容
content = cat('example.txt')
print(content)

# 使用grep命令搜索文本
search_result = grep('pattern', 'example.txt')
print(search_result)

3.3 命令链式调用和管道

sh库支持命令的链式调用和管道操作：

# 链式调用ls和grep命令
result = ls('-l', '/path/to/directory') | grep('example')
print(result)

# 也可以显式地使用管道符'|'
result = ls('-l', '/path/to/directory', _pipe=True) | grep('example')
print(result)

3.4 捕获输出和错误

你可以使用stdout和stderr属性来捕获命令的输出和错误：

# 捕获输出
result = ls('-l').stdout.strip()
print(result)

# 捕获错误（如果命令执行失败）
try:
    result = non_existent_command()  # 假设这个命令不存在
except sh.ErrorReturnCode_127:  # sh库为不同的错误代码提供了特定的异常类
    print("Command not found!")
    error_output = result.stderr.strip()  # 仍然可以访问stderr
    print(error_output)

3.5 参数传递

你可以通过位置参数或关键字参数向shell命令传递参数：

# 使用位置参数
files = ls('/path/to/directory', '*.txt')

# 使用关键字参数（这在某些情况下可能更清晰）
files = ls(path='/path/to/directory', glob='*.txt')

四、注意事项

• sh库在内部使用subprocess模块来执行命令，因此它受到底层操作系统和Python解释器的限制。
• 在处理可能产生敏感数据或需要高安全性的命令时，请确保你的代码是安全的，并避免使用不安全的输入来构建命令。
• 当你需要执行复杂的shell脚本或需要更多的控制时，考虑使用subprocess模块或编写一个shell脚本来完成任务，并通过sh库或subprocess模块在Python中调用它。
• sh库可能不适用于所有情况，特别是当需要更精细地控制输入/输出流或错误处理时。在这些情况下，subprocess模块可能是一个更好的选择。