如何在测试click cli的时候验证python.logging产生的log

问题描述

这几天遇到了一个比较有趣的问题。我们组里有一个用click写的cli。我在给它写unittest。从click的文档上看，我可以使用CliRunner的invoke()这个方法。cli代码示例

@click.command()
@click.argument("name")
def hello(name):
    click.echo(f"Hello {name}!")
    logging.info("I am doing some logging")


def test_hello_world():
    runner = CliRunner()
    result = runner.invoke(hello, ["Peter"])
    print("Output is: " + result.output)

这是一个最简单的例子。我们在cli里就只用click.echo打印一个字符串，然后用logging.info打印一条log。这里是输出：

Output is: Hello Peter!

我们发现，log的内容并没有显示出来。通过查询手册，这个问题很快就得到了解决。这个问题的原因是logging的默认级别是warn及以上。所以info的级别比warn的级别低，所以没有被显示。那没有问题，我们修改一下我们的code，修改后的代码如下：

# Set log level to INFO
logging.basicConfig(level=logging.INFO)

@click.command()
@click.argument("name")
def hello(name)