分享7个 Python CLI 库,助您快速构建高效命令行应用程序
off999 2024-10-26 12:04 43 浏览 0 评论
转载说明:原创不易,未经授权,谢绝任何形式的转载
加强你的Python开发
当涉及到 Python 命令行应用程序(CLI)开发时,有一些非常有用的库可以帮助您快速构建高效的命令行应用程序。这些库涵盖了从创建命令行接口到绘制 ASCII 图表的各个方面,让您可以以更少的代码实现更多的功能。在本文中,我们将介绍7个最受欢迎的 Python CLI 库,并为您提供一些示例,以便您可以了解它们是如何工作的。
1、Typer
这是GitHub上星标最多的库之一,拥有超过10.5k的星星。该库将帮助您构建用户喜欢使用和开发人员喜欢创建的CLI应用程序。
Typer 是一个用于编写命令行界面(CLI)的 Python 库,它可以帮助开发者轻松地构建复杂的 CLI 应用程序,包括数据分析工具、自动化脚本等等。
Typer 提供了很多方便的功能,例如:
- 自动的帮助生成,让用户可以通过 --help 参数来查看应用程序的文档和使用说明;
- 参数和命令的类型检查和转换,可以确保输入和输出的正确性;
- 命令的自动完成,可以提高用户的输入效率;
- 支持多种风格的命令和参数,包括子命令、选项、参数等等。
使用 Typer 可以让开发者更加专注于应用程序本身的逻辑,而不用过多关注 CLI 的细节实现。因此,它可以大大简化开发流程,提高开发效率。
以下是一个简单的 Typer 使用案例:
import typer
def main(name: str):
print(f"Hello {name}")
if __name__ == "__main__":
typer.run(main)
这个应用程序可以通过命令行接受一个 name 参数,然后向用户打印一个简单的问候语。当我们运行这个应用程序时,可以看到如下输出:
$ python main.py Camila
Hello Camila
因此,Typer 是一个非常有用的 Python 库,可以帮助开发者轻松构建 CLI 应用程序,提高开发效率和用户体验。
https://github.com/tiangolo/typer
2、Click
Click 是一个用于创建漂亮的命令行界面的 Python 包,以最少的代码以可组合的方式进行操作。它是“命令行界面创建工具包”,高度可配置,但开箱即用时也有明智的默认设置。
Click 的目标是使编写命令行工具的过程快速、简单和灵活,同时避免由于无法实现所需的CLI API而引起的任何挫败感。
Click 的主要特点包括:
- 命令任意嵌套:支持多级命令和子命令,让您可以轻松创建复杂的 CLI 工具;
- 自动帮助页面生成:自动生成命令行工具的帮助文档和使用说明,让用户可以轻松了解工具的使用方法;
- 支持运行时懒加载子命令:可以按需加载子命令,减少不必要的内存占用。
通过使用 Click,您可以快速、轻松地构建出漂亮、灵活和易用的命令行工具,同时提高开发效率和用户体验。
以下是官网的一个示例:
import click
@click.command()
@click.option("--count", default=1, help="Number of greetings.")
@click.option("--name", prompt="Your name", help="The person to greet.")
def hello(count, name):
"""Simple program that greets NAME for a total of COUNT times."""
for _ in range(count):
click.echo(f"Hello, {name}!")
if __name__ == '__main__':
hello()
$ python hello.py --count=3
Your name: Click
Hello, Click!
Hello, Click!
Hello, Click!
https://github.com/pallets/click
3、Fire
Fire 是来自 Google 的一个 Python 库,可以从任何 Python 对象自动生成命令行界面(CLI)。它提供了许多功能,比如帮助开发和调试 Python 代码、探索现有代码或将其他人的代码转换为 CLI、使 Bash 和 Python 之间的转换更容易等等。
Fire 支持将任何 Python 类、函数、字典等对象转换为 CLI,并自动生成帮助文档和参数提示信息。这样,开发人员可以快速构建出功能强大、易于使用的命令行工具。
以下是一个使用 Fire 将 Python 类转换为 CLI 的示例:
import fire
class Calculator:
def add(self, x, y):
return x + y
if __name__ == '__main__':
fire.Fire(Calculator)
当您运行这个脚本时,它将自动生成一个名为 "Calculator" 的 CLI 工具,可以通过以下命令将两个数字相加:
$ python calculator.py add 2 3
5
Fire 的另一个强大功能是支持将 Python 中的任何代码片段转换为 CLI 工具。这使得 Fire 可以用于快速探索和测试代码,而无需编写繁琐的命令行解析代码。
Fire 在 GitHub 上拥有超过24k的星星,是一个备受欢迎的 Python 库。
https://github.com/google/python-fire
4. Tqdm
Tqdm 是一个为 Python 和 CLI 提供快速、可扩展进度条的库。在加载数据时显示进度条是提高用户体验的常用方式之一。除了低开销之外,该库还使用智能算法预测剩余时间,并跳过不必要的迭代显示,因此在大多数情况下开销可以忽略不计。
Tqdm 可以适用于各种场景,包括读取大型数据集、处理复杂计算和执行长时间运行的任务等。使用 Tqdm,您可以轻松地为您的 Python 代码和命令行工具添加进度条,并提高用户体验。
以下是一个简单的示例,使用 Tqdm 显示循环的进度条:
from tqdm import tqdm
import time
for i in tqdm(range(10)):
time.sleep(1)
当您运行这段代码时,Tqdm 将自动显示一个进度条,指示循环的进度,以及预计剩余时间。
Tqdm 在 GitHub 上拥有超过24.5k的星星,是一个备受欢迎的 Python 库。
https://github.com/tqdm/tqdm
5、Plumbum
Plumbum 是一个能够让你将 shell 脚本的紧凑性与真正的编程语言相结合的库。除了类似 shell 的语法和方便的快捷方式外,该库还提供了本地和远程命令执行(通过 SSH)、本地和远程文件系统路径、易于操作的工作目录和环境变量,以及程序化的命令行界面(CLI)应用程序工具包等功能。
使用 Plumbum,您可以轻松地以编程方式执行命令、操作文件和文件夹,并创建功能强大的命令行工具。它还支持在本地和远程机器之间进行命令和文件的传输,以及在远程机器上运行命令。
以下是一个使用 Plumbum 执行本地和远程命令的示例:
from plumbum import local, SshMachine
# Local command execution
ls = local["ls"]
print(ls("-a", "/"))
# Remote command execution
remote_machine = SshMachine("remote.host.com", user="user", password="pass")
ls = remote_machine["ls"]
print(ls("-a", "/"))
上述代码中,我们使用 Plumbum 执行了本地和远程的命令,包括列出根目录下的所有文件和文件夹。通过使用 Plumbum,您可以轻松地将 shell 脚本的优点融入到 Python 代码中,并创建出高效、易用的命令行工具。
Plumbum 在 GitHub 上拥有超过 2.5k 的星星,是一个备受欢迎的 Python 库。
https://github.com/tomerfiliba/plumbum
6、 Argcomplete
Argcomplete 是一个可以为 CLI 应用程序添加自动补全功能的库,它支持自动生成补全脚本和不同 shell 的钩子。它支持不同的模式和配置,特别适用于拥有大量选项或子解析器的程序,以及可以动态建议参数/选项值的自动补全(例如,如果用户正在通过网络浏览资源)。自动补全可以大大提高用户的工作效率和体验。
以下是一个简单的示例,演示了如何使用 Argcomplete 添加自动补全到 CLI 工具:
import argparse
import argcomplete
parser = argparse.ArgumentParser()
parser.add_argument('--verbose', action='store_true')
parser.add_argument('--logfile', type=str)
argcomplete.autocomplete(parser)
args = parser.parse_args()
print(args)
在您运行这个脚本时,它将自动为您的 CLI 工具生成自动补全脚本,并将其绑定到适当的 shell 钩子上。这样,您就可以在使用 CLI 工具时自动补全命令和选项,从而大大提高您的工作效率。
Argcomplete 在 GitHub 上拥有超过 1k 的星星,是一个功能强大、易用的 Python 库。
https://github.com/kislyuk/argcomplete
7、Termgraph
Termgraph 是一个用于在 Python 命令行应用程序中绘制 ASCII 图表和图形的库。如果您需要在命令行中展示数据或分析结果,Termgraph 可以帮助您以漂亮的方式展示数据,提高数据可读性和可视化效果。
Termgraph 支持多种类型和样式的绘图和数据格式,包括条形图、颜色图表、表情符号等等。它还支持多种不同的图表类型,可以帮助您轻松地创建各种图表和可视化效果。
运行示例如下所示:
termgraph data/ex1.dat --custom-tick "" --width 20 --title "Running Data"
# Running Data
2007: 183.32
2008: 231.23
2009: 16.43
2010: 50.21
2011: 508.97
2012: 212.05
2014: 1.00
https://github.com/mkaz/termgraph
结束
这些 Python CLI 库为开发人员提供了许多优秀的功能,例如自动补全、自动生成帮助页面、进度条显示等等。无论您是初学者还是有经验的 Python 开发人员,这些库都将为您的命令行应用程序开发带来很大的帮助。您可以选择一个或多个库来使用,以根据您的特定需求和用例创建高效和易于使用的 CLI 应用程序。现在,让我们开始探索这7个库,并发现它们如何可以改善您的 Python CLI 应用程序!
在文章结尾,我想提醒您,文章的创作不易,如果您喜欢我的分享,请别忘了点赞和转发,让更多有需要的人看到。同时,如果您想获取更多前端技术的知识,欢迎关注我,您的支持将是我分享最大的动力。我会持续输出更多内容,敬请期待。
相关推荐
- Alist 玩家请进:一键部署全新分支 Openlist,看看香不香!
-
Openlist(其前身是鼎鼎大名的Alist)是一款功能强大的开源文件列表程序。它能像“万能钥匙”一样,解锁并聚合你散落在各处的云盘资源——无论是阿里云盘、百度网盘、GoogleDrive还是...
- 白嫖SSL证书还自动续签?这个开源工具让我告别手动部署
-
你还在手动部署SSL证书?你是不是也遇到过这些问题:每3个月续一次Let'sEncrypt证书,忘了就翻车;手动配置Nginx,重启服务,搞一次SSL得花一下午;付费证书太贵,...
- Docker Compose:让多容器应用一键起飞
-
CDockerCompose:让多容器应用一键起飞"曾经我也是一个手动启动容器的少年,直到我的膝盖中了一箭。"——某位忘记--link参数的运维工程师引言:容器化的烦恼与...
- 申请免费的SSL证书,到期一键续签
-
大家好,我是小悟。最近帮朋友配置网站HTTPS时发现,还有人对宝塔面板的SSL证书功能还不太熟悉。其实宝塔早就内置了免费的Let'sEncrypt证书申请和一键续签功能,操作简单到连新手都能...
- 飞牛NAS部署TVGate Docker项目,实现内网一键转发、代理、jx
-
前面分享了两期TVGate:Q大的转发代理工具TVGate升级了,操作更便捷,增加了新的功能跨平台内网转发神器TVGate部署与使用初体验现在项目已经开源,并支持Docker部署,本文介绍如何通...
- Docker Compose 编排实战:一键部署多容器应用!
-
当项目变得越来越复杂,一个服务已经无法满足需求时,你可能需要同时部署数据库、后端服务、前端网页、缓存组件……这时,如果还一个一个手动dockerrun,简直是灾难这就是DockerCompo...
- 深度测评:Vue、React 一键部署的神器 PinMe
-
不知道大家有没有这种崩溃瞬间:领导突然要看项目Demo,客户临时要体验新功能,自己写的小案例想发朋友圈;找运维?排期?还要走工单;自己买服务器?域名、SSL、Nginx、防火墙;本地起服务?断电、关...
- 超简单!一键启动多容器,解锁 Docker Compose 极速编排秘籍
-
想要用最简单的方式在本地复刻一套完整的微服务环境?只需一个docker-compose.yml文件,你就能一键拉起N个容器,自动组网、挂载存储、环境隔离,全程无痛!下面这份终极指南,教你如何用...
- 日志文件转运工具Filebeat笔记_日志转发工具
-
一、概述与简介Filebeat是一个日志文件转运工具,在服务器上以轻量级代理的形式安装客户端后,Filebeat会监控日志目录或者指定的日志文件,追踪读取这些文件(追踪文件的变化,不停的读),并将来自...
- K8s 日志高效查看神器,提升运维效率10倍!
-
通常情况下,在部署了K8S服务之后,为了更好地监控服务的运行情况,都会接入对应的日志系统来进行检测和分析,比如常见的Filebeat+ElasticSearch+Kibana这一套组合...
- 如何给网站添加 https_如何给网站添加证书
-
一、简介相信大家都知道https是更加安全的,特别是一些网站,有https的网站更能够让用户信任访问接下来以我的个人网站五岁小孩为例子,带大家一起从0到1配置网站https本次配置的...
- 10个Linux文件内容查看命令的实用示例
-
Linux文件内容查看命令30个实用示例详细介绍了10个Linux文件内容查看命令的30个实用示例,涵盖了从基本文本查看、分页浏览到二进制文件分析的各个方面。掌握这些命令帮助您:高效查看各种文本文件内...
- 第13章 工程化实践_第13章 工程化实践课
-
13.1ESLint+Prettier代码规范统一代码风格配置//.eslintrc.jsmodule.exports={root:true,env:{node...
- 龙建股份:工程项目中标_龙建股份有限公司招聘网
-
404NotFoundnginx/1.6.1【公告简述】2016年9月8日公告,公司于2016年9月6日收到苏丹共和国(简称“北苏丹”)喀土穆州基础设施与运输部公路、桥梁和排水公司出具的中标通知书...
- 福田汽车:获得政府补助_福田 补贴
-
404NotFoundnginx/1.6.1【公告简述】2016年9月1日公告,自2016年8月17日至今,公司共收到产业发展补助、支持资金等与收益相关的政府补助4笔,共计5429.08万元(不含...
你 发表评论:
欢迎- 一周热门
- 最近发表
- 标签列表
-
- python计时 (73)
- python安装路径 (56)
- python类型转换 (93)
- python进度条 (67)
- python吧 (67)
- python的for循环 (65)
- python格式化字符串 (61)
- python静态方法 (57)
- python列表切片 (59)
- python面向对象编程 (60)
- python 代码加密 (65)
- python串口编程 (77)
- python封装 (57)
- python写入txt (66)
- python读取文件夹下所有文件 (59)
- python操作mysql数据库 (66)
- python获取列表的长度 (64)
- python接口 (63)
- python调用函数 (57)
- python多态 (60)
- python匿名函数 (59)
- python打印九九乘法表 (65)
- python赋值 (62)
- python异常 (69)
- python元祖 (57)