如何用python写一个cil

用Python写一个CLI (命令行界面)的方法有很多，常见的方式有使用内置的argparse模块、第三方库Click和Typer等。常见方法包括使用argparse模块、Click库、Typer库等。根据具体需求选择适合的工具。下面将详细介绍如何使用这些工具来创建一个CLI。

一、使用argparse模块

argparse是Python标准库中的一个模块，用于解析命令行参数和选项。它简单、易用且不需要安装第三方库。

1.1、基本用法

首先，我们来看一个简单的例子，创建一个可以接受两个数字并返回它们和的CLI。

import argparse
def main():
    parser = argparse.ArgumentParser(description='计算两个数字的和')
    parser.add_argument('num1', type=int, help='第一个数字')
    parser.add_argument('num2', type=int, help='第二个数字')
    args = parser.parse_args()
    result = args.num1 + args.num2
    print(f'结果是: {result}')
if __name__ == '__main__':
    main()

运行这个脚本时，可以传递两个参数：

python script.py 3 5

输出将是：

结果是: 8

1.2、添加可选参数

可以通过add_argument方法添加可选参数。下面我们扩展一下，添加一个可选的操作参数：

import argparse
def main():
    parser = argparse.ArgumentParser(description='简单的计算器')
    parser.add_argument('num1', type=float, help='第一个数字')
    parser.add_argument('num2', type=float, help='第二个数字')
    parser.add_argument('-o', '--operation', choices=['add', 'sub', 'mul', 'div'], default='add', help='操作类型')
    args = parser.parse_args()
    if args.operation == 'add':
        result = args.num1 + args.num2
    elif args.operation == 'sub':
        result = args.num1 - args.num2
    elif args.operation == 'mul':
        result = args.num1 * args.num2
    elif args.operation == 'div':
        result = args.num1 / args.num2
    print(f'结果是: {result}')
if __name__ == '__main__':
    main()

运行命令：

python script.py 10 5 -o sub

输出将是：

结果是: 5.0

二、使用Click库

Click是一个用于创建命令行接口的第三方库，具有更高的易用性和可读性。首先，需要安装Click：

pip install click

2.1、基本用法

下面是一个使用Click的简单例子：

import click
@click.command()
@click.argument('num1', type=float)
@click.argument('num2', type=float)
@click.option('--operation', '-o', default='add', type=click.Choice(['add', 'sub', 'mul', 'div']), help='操作类型')
def main(num1, num2, operation):
    """简单的计算器"""
    if operation == 'add':
        result = num1 + num2
    elif operation == 'sub':
        result = num1 - num2
    elif operation == 'mul':
        result = num1 * num2
    elif operation == 'div':
        result = num1 / num2
    click.echo(f'结果是: {result}')
if __name__ == '__main__':
    main()

运行命令：

python script.py 10 5 -o mul

输出将是：

结果是: 50.0

2.2、处理多个命令

Click还支持创建具有多个子命令的CLI。下面是一个示例：

import click
@click.group()
def cli():
    pass
@click.command()
@click.argument('num1', type=float)
@click.argument('num2', type=float)
def add(num1, num2):
    """相加两个数字"""
    result = num1 + num2
    click.echo(f'结果是: {result}')
@click.command()
@click.argument('num1', type=float)
@click.argument('num2', type=float)
def sub(num1, num2):
    """相减两个数字"""
    result = num1 - num2
    click.echo(f'结果是: {result}')
cli.add_command(add)
cli.add_command(sub)
if __name__ == '__main__':
    cli()

运行命令：

python script.py add 10 5

输出将是：

结果是: 15.0

三、使用Typer库

Typer是一个基于Click的现代库，具有更强的类型提示支持，使用起来更加简洁。首先，需要安装Typer：

pip install typer

3.1、基本用法

下面是一个使用Typer的简单例子：

import typer
app = typer.Typer()
@app.command()
def calculate(num1: float, num2: float, operation: str = 'add'):
    """简单的计算器"""
    if operation == 'add':
        result = num1 + num2
    elif operation == 'sub':
        result = num1 - num2
    elif operation == 'mul':
        result = num1 * num2
    elif operation == 'div':
        result = num1 / num2
    typer.echo(f'结果是: {result}')
if __name__ == '__main__':
    app()

运行命令：

python script.py calculate 10 5 --operation mul

输出将是：

结果是: 50.0

3.2、处理多个命令

Typer也支持创建具有多个子命令的CLI。下面是一个示例：

import typer
app = typer.Typer()
@app.command()
def add(num1: float, num2: float):
    """相加两个数字"""
    result = num1 + num2
    typer.echo(f'结果是: {result}')
@app.command()
def sub(num1: float, num2: float):
    """相减两个数字"""
    result = num1 - num2
    typer.echo(f'结果是: {result}')
if __name__ == '__main__':
    app()