前言
写 Python 的经常要写一些命令行工具,虽然标准库提供有命令行解析工具 Argparse,但是写起来非常麻烦,我很少会使用它。命令行工具中用起来最爽的就是 Click,它是 Flask 的团队 pallets 的开源项目。Click 只要很少的代码就可以优雅地创造一个命令行工具,它致力于将创建命令行工具的过程变的快速而有趣。
百闻不如一试
安装
pip install Click
使用
创建 click_demo.py ,写一个最简单的函数
import click @click.command() def hello(): click.echo('Hello World!') if __name__ == '__main__': hello()
运行:
python click_demo.py Hello World!
装饰器 click.command() 使函数秒变命令行工具,echo 函数的作用等同于 print 函数。
参数
装饰器 click.option()可以给命令行函数指定参数
import click @click.command() @click.option("--count", default=1, help="打印次数", type=int) def hello(count): """ 这是一个简单示例 """ for i in range(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 and exit.
指定参数:
>python click_demo.py --count 3 Hello World! Hello World! Hello World!
prompt
有些命令行工具在运行的时候要求用户输入信息,可以给 option 装饰器指定 prompt 参数
import click @click.command() @click.option("--count", default=1, help="打印次数", type=int) @click.option("--name", prompt="请输入名字", help="姓名") def hello(count, name): """ 这是一个简单示例 """ for i in range(count): click.echo(f'Hello {name}!') if __name__ == '__main__': hello()
$ python click_demo.py 请输入名字: lzjun Hello lzjun!
Group
Click 很重要的一个特性就是它的分组功能,当一个命令行工具的逻辑已经非常复杂的时候,为了解耦,我们需要将不同的逻辑放在不同的命令中,这样既可以避免单个命令行工具函数臃肿。来看个例子:
# db.py import click @click.group() def db(): pass @click.command() @click.option("--name", help="用户名") def add(name): """ 添加用户 :param name: :return: """ click.echo(f'add user {name}') @click.command() @click.option("--id", help="用户名") def delete(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 and exit. Commands: add 添加用户 :param name: :return: delete 删除用户 :param id: :return:
从帮助文档中我们看到 add 和 delete 就是两个子命令。 Flask 框架的 flask 命令也是一个 Group 命令。
$ flask Usage: flask [OPTIONS] COMMAND [ARGS]... A general utility script for Flask applications. Provides commands from Flask, extensions, and the application. Loads the application defined in the FLASK_APP environment variable, or from a wsgi.py file. Setting the FLASK_ENV environment variable to 'development' will enable debug mode. $ export FLASK_APP=hello.py $ export FLASK_ENV=development $ flask run Options: --version Show the flask version --help Show this message and exit. Commands: add_user 添加账号 :param name: :param username: :param password:... init_invite_code 添加邀请码 recommend_account 更新推荐账号 routes Show the routes for the app. run Runs a development server. shell Runs a shell in the app context.
提供了几个预定义的子命令和自定义的命令。
以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。
免责声明:本站文章均来自网站采集或用户投稿,网站不提供任何软件下载或自行开发的软件! 如有用户或公司发现本站内容信息存在侵权行为,请邮件告知! 858582#qq.com
《魔兽世界》大逃杀!60人新游玩模式《强袭风暴》3月21日上线
暴雪近日发布了《魔兽世界》10.2.6 更新内容,新游玩模式《强袭风暴》即将于3月21 日在亚服上线,届时玩家将前往阿拉希高地展开一场 60 人大逃杀对战。
艾泽拉斯的冒险者已经征服了艾泽拉斯的大地及遥远的彼岸。他们在对抗世界上最致命的敌人时展现出过人的手腕,并且成功阻止终结宇宙等级的威胁。当他们在为即将于《魔兽世界》资料片《地心之战》中来袭的萨拉塔斯势力做战斗准备时,他们还需要在熟悉的阿拉希高地面对一个全新的敌人──那就是彼此。在《巨龙崛起》10.2.6 更新的《强袭风暴》中,玩家将会进入一个全新的海盗主题大逃杀式限时活动,其中包含极高的风险和史诗级的奖励。
《强袭风暴》不是普通的战场,作为一个独立于主游戏之外的活动,玩家可以用大逃杀的风格来体验《魔兽世界》,不分职业、不分装备(除了你在赛局中捡到的),光是技巧和战略的强弱之分就能决定出谁才是能坚持到最后的赢家。本次活动将会开放单人和双人模式,玩家在加入海盗主题的预赛大厅区域前,可以从强袭风暴角色画面新增好友。游玩游戏将可以累计名望轨迹,《巨龙崛起》和《魔兽世界:巫妖王之怒 经典版》的玩家都可以获得奖励。