[每日一氵] python创建简单 command-line interface (CLI) API

冉俊德
2023-12-01

以前用不惯命令行,今天看别人源码,用Python click 库创建一个命令行API,简洁优雅,举个例子:

import click


# 首先加上 command 装饰器
@click.command()

# 接下来添加几个 option 装饰器, 用法就和 argparse 大体相同, 但是比 argparse 好用多了!!
# 这是字符串参数
@click.option('-i', 
              '--img-path', 
              default='./default.png',
              type=str, required=True, help='show image demo')
# 这是 int 参数
@click.option('--width', type=int, default=640, help='width')
@click.option('--height', type=int, default=360, help='height')

# 这是 枚举 参数
@click.option('-s', '--stage', type=click.Choice(['train', 'val']), default='train', help='data stage')
# 这是 布尔 参数
@click.option('--async-mode/--no-async-mode', default=True, help='async mode or debug mode')
def stupid_scri(img_path, width, height, stage, async_mode):
    print(img_path, width, height, stage, async_mode)

以上是相当于写了个函数 stupid_scri,接下来要调用一下

if __name__ == "__main__":
    stupid_scri()

接下里外部调用一下:

$ python3 stupid_scri.py
./default.png 640 360 train True
$ python3 stupid_scri.py --height 3333
./default.png 640 3333 train True

我还找到了click的中文文档,社区开发者翻译的:
https://click-docs-zh-cn.readthedocs.io/zh/latest/

 类似资料: