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 相关文章推荐
Python常用随机数与随机字符串方法实例
Apr 09 Python
Python多线程结合队列下载百度音乐的方法
Jul 27 Python
Python 中开发pattern的string模板(template) 实例详解
Apr 01 Python
Python matplotlib画图与中文设置操作实例分析
Apr 23 Python
django 连接数据库 sqlite的例子
Aug 14 Python
python实现一个函数版的名片管理系统过程解析
Aug 27 Python
python 实现检验33品种数据是否是正态分布
Dec 09 Python
Pytorch数据拼接与拆分操作实现图解
Apr 30 Python
如何理解python对象
Jun 21 Python
Python文件夹批处理操作代码实例
Jul 21 Python
python数据抓取3种方法总结
Feb 07 Python
FP-growth算法发现频繁项集——发现频繁项集
Jun 24 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
PHP输出缓存ob系列函数详解
2014/03/11 PHP
Windows下的PHP安装pear教程
2014/10/24 PHP
PHP实现超简单的SSL加密解密、验证及签名的方法示例
2017/08/28 PHP
PHP实现简单的模板引擎功能示例
2017/09/02 PHP
JavaScript 原型与继承说明
2010/06/09 Javascript
5秒后跳转效果(setInterval/SetTimeOut)
2013/05/03 Javascript
Backbone.js中的集合详解
2015/01/14 Javascript
Shell脚本实现Linux系统和进程资源监控
2015/03/05 Javascript
javascript通过元素id和name直接取得元素的方法
2015/04/28 Javascript
Javascript实现图片轮播效果(二)图片序列节点的控制实现
2016/02/17 Javascript
Node.js Streams文件读写操作详解
2016/07/04 Javascript
JS设置CSS样式的方式汇总
2017/01/21 Javascript
MUI实现上拉加载和下拉刷新效果
2017/06/30 Javascript
jQuery实现ajax回调函数带入参数的方法示例
2018/06/26 jQuery
Vue动态生成el-checkbox点击无法赋值的解决方法
2019/02/21 Javascript
如何基于JS截获动态代码
2019/12/25 Javascript
[02:17]TI4西雅图DOTA2前线报道 啸天mik夫妻档解说
2014/07/08 DOTA
python中的多重继承实例讲解
2014/09/28 Python
python 采集中文乱码问题的完美解决方法
2016/09/27 Python
Python基于Flask框架配置依赖包信息的项目迁移部署
2018/03/02 Python
Python 比较文本相似性的方法(difflib,Levenshtein)
2018/10/15 Python
使用 Python 处理 JSON 格式的数据
2019/07/22 Python
python实现图片插入文字
2019/11/26 Python
Python time库基本使用方法分析
2019/12/13 Python
python字符串,元组,列表,字典互转代码实例详解
2020/02/14 Python
Python同时迭代多个序列的方法
2020/07/28 Python
在HTML5 Canvas中放入图片和保存为图片的方法
2014/05/03 HTML / CSS
暑期社会实践学生的自我评价
2014/01/09 职场文书
企业出纳岗位职责
2014/03/12 职场文书
公务员更新知识培训实施方案
2014/03/31 职场文书
护士节活动总结
2014/08/29 职场文书
小学假期安全广播稿
2014/09/28 职场文书
给老师的一封感谢信
2015/01/20 职场文书
公司车队管理制度
2015/08/04 职场文书
《跨越海峡的生命桥》教学反思
2016/02/18 职场文书
Python如何配置环境变量详解
2021/05/18 Python