python click模块参数处理详解
python 模块 click参数处理
文章目录
- python 模块 click参数处理
- 1. 介绍
- 2. 简单示例
- 3. click.option
- 3.1 指定 type
- 3.2 可选值
- 3.3 多值参数
- 3.4 输入密码
- 3.5 改变命令行程序的执行
- 4. click.argument
- 4.1 入门使用
- 4.2 多个 argument
- 4.3 不定参数
- 4.4 彩色输出
- 5. cli.add_command
1. 介绍
Click 是 Flask 的开发团队 Pallets 的另一款开源项目，它是用于快速创建命令行的第三方模块。我们知道，Python 内置了一个 Argparse 的标准库用于创建命令行，但使用起来有些繁琐，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
2. 简单示例
下面，让我们看一下官方文档的入门例子：
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，name 的值从输入获取；
使用 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!
3. click.option
option 最基本的用法就是通过指定命令行选项的名称，从命令行读取参数值，再将其传递给函数。在上面的例子，我们看到，除了设置命令行选项的名称，我们还会指定默认值，help 说明等，option 常用的设置参数如下：
- default: 设置命令行参数的默认值
- help: 参数说明
- type: 参数类型，可以是 string, int, float 等
- prompt: 当在命令行中没有输入相应的参数时，会根据 prompt 提示用户输入
- nargs: 指定命令行参数接收的值的个数
下面，我们再看看相关的例子。
3.1 指定 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
3.2 可选值
在某些情况下，一个参数的值只能是某些可选的值，如果用户输入了其他值，我们应该提示用户输入正确的值。在这种情况下，我们可以通过 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
3.3 多值参数
有时，一个参数需要接收多个值。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)
3.4 输入密码
有时，在输入密码的时候，我们希望能隐藏显示。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()
3.5 改变命令行程序的执行
有些参数会改变命令行程序的执行，比如在终端输入 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
4. click.argument
我们除了使用 @click.option 来添加可选参数，还会经常使用 @click.argument 来添加固定参数。它的使用和 option 类似，但支持的功能比 option 少。
4.1 入门使用
下面是一个简单的例子：
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
4.2 多个 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)
4.3 不定参数
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
4.4 彩色输出
在前面的例子中，我们使用 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()
5. cli.add_command
@click.group装饰器把方法装饰为可以拥有多个子命令的Group对象。由Group.add_command()方法把Command对象关联到Group对象。 也可以直接用@Group.command装饰方法，会自动把方法关联到该Group` 对象下。
#!/usr/bin/pythonimport click@click.group()
def cli():pass@click.command()
def initdb():click.echo('Initialized the database')@click.command()
def dropdb():click.echo('Dropped the database')cli.add_command(initdb)
cli.add_command(dropdb)if __name__ == '__main__':cli()
执行输出：
$ python click2.py
Usage: click2.py [OPTIONS] COMMAND [ARGS]...Options:--help Show this message and exit.Commands:dropdbinitdb
$ python click2.py dropdb
Dropped the database
$ python click2.py initdb
Initialized the database
参考:
- python argparse参数配置
- Click 官方
- Click 中文文档
- zetcode Python click
- python click模块参数处理
- python sys模块
- 更多click细节请阅读
python click模块参数处理详解相关推荐
- python导入模块介绍_详解Python模块导入方法
python常被昵称为胶水语言,它能很轻松的把用其他语言制作的各种模块(尤其是C/C++)轻松联结在一起.python包含子目录中的模块方法比较简单,关键是能够在sys.path里面找到通向模块文件的 ...
- python argparse模块用法实例详解
转载自https://zhuanlan.zhihu.com/p/56922793 argsparse是python的命令行解析的标准模块,内置于python,不需要安装.这个库可以让我们直接在命令行中 ...
- Python Importlib模块与__import__详解
阅读目录 Importlib模块与__import__都可以通过过字符串来导入另外一个模块,但在用法上和本质上都有很大的不同. 以一个例子为证: 以下为我的工程目录结构: lib/test.py: - ...
- python xlsxwriter_python模块之XlsxWriter 详解
Xlsx是python用来构造xlsx文件的模块,可以向excel2007+中写text,numbers,formulas 公式以及hyperlinks超链接. 可以完成xlsx文件的自动化构造,包括 ...
- Python基础——模块和包详解以及pip操作模块和包的指令
随着项目越来越大,所有代码都放在一个文件中,已经不能满足我们的需求了.这时候就要将代码进行整理了,模块和包的出现就是为了解决这个问题的.模块可以将一些相关联的代码组合在一个py文件中,包可以将一些相关 ...
- python etree模块所有函数详解_Python3使用xml.dom.minidom和xml.etree模块儿解析xml文件，封装函数...
from xml.dom.minidom importparse, parseStringfrom xml.etree importElementTreeimportxml.dom.minidom&q ...
- python的socket模块_Python socket模块方法实现详解
这篇文章主要介绍了python socket模块方法实现详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 socket ssh (不带防止粘包的方 ...
- python包mdure_Python hashlib模块实例使用详解
这篇文章主要介绍了Python hashlib模块实例使用详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 hashlib模块主要的作用: 加密保 ...
- python hashlib_Python hashlib模块实例使用详解
这篇文章主要介绍了Python hashlib模块实例使用详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下 hashlib模块主要的作用: 加密保 ...
- Python中random模块生成随机数详解
Python中random模块生成随机数详解 本文给大家汇总了一下在Python中random模块中最常用的生成随机数的方法,有需要的小伙伴可以参考下 Python中的random模块用于生成随机数. ...
最新文章
- SSH远程联机Linux服务器简易安全设定
- 1.21 实例：统计商品信息
- PCB第二节知识整理
- craigslist_如何设置Craigslist警报（用于电子邮件或SMS）
- 安卓签名生成工具_ios app如何进行内测？ios app和安卓app的内测有何区别？
- C++带参数控制台（实例）
- magento 添加退出链接 Adding a Logout Link to Magento
- 朴素贝叶斯分类器的python实现
- systemd 开机无法启动privoxy
- 页面全部按钮变成disabled=true_手机也能制作大片！只需轻松几步就能把照片变成视频。...
- php翻手册时关于一些函数参数的说明
- Unity object强转int、string
- IDEA启动tomcat控制台出现中文乱码问题完美解决方案（亲测有效）
- 有人说做运营死路一条，但他没搞清运营是做什么的！
- 软件开发中的瀑布模型
- CentOS7 ifup 和 ifdown
- c语言实现乘法口诀表的打印函数
- 速途网范锋：重要合作可能决定网络企业生死
- Windows 下Nexus搭建Maven私服
- AC/DC电源适配器科普