配置pyproject.toml用于unittest与coverage时main.py未被统计的问题

以下是导致mypackage/main.py未被coverage统计的常见原因及对应解决步骤：

1. 测试代码未导入该模块 #

coverage仅会统计被测试过程加载过的模块，如果你的测试代码里完全没有导入mypackage.main，也没有调用其中的任何代码，coverage根本不会追踪到这个文件的存在。

• 解决：在测试文件中添加导入语句（哪怕只是from mypackage import main），或者编写针对main.py中函数/类的测试用例，确保模块被加载。

2. coverage配置的路径匹配错误 #

检查pyproject.toml中的coverage配置，路径规则写不对会导致文件被排除在统计外：

• 推荐使用source字段替代include，更可靠地匹配模块目录：

  [tool.coverage.run]
  source = ["mypackage"]  # 自动包含该目录下所有Python模块
  command_line = "python -m unittest discover"
  

• 如果坚持用include，需确保规则覆盖到main.py：

  include = ["mypackage/*.py", "mypackage/**/*.py"]  # 匹配目录下所有.py文件
  

3. 运行coverage的工作目录错误 #

如果你的终端当前工作目录不是项目根目录（即包含mypackage、tests、pyproject.toml的目录），coverage的路径匹配会失效。

• 解决：切换到项目根目录后再执行命令：

  coverage run
  coverage report
  

4. main.py的代码结构问题 #

如果main.py的核心代码全部写在if __name__ == "__main__"块中，且测试过程没有触发这个代码块：

• 虽然文件会出现在coverage报告中（显示0%覆盖率），但如果连报告条目都没有，还是回到前面的导入/配置问题；
• 优化代码结构：把__main__块里的逻辑提取成独立函数，在测试中直接调用该函数，确保代码能被统计：

  # mypackage/main.py
  def run_main():
      # 原__main__块中的代码
      pass
  
  if __name__ == "__main__":
      run_main()
  

5. 验证配置有效性 #

执行coverage debug sys命令，查看coverage的系统配置详情，确认source或include路径是否正确匹配到了mypackage/main.py。

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