python 第三方模块click 的使用

2024-05-12 01:48

本文主要是介绍python 第三方模块click 的使用,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

click模块 的使用
##官方文档##
http://click.pocoo.org/6/


click模块 可以 轻松将一个函数变成一个命令行工具

# 1. click是基于装饰器的,我们可以在方法上使用click.command()装饰器来将该方法变成一个命令行工具

import click 
@click.command()
def hello():click.echo('Hello World!')if __name__ == '__main__':hello()



1 click.option
option 最基本的用法就是通过指定命令行选项的名称,从命令行读取参数值,再将其传递给函数。我们除了设置命令行选项的名称,我们还会指定默认值,help 说明等,option 常用的设置参数如下:
  • default: 设置命令行参数的默认值
  • help: 参数说明
  • type: 参数类型,可以是 str, int, float 等
  • prompt: 当在命令行中没有输入相应的参数时,会根据 prompt 提示用户输入可以指定 True, 或者特定字符串来提示用户输入
  • nargs: 指定命令行参数接收的值的个数, -1 表示可以接收多个参数,


# 1 可以指定默认值, help 信息, prompt 提示信息
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()


# 2 还可以 指定 type
import click@click.command()
@click.option('--rate', '-rate',type=int, help='rate')  # 指定 rate 是 int 类型
def show(rate):print(f'type(rate):{type(rate)}')click.echo('rate: %s' % rate)if __name__ == '__main__':show()
# 我指定为int 类型 , 如果传入name 就会报错


##2-1 type 也可以设定可选值

import click@click.command()
@click.option('--hash-type', type=click.Choice(['md5', 'sha1']))
def digest(hash_type):click.echo('hash_type:{}'.format(hash_type))if __name__ == '__main__':digest()



## 4 有的时候可能需要输入密码 ,可以用 option
http://click.pocoo.org/6/options/#basic-value-options

import click@click.command()
@click.option('--password', prompt=True, hide_input=True, confirmation_prompt=True)
def input_password(password):click.echo('password: %s' % password)

如果 两次 输入相同,则通过. 如果输入不相同, 则提醒你 重新输入.


# 4-1 click.password_option () 有一个专门的装饰器

import click@click.command()
@click.password_option()
def input_password(password):click.echo('password: %s' % password)


###5 可以通过--, 或 - 来传递参数

import click@click.command()
@click.option('--model', '-model', type=click.Choice(['consume_loan', 'large', 'small']), default='large')
def run(model):click.echo("model:{}".format(model))if __name__ == '__main__':run()

python test_click.py -model small
python test_click.py --model small



2. click.argument
除了使用  @click.option  来添加 可选参数 ,还会经常使用  @click.argument  来添加 固定参数 。它的使用和 option 类似,但支持的功能比 option 少。
可以参考 这个文档
http://click.pocoo.org/6/arguments/#basic-arguments

## 1 为命令行添加 固定参数

import click@click.command()
@click.option('--count', default=1, help='number of greetings')
@click.argument('name')
def hello(count, name):for x in range(count):click.echo('Hello %s!' % name)if __name__ == '__main__':hello()





##2 看看多个 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()



##3 nrgs 的用法 ,可以 吸收多余的参数
Variadic Arguments
http://click.pocoo.org/6/arguments/#variadic-arguments

# 其中,nargs=-1 表明参数 src 接收不定量的参数值,参数值会以 tuple 的形式传入函数。
# 如果 nargs 大于等于 1,表示接收 nargs 个参数值,上面的例子中,dst 接收一个参数值。
# The value is then passed as a tuple. Note that only one argument can be set to nargs=-1, as it will eat up all arguments.
# 用来吸收多余的参数, 作为一个元祖 传值


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

## 4嵌套命令
# 可以通过group来实现命令行的嵌套,也就是让一个命令行工具具有多个命令

