python Click 模块的使用
click 是比较简单易上手的创造命令行的一个工具（模块）
安装
pip install Click
使用
官方示例
# 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()
使用说明
# 装饰一个函数，使其成为命令行接口
@click.command()
# 装饰一个函数，为其添加命令行参数等
# --count：也可写成：'-c','$c' 随你开心怎么写，试试看
# default: 默认值
# help：解释说明
@click.option('--count', default=1, help='Number of greetings.')
# prompt：提示语句，再提示后，输出参数
@click.option('--name', prompt='Your name', help='The person to greet.')
运行如下：
$ python hello.py --help
$ python hello.py --count 3
$ python hello.py --count 3 --name a</pre>
扩展
如果很多命令的话，使用group管理会比较好
import click
@click.group()
def db():
pass
@click.command()
@click.option('-user', help='增加用户')
def add(user):
"""增加用户"""
click.echo('add user: %s' % user)
@click.command()
@click.option('-n', help='删除用户')
def delete(n):
"""删除用户"""
click.echo('delete user: %s' % n)
db.add_command(delete)
db.add_command(add)
if __name__ == '__main__':
db()
#运行如下
$ python hello.py --help
$ python hello.py add --help
$ python hello.py delete --help
$ python hello.py add -user jim
$ python hello.py add -delete jim
密码输入
# 密码输入有两种方法
import click
@click.group()
def db():
pass
# 方法1 ：hide_input 隐式输入，confirmation_prompt：再次确认
@click.command()
@click.option('-p', prompt='请输入密码', hide_input=True, confirmation_prompt=True)
def inputp(p):
"""输入密码"""
click.echo('p is %s' % p)
# 方法2： 我试了下，传参只能是password，其他的会报错
@click.command()
@click.password_option()
def inputp2(password):
click.echo('p is %s' % password)
db.add_command(inputp)
db.add_command(inputp2)
if __name__ == '__main__':
db()
# 运行如下
$ python hello.py --help
$ python3 hello.py inputp
$ python3 hello.py inputp2</pre>
其他
其他还有option 的使用，不再一一细说，可以直接去官网上查看：
option其他函数使用.png
使用setuptools 打包py文件
https://click-docs-zh-cn.readthedocs.io/zh/latest/setuptools.html
# hello.py
#!/usr/bin/python3
# -*- coding: UTF-8 -*-
import click
@click.command()
@click.option('-user', prompt='请输入名字', help='增加用户')
def add(user):
"""增加用户"""
click.echo('add user: %s' % user)
# setup.py(hello.py 的同目录下，必须以这个命名)
from setuptools import setup
setup(
name='hello',
version='0.1',
py_modules=['hello'],
install_requires=[
'Click',
],
entry_points='''
[console_scripts]
hello=hello:add
'''
)
# 运行如下
$ pip install --editable .
# 成功后，会在同目录下出现一个文件夹：hello.egg-info
# 执行,就可以运行你的脚本了
$ hello
