click工具的使用

一：Click导航

地址： https://click.palletsprojects.com/en/8.0.x/
安装click: pip install Click
参看文献：https://isudox.com/2016/09/03/learning-python-package-click/

二：Click的基本使用

1: 官网案例演示：

官网案例代码：

# hello.py
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()

将代码复制到hello.py文件中，执行: python hello.py --count=3

(flask_env) C:\Users\renshanwen\Desktop>python hello.py --count=3
Your name: liangshan
Hello liangshan!
Hello liangshan!
Hello liangshan!

执行 python hello.py --help

(flask_env) C:\Users\renshanwen\Desktop>python hello.py --help
Usage: hello.py [OPTIONS]Simple program that greets NAME for a total of COUNT times.Options:--count INTEGER  Number of greetings.--name TEXT      The person to greet.--help           Show this message and exit.

2： @click.command装饰器

@click.command()装饰器把一个函数方法装饰成命令行接口。
```
import click
@click.command()
def hello():click.echo('Hello World!')
```
- @click.command() 装饰器把 hello() 方法变成了 Command 对象，当它被调用时，就会执行该实例内的行为。而 --help 参数就是 Command 对象内置的参数。

3: @click.group()装饰器：

不同的 Command 实例可以关联到 group 中。group 下绑定的命令就成为了它的子命令。

@click.group 装饰器把方法装饰为可以拥有多个子命令的 Group 对象。由 Group.add_command() 方法把 Command 对象关联到 Group 对象。

@click.group()
def cli():pass@click.command()
def initdb():click.echo('Initialized the database')@click.command()
def dropdb():click.echo('Dropped the database')cli.add_command(initdb)
cli.add_command(dropdb)

也可以直接用 @Group.command 装饰方法，会自动把方法关联到该 Group 对象下。

@click.group()
def cli():pass@cli.command()
def initdb():click.echo('Initialized the database')@cli.command()
def dropdb():click.echo('Dropped the database')

4：命令行参数

Click 支持对 command 方法添加自定义的参数，由 option() 和 argument() 装饰器实现。

案例：

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

4.1： Option参数：

‘–参数名’，表示输入的参数。
default = 默认值
nargs = 数量，表示参数的数量。
type = 类型，限制参数的类型。
multiple=True, 允许一个参数多次使用。
prompt=True, 命令输错友好提示。

案例：

@click.command()
@click.option('--pos', nargs=2, type=float)
def findme(pos):click.echo('%s / %s' % pos)#findme --pos 2.0 3.0
# 输出结果就是 2.0 / 3.0

在命令行后面跟随 --pos=2，就会输出两遍，默认是执行一遍的。

type也可以指定不同的类型：

@click.command()
@click.option('--item', type=(unicode, int))
def putitem(item):click.echo('name=%s id=%d' % item)
#putitem --item peter 1338 得到的输出就是 name=peter id=1338

一个参数传入多次：

option 通过 multiple 标识位来支持这一特性。

import click@click.command()
@click.option('--message', '-m', multiple=True)
def commit(message):click.echo('\n'.join(message))if __name__ == '__main__':commit()

(flask_env) C:\Users\renshanwen\Desktop>python commit.py -m liangshan -m dada
liangshan
dada

限定传参的类型范围：

当上面的命令行程序参数 --hash-type 不是 md5 或 sha1，就会输出错误提示，并且在 --help 提示中也会对 choice 选项有显示。

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

# 正确演示
(flask_env) C:\Users\renshanwen\Desktop>python commit.py --hash_type md5
md5
# 错误演示
(flask_env) C:\Users\renshanwen\Desktop>python commit.py --hash_type xxx
Usage: commit.py [OPTIONS]
Try 'commit.py --help' for help.Error: Invalid value for '--hash_type': 'xxx' is not one of 'md5', 'sha1'.

友好提示演示：

# prompt
@click.command()
@click.option('--name', prompt=True)
def hello(name):click.echo('Hello %s!' % name)

(flask_env) C:\Users\renshanwen\Desktop>python commit.py --name liangshan
Hello liangshan!(flask_env) C:\Users\renshanwen\Desktop>python commit.py
Name:
Name:
Name: liangshan
Hello liangshan!

自定义提示参数：

import click@click.command()
@click.option('--name', prompt="请输入名字")
def hello(name):click.echo('Hello %s!' % name)if __name__ == '__main__':hello()(flask_env) C:\Users\renshanwen\Desktop>python commit.py
请输入名字:
请输入名字: liangshan
Hello liangshan!

密码等进行输入隐藏：

import click@click.command()
@click.option('--password', prompt=True, hide_input=True,confirmation_prompt=True)
def encrypt(password):click.echo('Encrypting password to %s' % password)if __name__ == '__main__':encrypt()

(flask_env) C:\Users\renshanwen\Desktop>python commit.py
Password:
Repeat for confirmation:
Encrypting password to 123456

# 更改成装饰器写法：
@click.command()
@click.password_option()
def encrypt(password):click.echo('Encrypting password to %s' % password.encode('rot13'))

4.2： Argument参数:

