是否可以在Python中进行代码覆盖率断言?

时间:2015-08-29 18:22:11

标签: python code-coverage coverage.py python-coverage

当我编写测试或调试代码时,我希望能够添加一行Python,如果该行从未执行过,它将通知我。这可能吗?

例如,我希望能够编写如下代码:

def f(x):
   if x==0:
      check_covered()
      return 1
   elif x==1:
      check_covered()
      return 2
   else:
      check_covered()
   return 3

f(1)
f(2)
print_all_missing_cases()

我希望输出告诉我其中一个分支从未被覆盖过。

我尝试了什么

方法1

我可以使用装饰器对函数执行此操作,如下所示:

missing_fns = set()

def covered(h):
    missing_fns.add(h.func_name)
    def h2(*args):
        missing_fns.remove(h.func_name)
        return h(*args)
    return h2 

@covered
def f(a):
    return a+1

@covered
def g(a):
    return a+2

f(0)
for x in missing_fns:
    print x,'is never called'

但是我正在努力寻找在编译函数期间激活的东西,我可以将其挂钩。

方法2

如果我将递增值传递给每个实例(例如check_covered(0),check_covered(1),check_covered(2),...),这也很简单,但是当我复制或删除代码时,这会变得很混乱。

方法3

可以通过运行代码覆盖率工具来获取此信息,但如果可能的话,我更愿意使用一些我有机会理解的简单Python代码来实现这一点。

1 个答案:

答案 0 :(得分:5)

我强烈建议您使用coverage模块。

有一个很好的教程,介绍如何获得最佳结果here

用法很简单:

coverage report

使用$ coverage report -m Name Stmts Miss Cover Missing ------------------------------------------------------- my_program 20 4 80% 33-35, 39 my_other_module 56 6 89% 17-23 ------------------------------------------------------- TOTAL 76 10 87%

查看结果
bindParam