python Click的使用

Posted 2021-02-18 r00too

Click 是 Flask 的团队 pallets 开发的开源项目，它使命令行数据处理变得更简单。

方法功能

• command：用于装饰一个函数，使得该函数作为命令行的接口
• option：用于装饰一个函数，主要功能是为命令行添加选项
• echo：用于输出结果，由于print函数在2.x和3.x之间存在不同之处，为了更好的兼容性，因此提供了echo输出方法
• Choice：输入为一个列表，列表中为选项可选择的值

属性描述

• default：给命令行选项添加默认值
• help：给命令行选项添加帮助信息
• type：指定参数的数据类型，例如int、str、float
• required：是否为必填选项，True为必填，False为非必填
• prompt：在命令行提示用户输入对应选项的信息
• nargs：指定命令行选项接收参数的个数，如果超过则会报错

import click
 
def test(pwd):
    click.secho(pwd, fg="red")
 
CONTEXT_SETTINGS = dict(help_option_names=[‘-h‘, ‘--help‘]) # -h 生效
@click.command(context_settings=CONTEXT_SETTINGS)
@click.option(‘-v‘, ‘--version‘, is_flag=True, help="显示版本") 
@click.option(‘--user‘, help="显示输入user")
@click.option(‘-p‘,‘--pwd‘, default="password", help="显示输入pwd")
 
def main(version,user,pwd):
    if version:
        click.secho("版本：1.0版本", fg="yellow") #自己体会
    elif user:
        click.secho(user, fg="blue") #输出接收之
    elif pwd:
        test(pwd)   #调用函数
        
if __name__ == ‘__main__‘:
    main()

使用

脚本执效果如图

总结

           希望可以帮到大家，祝大家玩得开心！