好的，各位观众老爷，欢迎来到今天的“Python shell 特技秀”！今天咱们要聊聊 Python 里的 sh 模块，一个能让你把 shell 命令像调用普通 Python 函数一样使用的神奇工具。准备好了吗？系好安全带，咱们要发车了！
第一幕：sh 模块是个啥？为啥要用它？
想象一下，你正在写一个 Python 脚本，需要执行一些系统命令，比如列出目录里的文件、查看进程状态、或者运行一些外部工具。你会怎么做？
传统的方法可能是用 subprocess 模块，就像这样：
import subprocess
try:
result = subprocess.run(['ls', '-l'], capture_output=True, text=True, check=True)
print(result.stdout)
except subprocess.CalledProcessError as e:
print(f"Error executing command: {e}")嗯，这段代码能工作，但看起来有点…繁琐。你得记住 subprocess.run 的各种参数，处理异常，解码输出，等等。如果命令稍微复杂一点，代码就会变得更难读、更难维护。
这时，sh 模块就像一位骑着白马的骑士，闪亮登场！它可以让你直接像调用 Python 函数一样调用 shell 命令，代码会变得更简洁、更易读。
import sh
try:
ls_output = sh.ls("-l")
print(ls_output)
except sh.ErrorReturnCode as e:
print(f"Error executing command: {e}")看到区别了吗？sh.ls("-l") 就像调用一个普通的 Python 函数一样！ sh 模块会自动处理命令的执行、输出的捕获、以及错误的检查。
为啥要用 sh 模块？
- 简洁易读： 代码更短、更易于理解。
- 更 Pythonic： 像调用普通 Python 函数一样使用 shell 命令，更符合 Python 风格。
- 自动处理： 自动捕获输出、检查错误，减少了样板代码。
- 链式调用： 可以像流水线一样链式调用多个命令，让代码更流畅。
第二幕：安装 sh 模块
要使用 sh 模块，首先需要安装它。打开你的终端，运行以下命令：
pip install sh如果你的 Python 环境没有配置好 pip，请自行搜索安装 pip 的方法。
第三幕：基本用法：像调用函数一样调用命令
安装好 sh 模块后，就可以开始使用了。sh 模块的核心思想是，把每个 shell 命令都看作一个 Python 函数。
import sh
# 调用 ls 命令，列出当前目录的文件
ls_output = sh.ls()
print(ls_output)
# 调用 pwd 命令，显示当前工作目录
pwd_output = sh.pwd()
print(pwd_output)
# 调用 uname -a 命令，显示系统信息
uname_output = sh.uname("-a")
print(uname_output)是不是很简单？ sh.ls()、sh.pwd()、sh.uname("-a") 就像普通的 Python 函数调用一样。
第四幕：参数传递：让命令更灵活
sh 模块允许你以多种方式向 shell 命令传递参数。
-
位置参数： 就像上面的例子一样，直接把参数作为字符串传递给函数。
ls_output = sh.ls("-l", "/tmp") # 列出 /tmp 目录下的文件 -
关键字参数： 可以使用关键字参数来指定某些选项。
grep_output = sh.grep("hello", "-i", filename="my_file.txt") # 在 my_file.txt 中查找 "hello"，忽略大小写注意：关键字参数的名字必须是命令支持的选项的名字（去掉前面的短横线或长横线）。
-
_前缀参数： 如果选项的名字和 Python 的关键字冲突（比如from、in等），可以在选项名前面加上一个下划线。find_output = sh.find(".", "_type", "f", "_name", "*.py") # 查找当前目录下所有 .py 文件这里，
_type和_name是因为type和name是 Python 的关键字。 -
--参数： 有些命令需要用--来分隔选项和参数。sh模块也支持这种用法。tar_output = sh.tar("--", "-czvf", "my_archive.tar.gz", "my_directory")这里，
--告诉tar命令，后面的参数都是文件名，而不是选项。
第五幕：链式调用：让命令像流水线一样工作
sh 模块最酷的功能之一是链式调用。它可以让你像流水线一样把多个命令串联起来，把一个命令的输出作为另一个命令的输入。
import sh
# 查找当前目录下所有的 .py 文件，并统计行数
try:
wc_output = sh.grep("-l", ".py$", sh.find(".")) | sh.xargs("wc", "-l")
print(wc_output)
except sh.ErrorReturnCode as e:
print(f"Error executing command: {e}")这段代码做了什么？
sh.find(".")：查找当前目录下的所有文件和目录。sh.grep("-l", ".py$", ...)：过滤出文件名以.py结尾的文件。-l选项表示只输出文件名。sh.xargs("wc", "-l")：把grep的输出作为参数传递给wc -l命令，统计每个文件的行数。
| 符号就像管道一样，把一个命令的输出传递给下一个命令。 sh.xargs 命令可以将标准输入转换为命令行参数.
第六幕：错误处理：别让程序崩溃
在使用 shell 命令时，错误是不可避免的。 sh 模块提供了多种方式来处理错误。
-
默认行为： 默认情况下，如果 shell 命令返回非零的退出码，
sh模块会抛出一个sh.ErrorReturnCode异常。import sh try: sh.ls("non_existent_file") except sh.ErrorReturnCode as e: print(f"Error: {e}") print(f"Command: {e.full_cmd}") print(f"Exit code: {e.exit_code}") print(f"Stdout: {e.stdout}") print(f"Stderr: {e.stderr}")你可以捕获这个异常，并根据需要进行处理。
e.full_cmd包含了完整的命令，e.exit_code是退出码，e.stdout和e.stderr分别是标准输出和标准错误。 -
忽略错误： 如果你不想让程序因为某个命令出错而崩溃，可以使用
_ok_code参数来指定允许的退出码。import sh # 允许 ls 命令返回任何退出码 try: sh.ls("non_existent_file", _ok_code=(0, 1, 2)) #允许返回码为0,1,2，不报错 except sh.ErrorReturnCode as e: print(f"Error: {e}")在这个例子中，即使
ls命令找不到文件，返回一个非零的退出码，程序也不会抛出异常。 -
_bg参数： 如果你想在后台运行一个命令，可以使用_bg参数。import sh import time # 在后台运行 sleep 命令 sleep_process = sh.sleep("10", _bg=True) # 等待一段时间 time.sleep(2) # 检查进程是否还在运行 if sleep_process.process.poll() is None: print("Sleep process is still running in the background.") sleep_process.process.terminate() # 终止进程 else: print("Sleep process has finished.")使用
_bg=True后，sh模块会返回一个RunningCommand对象，你可以用它来控制后台进程。
第七幕：输入输出：和命令交互
sh 模块提供了多种方式来和 shell 命令交互，包括传递输入、捕获输出、以及实时读取输出。
-
传递输入： 可以使用
_in参数来向命令传递输入。import sh # 使用 echo 命令，并通过管道传递给 grep 命令 grep_output = sh.grep("hello", _in="hello worldnhello pythonn") print(grep_output)_in参数可以是一个字符串、一个文件对象、或者一个可迭代对象。 -
捕获输出： 默认情况下，
sh模块会自动捕获命令的标准输出和标准错误。你可以通过stdout和stderr属性来访问这些输出。import sh try: result = sh.ls("-l") print(f"Stdout: {result.stdout}") print(f"Stderr: {result.stderr}") except sh.ErrorReturnCode as e: print(f"Error: {e}") print(f"Stdout: {e.stdout}") print(f"Stderr: {e.stderr}") -
实时读取输出： 如果你想实时读取命令的输出，可以使用
_out和_err参数。import sh def print_output(line): print(f"Output: {line.strip()}") # 实时打印 tail -f /var/log/syslog 的输出 try: sh.tail("-f", "/var/log/syslog", _out=print_output, _err=print_output, _bg=True) except sh.ErrorReturnCode as e: print(f"Error: {e}")_out和_err参数可以是一个函数、一个文件对象、或者一个可迭代对象。当命令有输出时，sh模块会调用你指定的函数，或者把输出写入到指定的文件对象中。
第八幕：高级用法：定制你的 sh 模块
sh 模块还提供了一些高级功能，可以让你更好地定制它的行为。
-
Command对象： 可以使用sh.Command类来创建一个表示特定命令的对象。import sh # 创建一个表示 ls 命令的 Command 对象 ls_command = sh.Command("ls") # 使用 Command 对象来执行命令 ls_output = ls_command("-l") print(ls_output)Command对象可以让你更方便地重用和配置命令。 -
Environment对象： 可以使用sh.Environment类来创建一个表示特定环境变量的对象。import sh # 创建一个包含自定义环境变量的 Environment 对象 my_env = sh.Environment(MY_VAR="hello") # 使用 Environment 对象来执行命令 with my_env: echo_output = sh.echo("$MY_VAR") print(echo_output)Environment对象可以让你在执行命令时设置环境变量。 -
ErrorReturnCode_XXXX异常：sh模块会为每个命令创建一个特定的异常类，比如sh.ErrorReturnCode_ls、sh.ErrorReturnCode_grep等。你可以捕获这些特定的异常，来更精确地处理错误。import sh try: sh.ls("non_existent_file") except sh.ErrorReturnCode_ls as e: print(f"ls command failed: {e}") except sh.ErrorReturnCode as e: print(f"Other command failed: {e}")
第九幕：sh 模块的局限性
虽然 sh 模块很强大，但它也有一些局限性。
- 依赖 shell：
sh模块依赖于系统上的 shell 环境。如果你的脚本需要在不同的平台上运行，并且这些平台上的 shell 环境不同，可能会遇到一些问题。 - 安全性： 如果你使用
sh模块来执行用户提供的命令，需要注意安全性问题，防止命令注入攻击。 - 性能： 每次调用
sh模块都会启动一个新的 shell 进程，这可能会带来一些性能开销。
第十幕：总结与建议
sh 模块是一个非常有用的工具，可以让你更方便地在 Python 脚本中执行 shell 命令。它代码简洁易读，可以自动处理很多细节，而且支持链式调用，让代码更流畅。
但是，在使用 sh 模块时，也要注意它的局限性，特别是安全性和性能问题。
建议：
- 如果你的脚本需要执行简单的 shell 命令，并且对性能要求不高，可以优先考虑使用
sh模块。 - 如果你的脚本需要执行复杂的 shell 命令，或者对性能要求很高，可以考虑使用
subprocess模块，并进行更细致的控制。 - 在处理用户提供的命令时，一定要进行严格的验证和过滤，防止命令注入攻击。
- 多看官方文档，学习更多高级用法。
一些常用的 sh模块命令及参数表
| 命令 | 参数 | 描述 | 示例 |
|---|---|---|---|
ls |
-l, -a, -t, filename |
列出目录内容。 -l：详细信息， -a：所有文件， -t：按修改时间排序， filename：目录或文件名 |
sh.ls("-l", "/tmp") |
grep |
pattern, -i, -v, filename |
在文件中查找匹配的行。 pattern：查找的模式， -i：忽略大小写， -v：反向查找， filename：文件名 |
sh.grep("hello", "-i", filename="my_file.txt") |
find |
path, -type, -name |
查找文件。 path：查找的路径， -type：文件类型， -name：文件名模式 |
sh.find(".", "-type", "f", "-name", "*.py") |
sed |
expression, filename |
替换文件中的文本。 expression：替换表达式， filename：文件名 |
sh.sed("s/old/new/g", filename="my_file.txt") |
awk |
program, filename |
处理文本文件。 program：AWK 程序， filename：文件名 |
sh.awk("{print $1}", filename="my_file.txt") |
sort |
-n, -r, filename |
排序文件。 -n：按数值排序， -r：反向排序， filename：文件名 |
sh.sort("-n", filename="my_file.txt") |
uniq |
-c, filename |
去除重复行。 -c：统计重复次数， filename：文件名 |
sh.uniq("-c", filename="my_file.txt") |
head |
-n, filename |
显示文件头部。 -n：显示的行数， filename：文件名 |
sh.head("-n", "10", filename="my_file.txt") |
tail |
-n, -f, filename |
显示文件尾部。 -n：显示的行数， -f：跟踪文件， filename：文件名 |
sh.tail("-n", "10", filename="my_file.txt"), sh.tail("-f", "/var/log/syslog") |
wc |
-l, -w, -c, filename |
统计文件。 -l：行数， -w：单词数， -c：字节数， filename：文件名 |
sh.wc("-l", filename="my_file.txt") |
mkdir |
-p, directory |
创建目录。 -p：创建父目录， directory：目录名 |
sh.mkdir("-p", "my_directory") |
rm |
-r, -f, filename |
删除文件或目录。 -r：递归删除， -f：强制删除， filename：文件名或目录名 |
sh.rm("-r", "my_directory"), sh.rm("-f", "my_file.txt") |
cp |
-r, source, destination |
复制文件或目录。 -r：递归复制， source：源文件或目录， destination：目标文件或目录 |
sh.cp("-r", "my_directory", "another_directory"), sh.cp("my_file.txt", "another_file.txt") |
mv |
source, destination |
移动文件或目录。 source：源文件或目录， destination：目标文件或目录 |
sh.mv("my_directory", "another_directory"), sh.mv("my_file.txt", "another_file.txt") |
chmod |
mode, filename |
修改文件权限。 mode：权限模式， filename：文件名 |
sh.chmod("777", "my_file.txt") |
chown |
user:group, filename |
修改文件所有者。 user:group：用户名和组名， filename：文件名 |
sh.chown("user:group", "my_file.txt") |
tar |
-czvf, -xzvf, archive, files |
打包和解包文件。 -czvf：创建压缩包， -xzvf：解压缩， archive：压缩包名， files：文件列表 |
sh.tar("-czvf", "my_archive.tar.gz", "my_directory"), sh.tar("-xzvf", "my_archive.tar.gz") |
echo |
text |
显示文本。 text：要显示的文本 |
sh.echo("hello world") |
pwd |
无 | 显示当前工作目录 | sh.pwd() |
uname |
-a |
显示系统信息。 -a：显示所有信息 |
sh.uname("-a") |
sleep |
seconds |
暂停执行。 seconds：暂停的秒数 |
sh.sleep("10") |
这个表格只是列出了一些常用的命令和参数，sh 模块支持几乎所有的 shell 命令和参数。 使用时请参考具体的命令文档。
好了，今天的“Python shell 特技秀”就到这里了。希望大家能够喜欢 sh 模块，并把它应用到自己的项目中。 记住，编程的乐趣在于不断学习和探索！感谢大家的观看，我们下期再见！