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

相关文章

python处理带有时区的日期和时间数据

《python处理带有时区的日期和时间数据》这篇文章主要为大家详细介绍了如何在Python中使用pytz库处理时区信息,包括获取当前UTC时间,转换为特定时区等,有需要的小伙伴可以参考一下... 目录时区基本信息python datetime使用timezonepandas处理时区数据知识延展时区基本信息

Python位移操作和位运算的实现示例

《Python位移操作和位运算的实现示例》本文主要介绍了Python位移操作和位运算的实现示例,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一... 目录1. 位移操作1.1 左移操作 (<<)1.2 右移操作 (>>)注意事项:2. 位运算2.1

使用Python和Pyecharts创建交互式地图

《使用Python和Pyecharts创建交互式地图》在数据可视化领域,创建交互式地图是一种强大的方式,可以使受众能够以引人入胜且信息丰富的方式探索地理数据,下面我们看看如何使用Python和Pyec... 目录简介Pyecharts 简介创建上海地图代码说明运行结果总结简介在数据可视化领域,创建交互式地

Java Stream流使用案例深入详解

《JavaStream流使用案例深入详解》:本文主要介绍JavaStream流使用案例详解,本文通过实例代码给大家介绍的非常详细,对大家的学习或工作具有一定的参考借鉴价值,需要的朋友参考下吧... 目录前言1. Lambda1.1 语法1.2 没参数只有一条语句或者多条语句1.3 一个参数只有一条语句或者多

利用python实现对excel文件进行加密

《利用python实现对excel文件进行加密》由于文件内容的私密性,需要对Excel文件进行加密,保护文件以免给第三方看到,本文将以Python语言为例,和大家讲讲如何对Excel文件进行加密,感兴... 目录前言方法一:使用pywin32库(仅限Windows)方法二:使用msoffcrypto-too

Java Spring 中 @PostConstruct 注解使用原理及常见场景

《JavaSpring中@PostConstruct注解使用原理及常见场景》在JavaSpring中,@PostConstruct注解是一个非常实用的功能,它允许开发者在Spring容器完全初... 目录一、@PostConstruct 注解概述二、@PostConstruct 注解的基本使用2.1 基本代

C#使用StackExchange.Redis实现分布式锁的两种方式介绍

《C#使用StackExchange.Redis实现分布式锁的两种方式介绍》分布式锁在集群的架构中发挥着重要的作用,:本文主要介绍C#使用StackExchange.Redis实现分布式锁的... 目录自定义分布式锁获取锁释放锁自动续期StackExchange.Redis分布式锁获取锁释放锁自动续期分布式

springboot使用Scheduling实现动态增删启停定时任务教程

《springboot使用Scheduling实现动态增删启停定时任务教程》:本文主要介绍springboot使用Scheduling实现动态增删启停定时任务教程,具有很好的参考价值,希望对大家有... 目录1、配置定时任务需要的线程池2、创建ScheduledFuture的包装类3、注册定时任务,增加、删

使用Python实现矢量路径的压缩、解压与可视化

《使用Python实现矢量路径的压缩、解压与可视化》在图形设计和Web开发中,矢量路径数据的高效存储与传输至关重要,本文将通过一个Python示例,展示如何将复杂的矢量路径命令序列压缩为JSON格式,... 目录引言核心功能概述1. 路径命令解析2. 路径数据压缩3. 路径数据解压4. 可视化代码实现详解1

python获取网页表格的多种方法汇总

《python获取网页表格的多种方法汇总》我们在网页上看到很多的表格,如果要获取里面的数据或者转化成其他格式,就需要将表格获取下来并进行整理,在Python中,获取网页表格的方法有多种,下面就跟随小编... 目录1. 使用Pandas的read_html2. 使用BeautifulSoup和pandas3.