1：使用argument进行传参：

import click@click.command()
@click.argument('filename')
def touch(filename):click.echo(filename)if __name__ == '__main__':touch()(flask_env) C:\Users\renshanwen\Desktop>python commit.py liangshan
liangshan

2：使用argument进行传参（可变参数）

nargs=-1

分析：我们发现src是可变参数，dst限制参数一个。

import click@click.command()
@click.argument('src', nargs=-1)
@click.argument('dst', nargs=1)
def copy(src, dst):for fn in src:click.echo('move %s to folder %s' % (fn, dst))if __name__ == '__main__':copy()(flask_env) C:\Users\renshanwen\Desktop>python commit.py aaa bbb ccc AAA
move aaa to folder AAA
move bbb to folder AAA
move ccc to folder AAA

3：对文件进行操作：

注意：使用- 作为标准输入和输出。
如果只是想修改文件名：type=click.Path(exists=True)

@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)if not chunk:breakoutput.write(chunk)

$ inout - hello.txt
hello
^D$ inout hello.txt -
hello

@click.command()
@click.argument('f', type=click.Path(exists=True))
def touch(f):click.echo(click.format_filename(f))

5：打包成跨平台可执行程序

方案一：最简单的办法就是在文件末尾加上如下代码：
```
if __name__ == '__main__':command()
```
方案二：Click 支持使用 setuptools 来更好的实现命令行程序打包，把源码文件打包成系统中的可执行程序，并且不限平台。
- 一般我们会在源码根目录下创建 setup.py 脚本。
- entry_points 字段，在 console_scripts 下，每一行都是一个控制台脚本，等号左边的的是脚本的名称，右边的是 Click 命令的导入路径。
```
from setuptools import setupsetup(name='hello',version='0.1',py_modules=['hello'],install_requires=['Click',],entry_points='''[console_scripts]hello=hello:cli''',
)
```

click工具的使用相关推荐

python命令行工具_python命令行工具Click快速掌握
前言写 Python 的经常要写一些命令行工具,虽然标准库提供有命令行解析工具 Argparse,但是写起来非常麻烦,我很少会使用它.命令行工具中用起来最爽的就是 Click,它是 Flask 的团 ...
使用click进行对测试工具进行封装
前情分析: 1. 当前被测系统被分为前端,调度层和数据层.每一层都有单独测试脚本进行测试. 2. 测试脚本没有进行统一管理,使用方式各异,且没有统一的文档对测试脚本进行解释. 3. 测试节点十几个,每 ...
Echarts:重写toolbox的还原工具并监听click事件
Echarts中的toolbox.feature提供了部分图标,比如 saveAsImage 保存图片 restore 配置项还原 dataView 数据视图工具,可以展现当前图表所用的数据,编辑后可 ...
python鼠标自动化 pyautogui.click()对软件分析工具点击失败
软件分析工具:process monitor 火绒剑试图用pyautogui.click()自动点击的地方如上两图所示. 使用的代码: pyautogui.moveTo(129, 73, durat ...
python命令行工具是什么_Python 命令行神器 Click
Click 是一个用于快速创建命令行工具的 Python 支持库,Click 具有高度可配置性,使用非常少的代码就可以创造一个优雅的命令行工具,Click 使创建命令行工具变得快速而有趣. 实际上 P ...
Paddle预训练模型应用工具PaddleHub
Paddle预训练模型应用工具PaddleHub • 本文主要介绍如何使用飞桨预训练模型管理工具PaddleHub,快速体验模型以及实现迁移学习.建议使用GPU环境运行相关程序,可以在启动环境时,如下 ...
python 自动化办公案例_python自动化工具之pywinauto实例详解
python自动化工具之pywinauto实例详解来源:中文源码网浏览: 次日期:2019年11月5日 [下载文档: python自动化工具之pywinauto实例详解.txt ] (友情提示: ...
前端资源整理 - 订阅、工具等
取自我的GITHUB 的 fe-store-house repo,欢迎 PR,欢迎 STAR.原 repo 不定期更新,此文可能断更. 断更了一年多,重新更新一下,似乎 sfgg 的文章渲染中 gf ...
代码片段管理工具_VS代码片段：提高编码效率的最强大工具
代码片段管理工具 by Sam Williams 通过山姆·威廉姆斯 VS代码片段:提高编码效率的最强大工具 (VS Code snippets: the most powerful tool to ...

click工具的使用

目录

一：Click导航

二：Click的基本使用

1: 官网案例演示：

2： @click.command装饰器

3: @click.group()装饰器：

4：命令行参数

4.1： Option参数：

4.2： Argument参数:

5：打包成跨平台可执行程序

click工具的使用相关推荐

最新文章

热门文章

click工具的使用

目录

一：Click导航

二：Click的基本使用

1: 官网案例演示：

2： @click.command装饰器

3: @click.group()装饰器：

4： 命令行参数

4.1： Option参数：

4.2： Argument参数:

5： 打包成跨平台可执行程序

click工具的使用相关推荐

最新文章

热门文章

4：命令行参数

5：打包成跨平台可执行程序