通过这个工具，功能测试人员也能使用你的 python 脚本

自动化测试的时候有一个不方便的地方在于，功能测试人员不会用， 更不会往脚本里传参数。 我们可以通过命令行工具配置 help 说明告诉其他人员怎么使用，而且可以通过参数动态传值，python 最好用的恐怕要数 click 了，click 是 flask 框架的作者开发的。 和林纳斯开发 git 一样，为了更好的管理 linux 这个项目，林纳斯开发了 git. 为了让 flask 使用更方便，Armin Ronacher 开发了 click。

1，快速开始

命令行使用能在运行的时候动态传值让程序做自己想做的事情。现在有一个很简单的程序：

# loops.py
def run_loop(times=1):
    for i in range(times):
        print("running {} times".format(i+1))

if __name__ == '__main__':
    run_loop()

这个程序想通过 num 的值去决定打印多少次，这次我希望打印 2 次， 下次我希望打印 10 次，所以需要手动修改 num 的实际参数。如果使用命令行，就可以通过命令行输入 10 这个参数做到动态赋值。类似于这样：

python loops.py 10
# 或者
python loops.py --times 10

只需要修改原来的代码：

@click.command()
@click.option('--times', default=1, help='times to run')
def run_loop(times=1):
    ...

注意：--times 和 参数 times 保持一致，不然会报错。

加上这 2 行以后，就可以使用帮助信息和参数了。

运行 python loops.py --help:

Usage: d1_loops.py [OPTIONS]

Options:
  --times INTEGER  times to run
  --help           Show this message and exit.

运行 python loops.py --times 3:

running 1 times
running 2 times
running 3 times

2，argument 必传参数

@click.argument('name')
def run_loop(name, times=1):
    for i in range(times):
        print("running {} times {}".format(i+1, name))

如果不传参数就会报错：

C:\data\jianguoyun\文章\未整理\20191107-study_click>python d1_loops.py
Usage: d1_loops.py [OPTIONS] NAME
Try "d1_loops.py --help" for help.

Error: Missing argument "NAME".

3，setup

1, 以脚本的形式安装库，安装完以后，可以通过脚本命令 hello 直接运行：

# setup.py

from setuptools import setup

setup(name='hello',
      version='0.1',
      install_requires=[
          'click',
      ],
      py_modules=['d1_loops'],
      entry_points = '''
            [console_scripts]
            hello=d1_loops:run_loop
      ''',
      )

• name, 脚本名称，hello --help 运行脚本；

• version, 版本信息，可以不填。

• install_requires, 需要的依赖；

• py_modules, 需要的模块；

• entry_points, 指明脚本的入口函数

配置完以后直接在命令行运行 hello yuz。

4，echo

click.echo('Initialized the database')

如果使用 print, python2 和 python3 的用法不一样，而 echo 能做到兼容。

5，secho

click.secho("running {} times {}".format(i+1, name), fg='green')

输入 python loop.py yuz --times 4 ：

参数说明：

• fg, 字体颜色；

• bg, 背景颜色；

• underline, windows下无效；

• flink, windows下无效；

• bold, windows下无效；

6，总结

这篇我们介绍了 click 的基础使用：

• 加上 @click.command() 装饰器，你的脚本就具备了命令行配置的能力；

• 必备参数使用 @click.argument('name')

• 可选参数使用 @click.option()

• 可以通过 setup.py 工具打包你的脚本，通过关键字 script_name 运行，而不是 python script_name.py 了。这种我们经常见到，比如 pytest, unittest 就可以直接通过关键字运行，这都是打包工具的功劳。

• 通过 secho可以让控制台输出更加好看。