参考链接 https://developer.aliyun.com/article/531283

文章目录

快速使用
- click.option
- 可选值
- 多值参数
- 输入密码
- 改变命令行程序的执行
- click.argument
- 不定参数

Click 是用 Python 写的一个第三方模块，用于快速创建命令行。

快速使用

Click使用的两个步骤：

使用 @click.command() 装饰一个函数，使之成为命令行接口；
使用 @click.option() 等装饰函数，为其添加命令行选项等。

典型使用形式如下：

import click@click.command()
@click.option('--param', default=default_value, help='description')
def func(param):pass

官方文档例子：

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 的用法有些差别。

click.option

option 最基本的用法就是通过指定命令行选项的名称，从命令行读取参数值，再将其传递给函数。
option 常用的设置参数如下：

default: 设置命令行参数的默认值
help: 参数说明
type: 参数类型，可以是 string, int, float 等
prompt: 当在命令行中没有输入相应的参数时，会根据 prompt 提示用户输入
nargs: 指定命令行参数接收的值的个数
metavar：如何在帮助页面表示值

可选值

在某些情况下，一个参数的值只能是某些可选的值，如果用户输入了其他值，我们应该提示用户输入正确的值。在这种情况下，我们可以通过 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()

多值参数

一个参数需要接收多个值。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()

center 表示二维平面上一个圆的圆心坐标，接收两个值，以元组的形式将值传递给函数，而 radius 表示圆的半径。

执行情况：

$ python click_multi_values.py --center 3 4 --radius 10
center: (3.0, 4.0), radius: 10.0

输入密码

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()

改变命令行程序的执行

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.argument

我们除了使用 @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 还有另外一种常见的用法，就是接收不定量的参数，让我们看看例子：

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

Python Click 模块相关推荐

python keys模块_python自动化常用模块
python自动化常用函数导入time模块 import time 导入ActionChains模块(鼠标) from selenium.webdriver.common.action_chains ...
已解决python selenium模块自动化操作谷歌浏览器点击元素失效问题解决（亲测有效）
已解决python selenium模块自动化操作浏览器点击元素,抛出异常selenium.common.exceptions.ElementClickInterceptedException: Me ...
Python Re 模块超全解读！详细
内行必看!Python Re 模块超全解读! 2019.08.08 18:59:45字数 953阅读 121 re模块下的函数 compile(pattern):创建模式对象 > import ...
python argparse模块_Python argparse模块应用实例解析
这篇文章主要介绍了Python argparse模块应用实例解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下简介 argparse是python ...
关于使用python logging模块的几点总结
关于使用python logging模块的几点总结使用python的标准日志模块logging可以非常方便地记录日志.Python日志系统非常丰富.添加结构化或非结构化日志输出到python代码,写 ...
python高级-模块(14)
一.python中的模块有过C语言编程经验的朋友都知道在C语言中如果要引用sqrt函数,必须用语句#include <math.h>引入math.h这个头文件,否则是无法正常进行调用的. ...
转载： Python os 模块的功能以及子函数介绍
原文链接: python之os模块 - 程序生(Codey) - 博客园 https://www.cnblogs.com/cxscode/p/8085326.html 一.Python OS模块介绍 ...
简单介绍python process模块
在python中大部分情况需要使用多进程,python提供了multiprocessing模块.multiprocessing模块的功能众多:支持子进程.通信和共享数据.执行不同形式的同步,提供了Pr ...
python io模块_python中的StringIO模块
原博文 2015-10-23 15:21 − # python中的StringIO模块标签:python StringIO --- > 此模块主要用于在内存缓冲区中读写数据.模块是用类编写的, ...

Python Click 模块

文章目录

快速使用

click.option

可选值

多值参数

输入密码

改变命令行程序的执行

click.argument

不定参数

Python Click 模块相关推荐

最新文章

热门文章