前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >Python命令行神器 Click 快速上手

Python命令行神器 Click 快速上手

作者头像
IT阅读排行榜
发布2019-05-17 16:10:30
1.1K0
发布2019-05-17 16:10:30
举报
文章被收录于专栏:华章科技

导读:写 Python 的经常要写一些命令行工具,虽然标准库提供有命令行解析工具 Argparse,但是写起来非常麻烦,我很少会使用它。命令行工具中用起来最爽的就是 Click,它是 Flask 的团队 pallets 的开源项目。Click 只要很少的代码就可以优雅地创造一个命令行工具,它致力于将创建命令行工具的过程变的快速而有趣。

01 安装

代码语言:javascript
复制
pip install Click

02 使用

创建 click_demo.py ,写一个最简单的函数

代码语言:javascript
复制
import click

@click.command()
def hello():
click.echo('Hello World!')

if __name__ == '__main__':
hello()

运行:

代码语言:javascript
复制
python click_demo.py
Hello World!

装饰器 click.command() 使函数秒变命令行工具,echo 函数的作用等同于 print 函数。

03 参数

装饰器 click.option()可以给命令行函数指定参数

代码语言:javascript
复制
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 就可以查看说明文档。

代码语言:javascript
复制
$ python click_demo.py --help

Usage: click_demo.py [OPTIONS]

这是一个简单示例

Options:
--count INTEGER  打印次数
--help        Show this message and exit.

指定参数:

代码语言:javascript
复制
>python click_demo.py --count 3

Hello World!
Hello World!
Hello World!

04 prompt

有些命令行工具在运行的时候要求用户输入信息,可以给 option 装饰器指定 prompt 参数。

代码语言:javascript
复制
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()
代码语言:javascript
复制
$ python click_demo.py

请输入名字: lzjun
Hello lzjun!

05 Group

Click 很重要的一个特性就是它的分组功能,当一个命令行工具的逻辑已经非常复杂的时候,为了解耦,我们需要将不同的逻辑放在不同的命令中,这样既可以避免单个命令行工具函数臃肿。来看个例子:

代码语言:javascript
复制
# 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 可以添加很多子命令。

代码语言:javascript
复制
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:

从帮助文档中我们看到 adddelete 就是两个子命令。

Flask 的命令行工具 "flask" 也提供有很多子命令,感兴趣的可以自己查看一下。

据统计,99%的大咖都完成了这个神操作

本文参与 腾讯云自媒体同步曝光计划,分享自微信公众号。
原始发表:2019-05-14,如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 大数据DT 微信公众号,前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体同步曝光计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • 01 安装
  • 02 使用
  • 03 参数
  • 04 prompt
  • 05 Group
相关产品与服务
命令行工具
腾讯云命令行工具 TCCLI 是管理腾讯云资源的统一工具。使用腾讯云命令行工具,您可以快速调用腾讯云 API 来管理您的腾讯云资源。此外,您还可以基于腾讯云的命令行工具来做自动化和脚本处理,以更多样的方式进行组合和重用。
领券
问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档