Python命令行click参数用法解析


Posted in Python onDecember 19, 2019

这篇文章主要介绍了Python命令行click参数用法解析,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下

一、前言

在概念上, click 把命令行分为 3 个组成:参数、选项和命令。

参数 就是跟在命令后的除选项外的内容,比如 git add a.txt 中的 a.txt 就是表示文件路径的参数

选项 就是以 - 或 -- 开头的参数,比如 -f、--file

命令 就是命令行的初衷了,比如 git 就是命令,而 git add 中的 add 则是 git 的子命令

二、参数

2.1 基本参数

基本参数 就是通过位置里指定参数值。

比如,我们可以指定两个位置参数 x 和 y ,先添加的 x 位于第一个位置,后加入的 y 位于第二个位置。那么在命令行中输入 1 2的时候,分别对应到的就是 x 和 y:

@click.command()
@click.argument('x')
@click.argument('y')
def hello(x, y):
  print(x, y)

2.2 参数类型

参数类型 就是将参数值作为什么类型去解析,默认情况下是字符串类型。我们可以通过 type 入参来指定参数类型。

click 支持的参数类型多种多样:

  • str / click.STRING 表示字符串类型,这也是默认类型
  • int / click.INT 表示整型
  • float / click.FLOAT 表示浮点型
  • bool / click.BOOL 表示布尔型。很棒之处在于,它会识别表示真/假的字符。对于 1、yes、y 和 true 会转化为 True;0、no、n 和 false 会转化为 False
  • click.UUID 表示 UUID,会自动将参数转换为 uuid.UUID 对象
  • click.FILE 表示文件,会自动将参数转换为文件对象,并在命令行结束时自动关闭文件
  • click.PATH 表示路径
  • click.Choice 表示选择选项
  • click.IntRange 表示范围选项

同 argparse 一样,click 也支持自定义类型,需要编写 click.ParamType 的子类,并重载 convert 方法。

2.3 文件参数

在基本参数的基础上,通过指定参数类型,我们就能构建出各类参数。

文件参数 是非常常用的一类参数,通过 type=click.File 指定,它能正确处理所有 Python 版本的 unicode 和 字节,使得处理文件十分方便。

@click.command()
@click.argument('input', type=click.File('rb')) # 指定文件为二进制读
@click.argument('output', type=click.File('wb')) # 指定文件为二进制写
def inout(input, output):
  while True:
    chunk = input.read(1024) # 此时 input 为文件对象,每次读入 1024 字节
    if not chunk:
      break
    output.write(chunk) # 此时 output 为文件对象,写入上步读入的内容

2.4 文件路径参数

文件路径参数 用来处理文件路径,可以对路径做是否存在等检查,通过 type=click.Path 指定。不论文件名是 unicode 还是字节类型,获取到的参数类型都是 unicode 类型。

@click.command()
@click.argument('filename', type=click.Path(exists=True)) # 要求给定路径存在,否则报错
def hello(filename):
  click.echo(click.format_filename(filename))

如果文件名是以 - 开头,会被误认为是命令行选项,这个时候需要在参数前加上 -- 和空格,比如

$ python hello.py -- -foo.txt
-foo.txt

2.5 选择项参数

选择项参数 用来限定参数内容,通过 type=click.Choice 指定。

比如,指定文件读取方式限制为 read-only 和 read-write:

@click.command()
@click.argument('mode', type=click.Choice(['read-only', 'read-write']))
def hello(mode):
  click.echo(mode)

2.6 可变参数

可变参数 用来定义一个参数可以有多个值,且能通过 nargs 来定义值的个数,取得的参数的变量类型为元组。

若 nargs=N,N为一个数字,则要求该参数提供 N 个值。若 N 为 -1 则接受提供无数量限制的参数,如:

@click.command()
@click.argument('foo', nargs=-1)
@click.argument('bar', nargs=1)
def hello(foo, bar):
  pass

如果要实现 argparse 中要求参数数量为 1 个或多个的功能,则指定 nargs=-1 且 required=True 即可:

@click.command()
@click.argument('foo', nargs=-1, required=True)
def hello(foo, bar):
  pass

2.7 从环境变量读取参数

通过在 click.argument 中指定 envvar,则可读取指定名称的环境变量作为参数值,比如:

@click.command()
@click.argument('filename', envvar='FILENAME')
def hello(filename):
  print(filename)

执行如下命令查看效果:

$ FILENAME=hello.txt python3 hello.py
hello.txt

