分享7个 Python CLI 库，助您快速构建高效命令行应用程序

liftword3周前 (12-04)技术文章12

转载说明：原创不易，未经授权，谢绝任何形式的转载

加强你的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 应用程序！

在文章结尾，我想提醒您，文章的创作不易，如果您喜欢我的分享，请别忘了点赞和转发，让更多有需要的人看到。同时，如果您想获取更多前端技术的知识，欢迎关注我，您的支持将是我分享最大的动力。我会持续输出更多内容，敬请期待。

蜀ICP备2024111239号-1