python | Github 7.4k star，一个强大的 Python 库--sh！

本文来源公众号“python”，仅用于学术分享，侵权删，干货满满。

原文链接：Github 7.4k star，一个强大的 Python 库--sh！

大家好，今天为大家分享一个强大的 Python 库 - sh。

Github地址：https://github.com/amoffat/sh

sh库是Python生态系统中一个专门用于执行系统命令的第三方库，由Andrew Moffat开发。该库的设计理念是将系统命令转化为Python函数，使得在Python程序中调用系统命令变得更加直观和优雅。sh库提供了更加简洁的API接口，大大简化了系统命令的调用过程。sh库的核心优势在于其独特的设计思路：将每个系统命令都视为一个可调用的Python函数对象。

安装

1、安装方法

sh库可以通过pip进行安装，安装过程简单直接：

# 使用pip安装
pip install sh

# 指定版本安装
pip install sh==1.14.3

2、验证安装

安装完成后，可以通过以下代码验证安装是否成功：

import sh
print(sh.__version__)
print(sh.which('python'))

如果能够正常输出版本信息和Python解释器路径，说明安装成功。

主要特性

• 动态命令映射：自动将系统命令转换为Python函数对象，无需预先定义

• 简洁的API设计：提供比subprocess更加直观的命令调用方式

• 灵活的参数传递：支持位置参数、关键字参数和命令行选项的多种传递方式

• 实时输出处理：支持命令执行过程中的实时输出捕获和处理

• 异常处理机制：提供完善的错误处理和异常捕获功能

• 管道操作支持：支持类似Unix管道的命令组合操作

• 后台执行能力：支持命令的异步执行和后台运行

基本功能

1、基础命令执行

sh库最基本的功能是执行系统命令并获取输出结果。通过简单的函数调用方式，可以轻松执行各种系统命令。

import sh

# 执行简单命令
result = sh.ls('-la')
print(result)

# 获取当前目录
pwd_result = sh.pwd()
print(f"当前目录: {pwd_result.strip()}")

# 查看系统信息
uname_result = sh.uname('-a')
print(f"系统信息: {uname_result}")

2、参数传递与选项设置

sh库支持多种参数传递方式，包括位置参数、关键字参数和命令行选项。这种灵活的参数处理机制使得复杂命令的构建变得简单。

# 使用位置参数
sh.mkdir('/tmp/test_dir')

# 使用关键字参数
sh.ls(l=True, a=True, h=True)

# 混合参数使用
result = sh.find('/home', name='*.py', type='f')
print(result)

# 复杂命令构建
sh.tar('czf', 'archive.tar.gz', 'source_directory/')

3、输出处理与重定向

sh库提供了强大的输出处理功能，支持命令输出的捕获、重定向和实时处理。

# 输出重定向到文件
sh.echo('Hello World', _out='output.txt')

# 捕获输出并处理
def process_line(line):
    print(f"处理行: {line.strip()}")

# 实时处理输出
sh.ping('google.com', c=3, _out=process_line)

# 错误输出处理
try:
    result = sh.ls('/nonexistent')
except sh.ErrorReturnCode as e:
    print(f"命令执行失败: {e}")

高级功能

1、管道操作

sh库支持类似Unix管道的操作，允许将多个命令组合在一起形成复杂的处理流程。

# 管道操作示例
result = sh.ps('aux') | sh.grep('python') | sh.wc('-l')
print(f"Python进程数量: {result.strip()}")

# 复杂管道操作
log_analysis = sh.cat('/var/log/access.log') | sh.grep('404') | sh.awk('{print $1}') | sh.sort() | sh.uniq('-c')
print(log_analysis)

# 多级管道
network_info = sh.netstat('-an') | sh.grep('LISTEN') | sh.awk('{print $4}') | sh.sort() | sh.uniq()
print(network_info)

2、异步执行与后台任务

sh库支持命令的异步执行，允许在后台运行长时间的任务而不阻塞主程序。

# 后台执行命令
background_task = sh.sleep(10, _bg=True)
print("任务已在后台启动")

# 检查任务状态
if background_task.is_alive():
    print("任务正在运行中")

# 等待任务完成
background_task.wait()
print("任务已完成")

# 异步执行多个任务
tasks = []
for i in range(5):
    task = sh.ping('google.com', c=1, _bg=True)
    tasks.append(task)

# 等待所有任务完成
for task in tasks:
    task.wait()
    print(f"任务完成，退出码: {task.exit_code}")

实际应用场景

1、系统监控与运维

在系统监控和运维自动化中，sh库能够简化各种系统信息的收集和处理工作。通过将系统命令包装为Python函数，运维人员可以轻松地构建监控脚本和自动化工具。

import sh
import time

def system_monitor():
    # 获取系统负载
    load_avg = sh.uptime()
    print(f"系统负载: {load_avg.strip()}")
    
    # 检查磁盘使用情况
    disk_usage = sh.df('-h')
    print(f"磁盘使用情况:\n{disk_usage}")
    
    # 监控内存使用
    memory_info = sh.free('-m')
    print(f"内存使用情况:\n{memory_info}")
    
    # 检查关键进程
    process_count = sh.ps('aux') | sh.grep('nginx') | sh.wc('-l')
    print(f"Nginx进程数量: {process_count.strip()}")

# 定期执行监控
whileTrue:
    system_monitor()
    time.sleep(60)

2、自动化部署与CI/CD

在软件部署和持续集成流程中，sh库能够帮助开发者构建灵活的部署脚本。通过将各种部署命令封装为Python函数，可以实现更加可控和可重复的部署流程。

def deploy_application():
    try:
        # 拉取最新代码
        sh.git('pull', 'origin', 'main')
        print("代码更新完成")
        
        # 安装依赖
        sh.pip('install', '-r', 'requirements.txt')
        print("依赖安装完成")
        
        # 运行测试
        test_result = sh.python('-m', 'pytest', 'tests/')
        print("测试执行完成")
        
        # 重启服务
        sh.systemctl('restart', 'myapp')
        print("服务重启完成")
        
        # 验证部署
        health_check = sh.curl('-f', 'http://localhost:8000/health')
        print("部署验证成功")
        
    except sh.ErrorReturnCode as e:
        print(f"部署失败: {e}")
        # 回滚操作
        sh.git('reset', '--hard', 'HEAD~1')
        sh.systemctl('restart', 'myapp')
        print("已执行回滚操作")

deploy_application()

总结

sh库为Python开发者提供了一个优雅而强大的系统命令执行解决方案。通过将系统命令转化为Python函数的创新设计，该库大大简化了系统编程的复杂度，使得开发者能够更加专注于业务逻辑的实现。其丰富的功能特性包括动态命令映射、灵活的参数处理、强大的输出管理和异步执行支持，能够满足从简单脚本到复杂系统工具的各种需求。对于系统管理员、DevOps工程师和需要频繁与系统交互的Python开发者而言，sh库是一个值得深入掌握的工具。不仅能够提高开发效率，还能够通过其优雅的API设计提升代码的可读性和可维护性。

THE END !

文章结束，感谢阅读。您的点赞，收藏，评论是我继续更新的动力。大家有推荐的公众号可以评论区留言，共同学习，一起进步。