原标题:Python命令行神器 Click 快速上手
导读:写 Python 的经常要写一些命令行工具,虽然标准库提供有命令行解析工具 Argparse,但是写起来非常麻烦,我很少会使用它。命令行工具中用起来最爽的就是 Click,它是 Flask 的团队 pallets 的开源项目。Click 只要很少的代码就可以优雅地创造一个命令行工具,它致力于将创建命令行工具的过程变的快速而有趣。
百闻不如一试!
作者:刘志军
来源:Python之禅(ID:VTtalk)
01 安装
pip install Click
02 使用
创建 click_demo.py ,写一个最简单的函数
importclick
@click.command()
defhello():
click.echo( 'Hello World!')
if__name__ == '__main__':
hello()
运行:
python click_demo.py
Hello World!
装饰器click.command()使函数秒变命令行工具,echo函数的作用等同于 print 函数。
03 参数
装饰器click.option()可以给命令行函数指定参数
importclick
@click.command()
@click.option("--count", default=1, help="打印次数", type=int)
defhello(count):
"""
这是一个简单示例
"""
fori inrange(count):
click.echo( 'Hello World!')
if__name__ == '__main__':
hello()
—count:count是参数的名字
default :参数的默认值
type:给参数指定类型
help:说明文档
执行脚本的时候后面加上参数--help就可以查看说明文档。
$ python click_demo.py --help
Usage: click_demo.py [OPTIONS]
这是一个简单示例
Options:
--count INTEGER 打印次数
--help Show this message andexit.
指定参数:
>python click_demo.py --count 3
Hello World!
Hello World!
Hello World!
04 prompt
有些命令行工具在运行的时候要求用户输入信息,可以给option装饰器指定prompt参数。
importclick
@click.command()
@click.option("--count", default=1, help="打印次数", type=int)
@click.option("--name", prompt="请输入名字", help="姓名")
defhello(count, name):
"""
这是一个简单示例
"""
fori inrange(count):
click.echo( f'Hello {name}!')
if__name__ == '__main__':
hello()
$ python click_demo.py
请输入名字: lzjun
Hello lzjun!
05 Group
Click 很重要的一个特性就是它的分组功能,当一个命令行工具的逻辑已经非常复杂的时候,为了解耦,我们需要将不同的逻辑放在不同的命令中,这样既可以避免单个命令行工具函数臃肿。来看个例子:
# db.py
importclick
@click.group()
defdb():
pass
@click.command()
@click.option("--name", help="用户名")
defadd(name):
"""
添加用户
:param name:
:return:
"""
click.echo( f'add user {name}')
@click.command()
@click.option("--id", help="用户名")
defdelete(id):
"""
删除用户
:param id:
:return:
"""
click.echo( f'delete user {id}')
db.add_command(delete)
db.add_command(add)
if__name__ == '__main__':
db()
这是一个操作数据库DB的命令行工具,提供了添加用户和删除用户的命令行等其它操作,如果所有的业务逻辑全部写在一个函数,维护变得异常困难。
@click.group装饰器把函数装饰成为一个Group对象,通过 Group 可以添加很多子命令。
python db.py --help
Usage: db.py [OPTIONS] COMMAND [ARGS]...
Options:
--help Show this message andexit.
Commands:
add 添加用户 :param name: : return:
delete 删除用户 :param id: : return:
从帮助文档中我们看到add和delete就是两个子命令。
Flask 的命令行工具 "flask" 也提供有很多子命令,感兴趣的可以自己查看一下。
▼
Q:你会用这款神器了吗?
转载 / 投稿请联系:baiyu@hzbook.com返回搜狐,查看更多
责任编辑: