如何查找覆盖范围内从未执行过的代码。尽管有100%的覆盖率报告

Question

考虑以下代码：

import math

def dumb_sqrt(x):
    result = math.sqrt(x) if x >= 0 else math.sqrt(-x)*j
    return result


def test_dumb_sqrt():
    assert dumb_sqrt(9.) == 3.

测试可按如下方式执行：

$ pip install pytest pytest-cov
$ pytest test_thing.py --cov=test_thing --cov-report=html --cov-branch

覆盖报告将考虑涵盖的所有第100%行，即使启用分支覆盖：

然而，这段代码有一个错误，那些有敏锐眼光的人可能已经看到了。如果它进入“其他”分支，将会有一个例外：

NameError: global name 'j' is not defined

修复该错误很容易：将未定义的j名称更改为文本1j。还可以很容易地添加另一个测试来揭示错误：assert dumb_sqrt（-9.）==3j。这也不是这个问题所要问的。我想知道如何找到尽管有100%的代码覆盖率报告但从未实际执行过的代码段。

使用条件表达式就是这样一个罪魁祸首，但是在任何地方都有类似的情况，Python可以使计算短路（x或y，x和y是其他例子）。

最好，上面的第4行可以在报告中被着色为黄色，类似于“如果”行如果首先避免使用条件表达式会呈现的方式：

coverage.py是否支持这样的功能？如果是，如何在您的cov报告中启用“内联分支覆盖”？如果没有，有没有其他方法来识别测试套件从未实际执行的“隐藏”代码？

Answer 1

如果不使用res1，也不要使用res2——它必须被视为一个单独的语句。如果你把这写成如果/否则，我认为coverage.py会做得更好。

考虑使用pylint之类的东西，或者至少使用pyflakes。我相信这些会自动检测到问题。

Answer 2

不，保险范围。py不处理表达式中的条件分支。这不仅影响Python条件表达式，使用和或或也会受到影响：

# pretending, for the sake of illustration, that x will never be 0
result = x >= 0 and math.sqrt(x) or math.sqrt(-x)*j

coverage.py的维护者Ned Batchelder在2007年的一篇文章中称之为隐藏条件，该文章涵盖了coverage.py无法处理的情况。

这个问题也延伸到if语句！举个例子：

if condition_a and (condition_b or condtion_c):
    do_foo()
else:
    do_bar()

如果当条件a为真时条件b始终为真，则您永远不会在条件c中找到打字错误，如果您仅依赖于对流，则不会。py，因为不支持条件覆盖（更不用说更高级的概念，如修改的条件/决策覆盖和多条件覆盖）。

支持有条件覆盖的一个障碍是技术：覆盖。py在很大程度上依赖于Python的内置跟踪支持，但直到最近，它才允许您跟踪每行的执行情况。Ned实际上探索了解决这个问题的方法。

并不是说这阻止了一个不同的项目，不管怎样，它都有助于提供条件/决策覆盖。该项目使用AST重写和导入钩子添加额外的字节码，让它跟踪个别条件的结果，从而让您对表达式的“真值表”有一个概述。这种方法有一个巨大的缺点：它非常脆弱，并且经常需要更新新的Python版本。因此，该项目与Python3.4背道而驰，尚未修复。

然而，Python3.7增加了对操作码级别跟踪的支持，允许跟踪程序分析每个字节码的效果，而不必求助于AST黑客。而且有覆盖范围。py 5.0已达到稳定状态，项目似乎正在考虑增加对条件覆盖的支持，可能的赞助商支持开发。

所以你现在的选择是：

• 在Python3.3中运行代码，并使用instrumental
• 修复工具以在较新的Python版本上运行
• 等待报道。py添加条件覆盖范围
• 帮助编写覆盖范围的功能。py
• 使用Python3.7或更新的“操作码”跟踪模式，将您自己版本的instrumental方法拼凑在一起