Python命令行神器 Click 入门笔记
高级教学参考:
- https://zhuanlan.zhihu.com/p/93738095
Click
Click(https://github.com/pallets/click) 是用 Python 写的一个第三方模块,用于快速创建命令行。我们知道,Python 内置了一个 Argparse(https://docs.python.org/2/howto/argparse.html) 的标准库用于创建命令行,但使用起来有些繁琐,Click 相比于 Argparse,就好比 requests 相比于 urllib。
快速使用
Click 的使用大致有两个步骤:
使用 @click.command()装饰一个函数,使之成为命令行接口;
使用 @click.option()等装饰函数,为其添加命令行选项等。
它的一种典型使用形式如下:
import click@click.command()
@click.option('--param', default=default_value, help='description')
def func(param):pass
下面,让我们看一下官方文档(http://click.pocoo.org/6/)的入门例子:
import click@click.command()
@click.option('--count', default=1, help='Number of greetings.')
@click.option('--name', prompt='Your name', help='The person to greet.')
def hello(count, name):"""Simple program that greets NAME for a total of COUNT times."""for x in range(count):click.echo('Hello %s!' % name)if __name__ == '__main__':hello()
在上面的例子中,函数 hello 有两个参数:count 和 name,它们的值从命令行中获取。
- @click.command() 使函数 hello 成为命令行接口;
- @click.option 的第一个参数指定了命令行选项的名称,可以看到,count 的默认值是 1;
- 使用 click.echo 进行输出是为了获得更好的兼容性,因为 print在 Python2 和 Python3 的用法有些差别。
看看执行情况:
$ python hello.py
Your name: Ethan # 这里会显示 'Your name: '(对应代码中的 prompt),接受用户输入
Hello Ethan!$ python hello.py --help # click 帮我们自动生成了 `--help` 用法
Usage: hello.py [OPTIONS]Simple program that greets NAME for a total of COUNT times.Options:--count INTEGER Number of greetings.--name TEXT The person to greet.--help Show this message and exit.$ python hello.py --count 3 --name Ethan # 指定 count 和 name 的值
Hello Ethan!
Hello Ethan!
Hello Ethan!$ python hello.py --count=3 --name=Ethan # 也可以使用 `=`,和上面等价
Hello Ethan!
Hello Ethan!
Hello Ethan!$ python hello.py --name=Ethan # 没有指定 count,默认值是 1
Hello Ethan!
click.option
option 最基本的用法就是通过指定命令行选项的名称,从命令行读取参数值,再将其传递给函数。在上面的例子,我们看到,除了设置命令行选项的名称,我们还会指定默认值,help 说明等,option 常用的设置参数如下:
- default: 设置命令行参数的默认值
- help: 参数说明
- type: 参数类型,可以是 string, int, float 等
- prompt: 当在命令行中没有输入相应的参数时,会根据 prompt 提示用户输入
- nargs: 指定命令行参数接收的值的个数
下面,我们再看看相关的例子。
指定Type
我们可以使用 type 来指定参数类型:
import click@click.command()
@click.option('--rate', type=float, help='rate') # 指定 rate 是 float 类型
def show(rate):click.echo('rate: %s' % rate)if __name__ == '__main__':show()
执行情况:
$ python click_type.py --rate 1
rate: 1.0
$ python click_type.py --rate 0.66
rate: 0.66
可选值
在某些情况下,一个参数的值只能是某些可选的值,如果用户输入了其他值,我们应该提示用户输入正确的值。在这种情况下,我们可以通过 click.Choice() 来限定:
import click@click.command()
@click.option('--gender', type=click.Choice(['man', 'woman'])) # 限定值
def choose(gender):click.echo('gender: %s' % gender)if __name__ == '__main__':choose()
执行情况:
$ python click_choice.py --gender boy
Usage: click_choice.py [OPTIONS]Error: Invalid value for "--gender": invalid choice: boy. (choose from man, woman)$ python click_choice.py --gender man
gender: man
多值参数
有时,一个参数需要接收多个值。option 支持设置固定长度的参数值,通过 nargs指定。
看看例子就明白了:
import click@click.command()
@click.option('--center', nargs=2, type=float, help='center of the circle')
@click.option('--radius', type=float, help='radius of the circle')
def circle(center, radius):click.echo('center: %s, radius: %s' % (center, radius))if __name__ == '__main__':circle()
在上面的例子中,option 指定了两个参数:center 和 radius,其中,center 表示二维平面上一个圆的圆心坐标,接收两个值,以元组的形式将值传递给函数,而 radius 表示圆的半径。执行情况:$ python click_multi_values.py --center 3 4 --radius 10
center: (3.0, 4.0), radius: 10.0$ python click_multi_values.py --center 3 4 5 --radius 10
Usage: click_multi_values.py [OPTIONS]Error: Got unexpected extra argument (5)
输入密码
有时,在输入密码的时候,我们希望能隐藏显示。option 提供了两个参数来设置密码的输入:hide_input 和 confirmation_promt,其中,hide_input 用于隐藏输入,confirmation_promt 用于重复输入。
看看例子:
import click@click.command()
@click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True)
def input_password(password):click.echo('password: %s' % password)if __name__ == '__main__':input_password()
执行情况:
$ python click_password.py
Password: # 不会显示密码
Repeat for confirmation: # 重复一遍
password: 666666
由于上面的写法有点繁琐,click 也提供了一种快捷的方式,通过使用@click.password_option(),上面的代码可以简写成:
import click@click.command()
@click.password_option()
def input_password(password):click.echo('password: %s' % password)if __name__ == '__main__':input_password()
改变命令行程序的执行
有些参数会改变命令行程序的执行,比如在终端输入 python 是进入 python 控制台,而输入 python –version 是打印 python 版本。Click 提供 eager 标识对参数名进行标识,如果输入该参数,则会拦截既定的命令行执行流程,跳转去执行一个回调函数。
让我们看看例子:
import clickdef print_version(ctx, param, value):if not value or ctx.resilient_parsing:returnclick.echo('Version 1.0')ctx.exit()@click.command()
@click.option('--version', is_flag=True, callback=print_version,expose_value=False, is_eager=True)
@click.option('--name', default='Ethan', help='name')
def hello(name):click.echo('Hello %s!' % name)if __name__ == '__main__':hello()
其中:
- is_eager=True 表明该命令行选项优先级高于其他选项;
- expose_value=False 表示如果没有输入该命令行选项,会执行既定的命令行流程;
- callback 指定了输入该命令行选项时,要跳转执行的函数;
执行情况:
$ python click_eager.py
Hello Ethan!$ python click_eager.py --version # 拦截既定的命令行执行流程
Version 1.0$ python click_eager.py --name Michael
Hello Michael!$ python click_eager.py --version --name Ethan # 忽略 name 选项
Version 1.0
我们除了使用 @click.option 来添加可选参数,还会经常使用@click.argument 来添加固定参数。它的使用和 option 类似,但支持的功能比 option 少。
入门使用
下面是一个简单的例子:
import click@click.command()
@click.argument('coordinates')
def show(coordinates):click.echo('coordinates: %s' % coordinates)if __name__ == '__main__':show()
看看执行情况:
$ python click_argument.py # 错误,缺少参数 coordinates
Usage: click_argument.py [OPTIONS] COORDINATESError: Missing argument "coordinates".$ python click_argument.py --help # argument 指定的参数在 help 中没有显示
Usage: click_argument.py [OPTIONS] COORDINATESOptions:--help Show this message and exit.$ python click_argument.py --coordinates 10 # 错误用法,这是 option 参数的用法
Error: no such option: --coordinates$ python click_argument.py 10 # 正确,直接输入值即可
coordinates: 10
多个 argument
我们再来看看多个 argument 的例子:
import click@click.command()
@click.argument('x')
@click.argument('y')
@click.argument('z')
def show(x, y, z):click.echo('x: %s, y: %s, z:%s' % (x, y, z))if __name__ == '__main__':show()
执行情况:
$ python click_argument.py 10 20 30
x: 10, y: 20, z:30$ python click_argument.py 10
Usage: click_argument.py [OPTIONS] X Y ZError: Missing argument "y".$ python click_argument.py 10 20
Usage: click_argument.py [OPTIONS] X Y ZError: Missing argument "z".$ python click_argument.py 10 20 30 40
Usage: click_argument.py [OPTIONS] X Y ZError: Got unexpected extra argument (40)
不定参数
argument 还有另外一种常见的用法,就是接收不定量的参数,让我们看看例子:
import click@click.command()
@click.argument('src', nargs=-1)
@click.argument('dst', nargs=1)
def move(src, dst):click.echo('move %s to %s' % (src, dst))if __name__ == '__main__':move()
其中,nargs=-1 表明参数 src 接收不定量的参数值,参数值会以 tuple 的形式传入函数。如果 nargs 大于等于 1,表示接收nargs个参数值,上面的例子中,dst 接收一个参数值。
让我们看看执行情况:
$ python click_argument.py file1 trash # src=('file1',) dst='trash'
move (u'file1',) to trash$ python click_argument.py file1 file2 file3 trash # src=('file1', 'file2', 'file3') dst='trash'
move (u'file1', u'file2', u'file3') to trash
彩色输出
在前面的例子中,我们使用 click.echo 进行输出,如果配合 colorama 这个模块,我们可以使用 click.secho 进行彩色输出,在使用之前,使用 pip 安装 colorama:
$ pip install colorama
看看例子:
import click@click.command()
@click.option('--name', help='The person to greet.')
def hello(name):click.secho('Hello %s!' % name, fg='red', underline=True)click.secho('Hello %s!' % name, fg='yellow', bg='black')if __name__ == '__main__':hello()
其中:
- fg 表示前景颜色(即字体颜色),可选值有:BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等;
- bg表示背景颜色,可选值有:BLACK, RED, GREEN, YELLOW, BLUE, MAGENTA, CYAN, WHITE 等;
- underline 表示下划线,可选的样式还有:dim=True,bold=True等;
小结
- 使用click.command()装饰一个函数,使其成为命令行接口。
- 使用click.option()添加可选参数,支持设置固定长度的参数值。
- 使用 click.argument() 添加固定参数,支持设置不定长度的参数值。
Python命令行神器 Click 入门笔记相关推荐
- 命令行神器 Click 简明笔记
Click Click 是用 Python 写的一个第三方模块,用于快速创建命令行.我们知道,Python 内置了一个 Argparse 的标准库用于创建命令行,但使用起来有些繁琐,Click 相比于 ...
- python 命令行 模块_深入浅析Python 命令行模块 Click
Click 是用 Python 写的一个第三方模块,用于快速创建命令行.我们知道,Python 内置了一个 Argparse 的标准库用于创建命令行,但使用起来有些繁琐,Click 相比于 Argpa ...
- python命令行工具是什么_Python 命令行神器 Click
Click 是一个用于快速创建命令行工具的 Python 支持库,Click 具有高度可配置性,使用非常少的代码就可以创造一个优雅的命令行工具,Click 使创建命令行工具变得快速而有趣. 实际上 P ...
- python命令行操作:Click包
0 前言 在Python开发和测试过程中主要有两种模式可以选择:脚本模式.命令行模式.在代码的开发和调试过程中使用脚本模式还是很方便的,尤其接触pycharm.eclipse这类强大的IDE,或者配合 ...
- python 基础命令-Python 命令行(CLI)基础库
在 CLI 下写 UI 应用 前阵子看了一下自己去年写的 Python-视频转字符动画,感觉好糗..所以几乎把整篇文章重写了一遍.并使用 curses 库实现字符动画的播放. 但是感觉,curses ...
- Python 命令行参数:Argparse 与 Click
Python 命令行参数:Argparse 与 Click 简介 一.Argparse 模块 1.1 概念 1.2 基础 1.3 位置参数介绍 1.4 可选参数介绍 1.5 短选项 1.6 结合位置参 ...
- 退出python命令行-退出python命令
广告关闭 2017年12月,云+社区对外发布,从最开始的技术博客到现在拥有多个社区产品.未来,我们一起乘风破浪,创造无限可能. 在linux环境下退出python命令模式原创 2016年11月03日 ...
- python 命令行参数-Python处理命令行参数
1. 将命令行参数保存在列表中,注意argv[0]是程序本身的名字: import sys print(sys.argv) print(sys.argv[1]) python argv.py loca ...
- python命令行大全-用什么库写 Python 命令行程序(示例代码详解)
一.前言 在近半年的 Python 命令行旅程中,我们依次学习了 argparse . docopt . click 和 fire 库的特点和用法,逐步了解到 Python 命令行库的设计哲学与演变. ...
最新文章
- 广度优先搜索_深度优先搜索和广度优先搜索[09]
- POJ 1091 跳蚤
- 关于zookeeper中session timeout
- SpringMVC与Ajax交互
- linux下的awk程序在哪里编写,如何编写awk命令和脚本
- 【转】ABP源码分析十:Unit Of Work
- 电商美工中秋节电商淘宝页面设计模板素材,临摹参考框架
- Jenkins的Windows Slave分布式构建和部署
- 自己配置外接屏幕和驱动,最终通过hdmi连接
- Windows下让Tomcat6定时重启服务的方法
- Manjaro使用教程
- 非度量多维标度_非度量多维尺度分析
- 理财笔记 - 关于沪深300指数基金
- Log Parser Lizard(日志分析工具)v6.7.1官方版
- ExtJS控件主要功能用法
- 联想340c笔记本cpu能升级吗_笔记本电脑可以升级CPU吗
- opentsdb 简易生动讲解
- 简述面向过程与面向过程的思想
- 怎样通过百度文库引流?使得你的网络业绩倍增
- 【git之路】拉取远程分支到本地
热门文章
- 博士女友的朋友圈都藏着什么秘密?
- 有了这些,文件批量重命名还需要求助其它工具吗?
- 骨髓基质在正常和白血病个体中的细胞图谱|Cell最新(文末有彩蛋)
- P1035 [NOIP2002 普及组] 级数求和(python3实现)
- centos7配置python3_Centos7安装并配置Python3环境
- python调用oracle过程 权限不足_Python连接Oracle的一些坑以及出现原因和解决方法...
- JavaScript笔记-表格中放按钮并点击调用
- cuda笔记-一个Block多线程求卷积
- Spring Boot文档阅读笔记-构建SOAP的web Service服务
- Java笔记-CXF使用Adapter处理复杂类型(如Map)