使用Click添加命令行参数
Click是一个Python库,用于创建命令行界面(CLI)应用程序。它提供了一种简单而灵活的方式来定义命令、参数和选项,并生成帮助信息。
安装方法
pip install click
简单示例
# cli.py
import click
@click.command()
@click.argument('method')
@click.option('-a', type=int, help='variable a')
@click.option('-b', type=int, help='variable b')
def main(method, a, b):
"""Calc"""
if method == 'add':
print(f'{a} + {b} =', a + b)
elif method == 'sub':
print(f'{a} + {b} =', a + b)
if __name__ == '__main__':
main()
@click.command()
: 为函数添加命令行参数支持@click.argument()
: 添加位置参数@click.option()
: 添加选项参数
接下来,我们定义了一个hello()函数,用于实现打招呼的功能。在函数中,我们使用click.echo()方法输出打招呼的信息。
最后,我们在if __name__ == '__main__'
语句中调用hello()
函数,以启动命令行应用程序。
可以在命令行中运行该脚本,并传递选项参数来测试,例如:
查看帮助信息:
$ python cli.py --help
python cli.py --help
Usage: cli.py [OPTIONS] METHOD
Calc
Options:
-a TEXT variable a
-b TEXT variable b
--help Show this message and exit.
传入参数使用:
$ python cli.py add -a1 -b2
1 + 2 = 3
Click库提供了丰富的功能,可以处理各种类型的命令、参数和选项,包括位置参数、可选参数、标志参数等。它还支持生成帮助信息和错误提示,以提供良好的用户体验。你可以参考Click官方文档,了解更多详细信息和用法示例。