Pytest-cov无法生成终端/HTML代码覆盖率报告求助

我正在使用Python编写单元测试并尝试生成代码覆盖率报告，但无法看到终端报告或HTML报告。以下是我的项目信息及问题详情：

项目结构 #

.
|-- README.md
|-- bin
|   |-- do_something.py
|   `-- do_something.sh
|-- junit.xml
|-- lib
|   `-- __init__.py
|-- pytest.ini
|-- requirements-dev.txt
|-- requirements.txt
|-- setup.py
`-- tests
    |-- __init__.py
    |-- env.py
    `-- test_do_something.py

源码文件（bin/do_something.py） #

import sys

class DoSomething:
    def __init__(self, var=""):
        # define some initial variables
        self.var1 = var
        self.var2 = "Done"

    def do_something(self):
        var1 = self.var1 if self.var1 else "nothing"
        res = var1 + self.var2
        return res

def main(args):
    do_something_obj = DoSomething("Something")
    print(do_something_obj.do_something())

if __name__ == "__main__":
    main(sys.argv[1:])

注：原代码缺少import sys，这里补充以保证可运行

测试用例（tests/test_do_something.py） #

import unittest
from bin.do_something import DoSomething

class TestDoSomething(unittest.TestCase):

    def setUp(self):
        self.a = "test"
    
    def test_do_something(self):
        do_something_test_obj = DoSomething(self.a)
        self.assertEquals("test Done", do_something_test_obj.do_something())

注：原代码缺少import unittest和完整的父类引用，这里补充

配置文件 #

.coveragerc #

[run]
    include =
         bin/*.py,lib/*.py
    omit =
         setup.py,tests/*.py
[report]
    
    exclude_lines =
         if __name__ == .__main__.:

pytest.ini #

[pytest]
testpaths = tests

执行命令与输出 #

执行以下命令运行测试，测试用例可正常通过，但无覆盖率报告生成：

python3 -m py.test --cov='.' --cov-report=xml --cov-report=term --junitxml=junit.xml -o junit_family=xunit2

执行输出：

================================================================================= test session starts ==================================================================================
platform linux -- Python 3.6.8, pytest-7.0.1, pluggy-1.0.0
rootdir: /home/my_component, configfile: pytest.ini, testpaths: tests
plugins: cov-4.0.0
collected 5 items

tests/test_do_something.py .....                                                                                                                                               [100%]

============================================================================= 1 passed, 1 warning in 0.09s =============================================================================

环境信息 #

• Linux：

  CentOS Linux release 7.9.2009 (Core)
  5.4.201-1.el7.elrepo.x86_64
  x86_64 x86_64 x86_64 GNU/Linux
  

• Python：3.6.8
• pip依赖包：

  astroid (2.11.7)
  attrs (22.1.0)
  coverage (6.2)
  dill (0.3.4)
  importlib-metadata (4.8.3)
  iniconfig (1.1.1)
  isort (5.10.1)
  lazy-object-proxy (1.7.1)
  mccabe (0.7.0)
  packaging (21.3)
  pip (9.0.3)
  platformdirs (2.4.0)
  pluggy (1.0.0)
  py (1.11.0)
  pylint (2.13.9)
  pyparsing (3.0.9)
  pytest (7.0.1)
  pytest-cov (4.0.0)
  setuptools (39.2.0)
  tomli (1.2.3)
  typed-ast (1.5.4)
  typing-extensions (4.1.1)
  wrapt (1.14.1)
  zipp (3.6.0)
  

问题 #

单独使用--cov-report=html选项也无法生成HTML目录，且已多次删除并重建虚拟环境，问题仍未解决。请问这是什么原因？我遗漏了什么配置吗？

排查与解决方案 #

1. 修复.coveragerc配置错误 #

• exclude_lines格式问题：原配置中if __name__ == .__main__.:缺少引号，正确写法应为：

  exclude_lines =
       if __name__ == '__main__':
  

• include路径格式优化：将逗号分隔的路径改为每行一个，避免解析异常：

  [run]
      include =
           bin/*.py
           lib/*.py
      omit =
           setup.py
           tests/*.py
  

2. 解决bin目录的Python包识别问题 #

bin目录下缺少__init__.py，导致Python无法将其识别为正式包，coverage可能无法正确追踪该目录下的代码。在bin目录添加空的__init__.py文件即可。

3. 调整测试命令，避免配置冲突 #

命令中--cov='.'会覆盖.coveragerc里的include规则，导致coverage尝试追踪所有文件（包括已被omit的tests等目录），反而可能忽略目标代码。建议去掉--cov='.'，让coverage完全遵循.coveragerc的配置：

python3 -m pytest --cov-report=xml --cov-report=term --junitxml=junit.xml -o junit_family=xunit2

或者明确指定要覆盖的目录：

python3 -m pytest --cov=bin --cov=lib --cov-report=xml --cov-report=term --junitxml=junit.xml -o junit_family=xunit2

4. 验证coverage的路径匹配 #

确保在项目根目录执行测试命令，避免相对路径问题导致coverage无法找到目标文件。

5. 检查warning信息 #

输出中显示1 warning，可以添加-W error参数运行命令，强制显示warning详情，排查是否有影响coverage运行的潜在问题：

python3 -m pytest --cov=bin --cov=lib --cov-report=term -W error

内容的提问来源于stack exchange，提问作者sunny_benn