Python-Click模块学习

Click基础学习

1.函数变cli

@click.command()

import click
@click.command()
def hello():
    click.echo('Hello World!')

if __name__ == '__main__':
    hello()

#运行得结果 Hello World!

2.不同的command实例可以关联到group中，group中的命令就是其子命令，有两种绑定方式分别为：

#@click.group 装饰器把方法装饰为可以拥有多个子命令的group对象，并采用group.add_command()方法把command对象关联到group对象
#1.通过方法add_command

@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)
#直接进行装饰
@click.group()
def cli():
    pass

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

3.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.打包跨平台可执行程序

通过click编写了简单的命令行方法后，还需要把.py文件转换成可以在控制台里运行的命令行程序。最简单的方法就是加上如下代码：

if __name__ == '__main__':
    command()

click支持使用setuptools来更好的实现命令行程序打包，把源码文件打包成系统中的可执行程序，并且不限平台。一般可通过在源码根目录下创建setup.py脚本，下面是一段简单的打包代码：

from setuptools import setup
setup(
    name='hello',
    version='0.1',
    py_modules=['hello'],
    install_requires=[
        'click',
    ],
    entry_points='''
        [console_scripts]
        hello=hello:cli
    ''',
)

留意entry_points字段，在console_scripts下，每一行都是一个控制台脚本，等号左边的是脚本的名称，右边的是click命令的导入路径。

5. 详解命令行参数

上面提到了自定义命令行参数的两个装饰器：@click.option() 和 @click.argument()，两者有些许区别，使用场景也有所不同。总体而言，argument() 装饰器比 option() 功能简单些，后者支持下面的特性：

• 自动提示缺失的输入；
• option 参数可以从环境变量中获取，argument 参数则不行；
• option 参数在 help 输出中有完整的文档，argument 则没有；
  而 argument 参数可以接受可变个数的参数值，而 option 参数只能接收固定个数的参数值（默认是 1 个）。Click 可以设置不同的参数类型，简单类型如 click.STRING，click.INT，click.FLOAT，click.BOOL。
  命令行的参数名由 “-short_name” 和 “--long_name” 声明，如果参数名既没有以 “-“ 开头，也没有以 “--” 开头，那么这边变量名会成为被装饰方法的内部变量，而非方法参数。

option参数

option最基础的用法就是简单值变量，option接收一个变量值：

@click.command()
@click.option('--n', default=1)
def dots(n):
    click.echo('.'*n)

若是需要传入多个值，可以理解为一个list，option只支持固定长度的参数值，即设置后必须传入，个数由nargs确定

@click.command()
@click.option('--pos', nargs=2, type=float)
def findme(pos):
    click.echo('%s / %s'%pos)

也支持tuple

@click.command()
@click.option('--item', type=(unicode, int))
def putitem(item):
    click.echo('name=%s id=%d'%item)

option支持同一个参数多次使用，通过mutiple标识
@click.option('-message', '-m', mutiple=True)

命令行参数是固定的几个值，这时可以用到click.choice类型来限定传参的潜在值

@click.option('--hash-type', type=click.choice(['md5', 'sha1'])

如果希望命令行程序能在我们错误输入或漏输入的情况下，友好地提示用户，就需要用到click的prompt功能

@click.option('--name', prompt=True)

如果在执行 hello 时没有提供–name参数，控制台会提示用户输入该参数。也可以自定义控制台的提示输出，把 prompt 改为自定义内容即可。

对于类似账户密码等参数的输入，就要进行隐藏显示，option的hide_input和confirmation_prompt标识来控制密码输入：

# password
@click.command()
@click.option('--password', prompt=True, hide_input=True,
              confirmation_prompt=True)
def encrypt(password):
    click.echo('Encrypting password to %s' % password.encode('rot13'))

click把上面的操作进一步封装成了装饰器click.password_option()

# password
@click.command()
@click.password_option()
def encrypt(password):
    click.echo('Encrypting password to %s' % password.encode('rot13')) 

有的参数会改变命令行程序的执行，比如 node 是进入 Node 控制台，而 node --verion 是输出 node 的版本号。Click 提供eager标识对参数名进行标记，拦截既定的命令行执行流程，而是调用一个回调方法，执行后直接退出。下面模拟 click.version_option() 的功能，实现 --version 参数名输出版本号：

# eager
def print_version(ctx, param, value):
    if not value or ctx.resilient_parsing:
        return
    click.echo('Version 1.0')
    ctx.exit()
@click.command()
@click.option('--version', is_flag=True, callback=print_version,
              expose_value=False, is_eager=True)
def hello():
    click.echo('Hello World!')

对于类似删除数据库表这样的危险操作，Click 支持弹出确认提示，--yes 标识位置为 True 时会让用户再次确认：

# yes parameters
def abort_if_false(ctx, param, value):
    if not value:
        ctx.abort()
@click.command()
@click.option('--yes', is_flag=True, callback=abort_if_false,
              expose_value=False,
              prompt='Are you sure you want to drop the db?')
def dropdb():
    click.echo('Dropped all tables!')

Click 对此进行了封装，click.confirmation_option() 装饰器实现了上述功能：

@click.command()
@click.confirmation_option(prompt='Are you sure you want to drop the db?')
def dropdb():
    click.echo('Dropped all tables!')

既然支持 Choice，不难联想到 Range，先看代码：

# range
@click.command()
@click.option('--count', type=click.IntRange(0, 20, clamp=True))
@click.option('--digit', type=click.IntRange(0, 10))
def repeat(count, digit):
    click.echo(str(digit) * count)
if __name__ == '__main__':
    repeat()