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 相关文章推荐
Python3 单行多行万能正则匹配方法
Jan 07 Python
Python设计模式之解释器模式原理与用法实例分析
Jan 10 Python
Django 使用easy_thumbnails压缩上传的图片方法
Jul 26 Python
Django实现跨域的2种方法
Jul 31 Python
Python 通过截图匹配原图中的位置(opencv)实例
Aug 27 Python
Python的条件锁与事件共享详解
Sep 12 Python
django实现支付宝支付实例讲解
Oct 17 Python
浅谈Django QuerySet对象(模型.objects)的常用方法
Mar 28 Python
Window版下在Jupyter中编写TensorFlow的环境搭建
Apr 10 Python
django queryset相加和筛选教程
May 18 Python
Python中如何引入第三方模块
May 27 Python
Python如何将将模块分割成多个文件
Aug 04 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
全国FM电台频率大全 - 3 河北省
2020/03/11 无线电
同时提取多条新闻中的文本一例
2006/10/09 PHP
杏林同学录(二)
2006/10/09 PHP
隐藏你的.php文件的实现方法
2007/03/19 PHP
php的mail函数发送UTF-8编码中文邮件时标题乱码的解决办法
2015/10/20 PHP
PHP反射实际应用示例
2019/04/03 PHP
使用简洁的jQuery方法实现隔行换色功能
2014/01/02 Javascript
js形成页面的一种遮罩效果实例代码
2014/01/04 Javascript
js实现文章文字大小字号功能完整实例
2014/11/01 Javascript
JavaScript实现当网页加载完成后执行指定函数的方法
2015/03/21 Javascript
JS中的THIS和WINDOW.EVENT.SRCELEMENT详解
2015/05/25 Javascript
基于JavaScript实现瀑布流布局(二)
2016/01/26 Javascript
简单谈谈原生js的math对象
2017/06/27 Javascript
Bootstrap 模态对话框只加载一次 remote 数据的完美解决办法
2017/07/09 Javascript
JS如何实现在页面上快速定位(锚点跳转问题)
2017/08/14 Javascript
vue mint-ui学习笔记之picker的使用
2017/10/11 Javascript
Vue.js组件间的循环引用方法示例
2017/12/27 Javascript
react高阶组件添加和删除props
2019/04/26 Javascript
python抓取京东价格分析京东商品价格走势
2014/01/09 Python
Python压缩和解压缩zip文件
2015/02/14 Python
深入理解python中的闭包和装饰器
2016/06/12 Python
Sublime开发python程序的示例代码
2018/01/24 Python
Python3 pip3 list 出现 DEPRECATION 警告的解决方法
2019/02/16 Python
Python redis操作实例分析【连接、管道、发布和订阅等】
2019/05/16 Python
对python中UDP,socket的使用详解
2019/08/22 Python
基于python及pytorch中乘法的使用详解
2019/12/27 Python
Django 实现 Websocket 广播、点对点发送消息的代码
2020/06/03 Python
HTML5和CSS3实例教程总结(推荐)
2016/07/18 HTML / CSS
h5封装下拉刷新
2020/08/25 HTML / CSS
打架检讨书2000字
2014/02/22 职场文书
美容院营销方案
2014/03/05 职场文书
导师就业推荐信范文
2014/05/22 职场文书
大学优秀班集体申报材料
2014/05/23 职场文书
关于感恩的素材句子(38句)
2019/11/11 职场文书
《弟子规》读后感:知廉耻、明是非、懂荣辱、辨善恶
2019/12/03 职场文书
html网页引入svg图片的4种方式
2022/08/05 HTML / CSS