Python3 Click模块的使用方法详解

简介

Click是一个Python模块，提供命令行解析器的支持。它是使用Python编写的，非常简单易用。它支持参数解析、子命令、自动帮助文档生成等功能，可以让您快速构建一个易用又好看的命令行工具。

安装与使用

在终端中输入以下命令即可安装Click模块：

pip3 install click

引入Click模块：

import click

命令行函数

使用Click模块，可以通过定义命令行函数来实现解析命令行参数和子命令的功能。使用装饰器@click.command定义命令行函数，并使用@click.option处理命令行参数。例如：

@click.command()
@click.option('--name', prompt='请输入姓名', help='输入你的姓名')
@click.option('--age', prompt='请输入年龄', help='输入你的年龄')
def hello(name, age):
    click.echo(f'你好{name}，今年{age}岁。')

这段代码实现了一个hello命令，该命令需要输入name和age两个参数。使用click.echo打印输出。

Click的基本命令

click.echo()

该命令用于在命令行中输出一行文本。格式如下：

click.echo(text=None, file=None, nl=True, err=False, color=None, **styles)

• text：需要输出的文本
• file：将输出的文本重定向到指定文件
• nl：末尾是否添加newline
• err：是否将文本重定向到错误输出
• color：输出文本的颜色
• styles：设置输出文本的样式

click.confirm()

该命令用于在命令行中输出一段文本，并等待用户输入yes或no进行确认。格式如下：

click.confirm(text, default=False, abort=False, prompt_suffix=': ')

• text：需要询问的文本
• default：默认结果是False还是True
• abort：如果用户不同意，是否终止程序
• prompt_suffix：在文本后面添加的提示符

click.prompt()

该命令用于在命令行中输入一段文本。格式如下：

click.prompt(text, default=None, hide_input=False, confirmation_prompt=False, type=None, value_proc=None, prompt_suffix=': ')

• text：需要输入的文本
• default：如果用户不输入内容，使用的默认值
• hide_input：输入内容时是否隐藏用户的输入
• confirmation_prompt：是否需要二次确认
• type：输入内容的数据类型
• value_proc：输入内容的处理函数
• prompt_suffix：在文本后面添加的提示符

示例

示例一

import click

@click.command()
@click.option('--debug', is_flag=True, help='Start debug mode.')
@click.option('--count', '-c', default=1, help='启动次数.')
@click.argument('name')
def hello(name, debug, count):
    if debug:
        click.echo('Debug模式已开启！')
    for i in range(count):
        click.echo(f'Hi {name}!')

if __name__ == '__main__':
    hello()

如果用户的输入为：

python test.py --count=3 yzy --debug

则输出结果为：

Debug模式已开启！
Hi yzy!
Hi yzy!
Hi yzy!

示例二

import click

@click.command()
@click.option('--name', prompt='请输入姓名', help='我的名字是')
@click.option('--age', prompt='请输入年龄', help='我的年龄是')
@click.option('--gender', type=click.Choice(['M', 'F']), prompt='请选择您的性别', help='我的性别是')
def info(name, age, gender):
    """
    info命令用于展示我的个人信息
    """
    click.echo(f'我的名字是{name}，今年{age}岁，性别为{gender}。')

if __name__ == '__main__':
    info()

如果用户的输入为：

python test.py

则输出结果为：

请输入姓名: yzy
请输入年龄: 20
请选择您的性别 [M,F]: F
我的名字是yzy，今年20岁，性别为F。

总结

Click模块提供了很多命令行开发的工具，可以帮助开发者快速构建简单而易用的命令行工具。和argparse相比，Click更简洁，而且输出的文档更美观易读。