而在 argparse 中,则需要自己从环境变量中读取。

三、小节

本文讲解了 click 中基本参数的用法,在此基础上介绍了各种类型的参数,最后说明了从环境变量中获取参数值的写法。

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持三水点靠木。

Python 相关文章推荐
wxpython中利用线程防止假死的实现方法
Aug 11 Python
python Django批量导入数据
Mar 25 Python
深入解析Python中的上下文管理器
Jun 28 Python
Python中Scrapy爬虫图片处理详解
Nov 29 Python
对python numpy数组中冒号的使用方法详解
Apr 17 Python
Python深拷贝与浅拷贝用法实例分析
May 05 Python
解决Pycharm 包已经下载,但是运行代码提示找不到模块的问题
Aug 31 Python
Python字典生成式、集合生成式、生成器用法实例分析
Jan 07 Python
python PIL/cv2/base64相互转换实例
Jan 09 Python
Jupyter打开图形界面并画出正弦函数图像实例
Apr 24 Python
详解python安装matplotlib库三种失败情况
Jul 28 Python
python设置 matplotlib 正确显示中文的四种方式
May 10 Python
python3 常见解密加密算法实例分析【base64、MD5等】
Dec 19 #Python
Python定义函数时参数有默认值问题解决
Dec 19 #Python
Python爬取腾讯视频评论的思路详解
Dec 19 #Python
使用Pandas将inf, nan转化成特定的值
Dec 19 #Python
pandas中read_csv的缺失值处理方式
Dec 19 #Python
python错误调试及单元文档测试过程解析
Dec 19 #Python
Python3.5 win10环境下导入kera/tensorflow报错的解决方法
Dec 19 #Python
You might like
最常用的8款PHP调试工具
2014/07/06 PHP
php限制ip地址范围的方法
2015/03/31 PHP
Laravel路由设定和子路由设定实例分析
2016/03/30 PHP
Jquery cookie操作代码
2010/03/14 Javascript
扩展easyui.datagrid,添加数据loading遮罩效果代码
2010/11/02 Javascript
JS中的this变量的使用介绍
2013/10/21 Javascript
js中的for如何实现foreach中的遍历
2014/05/31 Javascript
JS+CSS实现表格高亮的方法
2015/08/05 Javascript
javascript实现图片延迟加载方法汇总(三种方法)
2015/08/27 Javascript
解决JS组件bootstrap table分页实现过程中遇到的问题
2016/04/21 Javascript
浅谈JavaScript的全局变量与局部变量
2016/06/10 Javascript
AngularJS 入门教程之HTML DOM实例详解
2016/07/28 Javascript
输入法的回车与消息发送快捷键回车的冲突解决方法
2016/08/09 Javascript
微信公众号开发 实现点击返回按钮就返回到聊天界面
2016/12/15 Javascript
Vue2.0 从零开始_环境搭建操作步骤
2017/06/14 Javascript
基于js中this和event 的区别(详解)
2017/10/24 Javascript
vue项目实战总结篇
2018/02/11 Javascript
jQuery实现的网站banner图片无缝轮播效果完整实例
2019/01/28 jQuery
五分钟搞懂Vuex实用知识(小结)
2019/08/12 Javascript
微信小程序JS加载esmap地图的实例详解
2019/09/04 Javascript
weui上传多图片,压缩,base64编码的示例代码
2020/06/22 Javascript
解决VUE自定义拖拽指令时 onmouseup 与 click事件冲突问题
2020/07/24 Javascript
浅谈对yield的初步理解
2017/05/29 Python
对Python 语音识别框架详解
2018/12/24 Python
对Python中创建进程的两种方式以及进程池详解
2019/01/14 Python
Python Pexpect库的简单使用方法
2019/01/29 Python
python中报错"json.decoder.JSONDecodeError: Expecting value:"的解决
2019/04/29 Python
pandas 数据结构之Series的使用方法
2019/06/21 Python
Belvilla德国:在线预订度假屋
2018/04/10 全球购物
NBA德国官方网上商店:NBA Store德国
2018/04/13 全球购物
2014年残联工作总结
2014/11/21 职场文书
2014年工商所工作总结
2014/12/09 职场文书
2016年教师师德师风心得体会
2016/01/12 职场文书
入党申请书怎么写?
2019/06/21 职场文书
PHP命令行与定时任务
2021/04/01 PHP
纯html+css实现奥运五环的示例代码
2021/08/02 HTML / CSS