import click@click.group()
def cli():click.echo('Hello world')@cli.command()
def initdb():click.echo('Initialized the database')@cli.command()
def dropdb():click.echo('Dropped the database')if __name__ == '__main__':cli()


总结:  本文主要讲解了用click模块,将一个函数可以非常轻松的变成命令行函数.  讲解了常用的方法的使用. 更多还需参考官方文档. 

参考文档:

参考文档
命令行神器 Click 简明笔记
官方文档



分享快乐,留住感动. 2018-06-01 19:59:27 --frank

这篇关于python 第三方模块click 的使用的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/981264

相关文章

vue使用docxtemplater导出word

《vue使用docxtemplater导出word》docxtemplater是一种邮件合并工具,以编程方式使用并处理条件、循环,并且可以扩展以插入任何内容,下面我们来看看如何使用docxtempl... 目录docxtemplatervue使用docxtemplater导出word安装常用语法 封装导出方

Linux换行符的使用方法详解

《Linux换行符的使用方法详解》本文介绍了Linux中常用的换行符LF及其在文件中的表示,展示了如何使用sed命令替换换行符,并列举了与换行符处理相关的Linux命令,通过代码讲解的非常详细,需要的... 目录简介检测文件中的换行符使用 cat -A 查看换行符使用 od -c 检查字符换行符格式转换将

Python FastAPI+Celery+RabbitMQ实现分布式图片水印处理系统

《PythonFastAPI+Celery+RabbitMQ实现分布式图片水印处理系统》这篇文章主要为大家详细介绍了PythonFastAPI如何结合Celery以及RabbitMQ实现简单的分布式... 实现思路FastAPI 服务器Celery 任务队列RabbitMQ 作为消息代理定时任务处理完整

使用Jackson进行JSON生成与解析的新手指南

《使用Jackson进行JSON生成与解析的新手指南》这篇文章主要为大家详细介绍了如何使用Jackson进行JSON生成与解析处理,文中的示例代码讲解详细,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1. 核心依赖2. 基础用法2.1 对象转 jsON(序列化)2.2 JSON 转对象(反序列化)3.

Python Websockets库的使用指南

《PythonWebsockets库的使用指南》pythonwebsockets库是一个用于创建WebSocket服务器和客户端的Python库,它提供了一种简单的方式来实现实时通信,支持异步和同步... 目录一、WebSocket 简介二、python 的 websockets 库安装三、完整代码示例1.

揭秘Python Socket网络编程的7种硬核用法

《揭秘PythonSocket网络编程的7种硬核用法》Socket不仅能做聊天室,还能干一大堆硬核操作,这篇文章就带大家看看Python网络编程的7种超实用玩法,感兴趣的小伙伴可以跟随小编一起... 目录1.端口扫描器:探测开放端口2.简易 HTTP 服务器:10 秒搭个网页3.局域网游戏:多人联机对战4.

使用Python实现快速搭建本地HTTP服务器

《使用Python实现快速搭建本地HTTP服务器》:本文主要介绍如何使用Python快速搭建本地HTTP服务器,轻松实现一键HTTP文件共享,同时结合二维码技术,让访问更简单,感兴趣的小伙伴可以了... 目录1. 概述2. 快速搭建 HTTP 文件共享服务2.1 核心思路2.2 代码实现2.3 代码解读3.

Elasticsearch 在 Java 中的使用教程

《Elasticsearch在Java中的使用教程》Elasticsearch是一个分布式搜索和分析引擎,基于ApacheLucene构建,能够实现实时数据的存储、搜索、和分析,它广泛应用于全文... 目录1. Elasticsearch 简介2. 环境准备2.1 安装 Elasticsearch2.2 J

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

Java中List的contains()方法的使用小结

《Java中List的contains()方法的使用小结》List的contains()方法用于检查列表中是否包含指定的元素,借助equals()方法进行判断,下面就来介绍Java中List的c... 目录详细展开1. 方法签名2. 工作原理3. 使用示例4. 注意事项总结结论:List 的 contain