Python知识点：如何使用Python开发命令行工具

杰哥在此

于 2024-09-08 08:52:55 发布

阅读量1k

点赞数 14

分类专栏： Python系列文章标签： python java 服务器编程面试

本文链接：https://blog.csdn.net/bigorsmallorlarge/article/details/142015475

版权

Python系列专栏收录该内容

148 篇文章 4 订阅

订阅专栏

使用 Python 开发命令行工具可以让你创建简单、易用的程序供其他用户在终端上运行。这类工具对于自动化任务、批量处理文件、以及提供快速操作的功能非常有用。Python 自带的标准库提供了非常强大的工具来构建命令行应用程序，如 argparse、click 等。以下是开发一个 Python 命令行工具的详细步骤。

1. 选择合适的命令行库

开发命令行工具有多种库可用，以下是几种常见的库：

argparse：Python 标准库中的命令行参数解析模块，适合于简单到中等复杂的命令行工具。
click：第三方库，语法简洁，适合开发更为复杂的 CLI 工具。
typer：基于 click 的库，使用 Python 的类型提示进行更加简洁的命令行工具开发。

以下以 argparse 和 click 为例，介绍如何开发命令行工具。

2. 使用 `argparse` 开发命令行工具

argparse 是 Python 标准库中的模块，主要用于处理命令行参数。以下是使用 argparse 开发简单命令行工具的步骤。

示例：一个简单的加法器

import argparse

def add(a, b):
    return a + b

if __name__ == "__main__":
    # 初始化解析器
    parser = argparse.ArgumentParser(description="命令行加法器")
    
    # 添加命令行参数
    parser.add_argument("a", type=int, help="第一个加数")
    parser.add_argument("b", type=int, help="第二个加数")
    
    # 解析参数
    args = parser.parse_args()
    
    # 执行加法运算
    result = add(args.a, args.b)
    
    print(f"{args.a} + {args.b} = {result}")

运行方法

假设上面的代码保存在 adder.py 文件中，可以通过以下方式运行命令行工具：

python adder.py 3 5

输出：

3 + 5 = 8

`argparse` 的更多功能

可选参数：除了必需的参数，argparse 还支持添加可选参数。例如添加一个 --verbose 标志：
```
parser.add_argument("-v", "--verbose", action="store_true", help="输出详细信息")
```

默认值：你可以为某些参数设置默认值：

parser.add_argument("-n", "--number", type=int, default=10, help="要处理的数字，默认为10")

3. 使用 `click` 开发命令行工具

click 是一个流行的第三方库，它比 argparse 更加简洁，且支持开发更加复杂的 CLI 工具。安装 click：

pip install click

示例：使用 `click` 开发加法器

import click

@click.command()
@click.argument('a', type=int)
@click.argument('b', type=int)
def add(a, b):
    """简单加法器，接收两个整数作为参数并输出结果"""
    click.echo(f"{a} + {b} = {a + b}")

if __name__ == "__main__":
    add()

运行方法

与 argparse 类似，假设文件名为 adder.py，可以通过以下方式运行：

python adder.py 3 5

输出：

3 + 5 = 8

`click` 的更多功能

可选参数：click 也支持使用可选参数，例如添加一个 --verbose 参数：

@click.option('--verbose', is_flag=True, help="输出详细信息")
def add(a, b, verbose):
    result = a + b
    if verbose:
        click.echo(f"正在计算: {a} + {b}")
    click.echo(f"结果: {result}")

子命令：click 可以非常方便地支持多级命令行工具（如 git 的子命令）。例如，定义一个包含多个子命令的工具：

import click

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

@cli.command()
@click.argument('a', type=int)
@click.argument('b', type=int)
def add(a, b):
    click.echo(f"{a} + {b} = {a + b}")

@cli.command()
@click.argument('a', type=int)
@click.argument('b', type=int)
def subtract(a, b):
    click.echo(f"{a} - {b} = {a - b}")

if __name__ == "__main__":
    cli()

运行时可以使用子命令：

python tool.py add 3 5
python tool.py subtract 10 4

4. 打包命令行工具

为了让命令行工具更加易于分发和安装，可以使用 setuptools 将 Python 脚本打包为可执行的命令行工具。

创建 `setup.py`

你可以创建一个 setup.py 文件，用于定义工具的打包信息：

from setuptools import setup, find_packages

setup(
    name="adder-cli",
    version="0.1",
    py_modules=["adder"],
    install_requires=["click"],
    entry_points="""
        [console_scripts]
        adder=adder:add
    """,
)

py_modules 定义工具所在的模块。
install_requires 是工具依赖的库。
entry_points 是命令行入口点，将 adder.py 中的 add 函数映射为命令行工具 adder。

安装命令行工具

运行以下命令可以将工具安装到系统环境中：

pip install .

安装成功后，你可以通过以下方式运行命令行工具：

adder 3 5

5. 测试命令行工具

开发命令行工具时，测试是非常重要的步骤。你可以使用 unittest 或 pytest 来测试命令行工具的输出。

以下是一个简单的 pytest 测试示例，用于测试 click 工具：

import click
from click.testing import CliRunner
from adder import add

def test_add():
    runner = CliRunner()
    result = runner.invoke(add, ['3', '5'])
    assert result.exit_code == 0
    assert '3 + 5 = 8' in result.output