介绍

Python 因其多功能性和易用性而广为人知，尤其是在构建命令行界面 (CLI) 应用程序时。无论您是想自动执行日常任务、构建开发人员工具还是创建灵活的脚本，Python 丰富的生态系统都提供了各种库来有效处理 CLI。

在这篇博文中，我们将深入探讨如何使用 Python 中的 CLI，涵盖以下内容：

• 为什么要构建 CLI？
• 用于构建 CLI 的 Python 模块
• 命令行参数的基础知识
• 使用 argparse 的高级功能
• 通过单击构建 CLI 工具
• CLI 工具中的错误处理
• 打包 CLI 工具进行分发

在这篇文章结束时，您将能够创建强大且用户友好的命令行应用程序。

为什么要构建 CLI？

CLI 广泛用于系统管理、数据处理和软件开发，因为它们提供：

1. 自动化：编写重复任务脚本以节省时间并减少错误。
2. 简单性：通过几次按键即可运行复杂的命令。
3. 可移植性：一个精心构建的 CLI 工具可以在任何没有 GUI 的机器上使用。
4. 开发者工具：许多开发工具（如 git、npm 和 pip）都是基于 CLI 的。

用于 CLI 开发的 Python 模块

Python 提供了几个用于构建 CLI 工具的库：

1. sys.argv：直接访问命令行参数，适合小型、简单的脚本。
2. argparse：用于处理命令行参数并自动生成帮助的内置模块。
3. click：一个强大而灵活的库，用于创建复杂的 CLI 应用程序。
4. typer：一个基于 click 构建的现代库，它使用 Python 类型提示以方便使用。

使用 sys.argv

sys.argv 是访问命令行参数的基本方法。它将命令行参数存储为列表，其中第一个元素始终是脚本名称。

import sys

# Command-line arguments
print(f"Script Name: {sys.argv[0]}")
print(f"Arguments: {sys.argv[1:]}")

运行脚本：

$ python script.py arg1 arg2 arg3
Script Name: script.py
Arguments: ['arg1', 'arg2', 'arg3']

sys.argv 的限制：

• 无类型检查：所有输入都被视为字符串。
• 没有内置帮助消息：您需要手动验证输入并显示使用信息。

使用 argparse 构建 CLI

argparse 模块是用于创建 CLI 的 Python 标准库。它提供比 sys.argv 更多的控制，并自动生成帮助消息和错误处理。

基本示例：

import argparse

parser = argparse.ArgumentParser(description="A simple CLI tool")
parser.add_argument("name", help="Your name")
parser.add_argument("--greet", help="Custom greeting", default="Hello")

args = parser.parse_args()

print(f"{args.greet}, {args.name}!")

运行脚本：

$ python script.py Alice
Hello, Alice!

$ python script.py Alice --greet Hi
Hi, Alice!

argparse 的主要特点：

1. 位置和可选参数：轻松定义必需和可选参数。
2. 类型检查：确保用户提供正确的数据类型。
3. Choices：使用选项参数将输入限制为特定值。
4. 帮助消息：使用 -h 或 --help 标志自动生成帮助。

类型检查和选择示例：

parser.add_argument("age", type=int, help="Your age")
parser.add_argument("--format", choices=["json", "xml"], help="Output format")

运行脚本：

$ python script.py Alice 30 --format json

单击高级 CLI 工具

click 是一个用于创建命令行界面的更高级的库。它提供了一种基于装饰器的方法来定义命令、子命令和选项。

为什么要使用点击？

• 更好的可读性：更Pythonic、基于装饰器的语法。
• 自动参数验证：确保参数得到正确验证。
• 可重用组件：命令、选项和参数可以在应用程序的不同部分轻松重用。

使用click的基本示例：

import click

@click.command()
@click.option('--name', prompt='Your name', help='The person to greet.')
@click.option('--greet', default="Hello", help='Greeting to use.')
def greet(name, greet):
    """Simple program that greets NAME with a GREET."""
    click.echo(f'{greet}, {name}!')

if __name__ == '__main__':
    greet()

运行脚本：

$ python greet.py --name Alice --greet Hi
Hi, Alice!

点击子命令：

您可以使用多个子命令创建更复杂的 CLI 工具。

import click

@click.group()
def cli():
    pass

@cli.command()
def start():
    click.echo("Starting the application...")

@cli.command()
def stop():
    click.echo("Stopping the application...")

if __name__ == '__main__':
    cli()

运行脚本：

$ python app.py start
Starting the application...

$ python app.py stop
Stopping the application...

CLI 工具中的错误处理

无论您使用哪个库，错误处理对于提供流畅的用户体验都至关重要。

argparse 中的示例：

如果缺少必需的参数，argparse 将抛出错误并显示使用说明：

$ python script.py
usage: script.py [-h] name
script.py: error: the following arguments are required: name

点击错误处理：

在单击中，您可以使用装饰器引发自定义异常并优雅地处理错误。

@click.command()
@click.option('--count', type=int, help='Number of repetitions')
def repeat(count):
    if count is None or count 







  
  
  将 argparse 和 click 与其他库结合起来


要扩展 CLI 功能，您可以将 argparse 或 click 与其他库（如操作系统、子进程，甚至自定义库）结合起来。


  
  
  示例：将 argparse 与 os 结合起来




import os
import argparse

parser = argparse.ArgumentParser(description="File operations CLI")
parser.add_argument("filename", help="Name of the file to check")
parser.add_argument("--create", action="store_true", help="Create the file if it does not exist")

args = parser.parse_args()

if os.path.exists(args.filename):
    print(f"{args.filename} already exists.")
else:
    if args.create:
        with open(args.filename, 'w') as f:
            f.write("New file created.")
        print(f"{args.filename} created.")
    else:
        print(f"{args.filename} does not exist.")




运行脚本：



$ python filecli.py example.txt --create
example.txt created.








  
  
  打包您的 CLI 工具


要分发 CLI 工具，您可以使用 setuptools 对其进行打包，并使其在任何系统上均可全局访问。


  
  
  第1步：创建setup.py文件




from setuptools import setup

setup(
    name='greet-cli',
    version='0.1',
    py_modules=['greet'],
    install_requires=[
        'click',
    ],
    entry_points='''
        [console_scripts]
        greet=greet:greet
    ''',
)





  
  
  第 2 步：在本地安装 CLI




$ pip install --editable .




现在，greet 命令全局可用：



$ greet --name Alice
Hello, Alice!





  
  
  在 PyPI 上分发


要公开分发您的工具，请创建一个 PyPI 帐户并按照以下步骤上传您的包：


构建包：



   python setup.py sdist bdist_wheel





上传包：



   twine upload dist/*








  
  
  构建 CLI 的最佳实践




提供清晰的帮助消息：始终包含 --help 来指导用户。

验证输入：使用类型检查并优雅地处理异常。

设计直观的命令：确保您的命令结构符合逻辑且易于使用。

使用边缘情况进行测试：即使输入无效，也确保您的 CLI 工具正常运行。

模块化您的代码：将命令行逻辑与核心功能分开，以便于测试和维护。






  
  
  结论


Python 提供了一个用于构建命令行界面 (CLI) 应用程序的优秀工具包。无论您使用内置的 argparse 模块还是功能更丰富的单击，您都可以创建功能强大、用户友好的工具，这些工具可以自动化工作流程、处理数据并提高生产力。

现在您已经了解了在 Python 中使用 CLI 的基础知识和高级功能，是时候将其付诸实践了。构建您自己的工具，分享它，甚至在全球范围内分发它！




如有问题或建议，请随时联系：

• 领英
• GitHub