是否可以从coverage.py 报告中排除测试目录？

Question

我是Python单元测试的新手，尤其是coverage.py。覆盖率报告是否需要包含实际测试文件的覆盖率？

以下是我的 HTML 报告 的屏幕截图作为示例。

您可以看到报告包含 tests/test_credit_card。起初，我试图从报告中省略 tests/ 目录，如下所示：

coverage html --omit=tests/ -d tests/coverage

我尝试了该命令的几种变体，但我终其一生都无法得到测试/排除。接受失败后，我开始怀疑测试文件是否应该包含在报告中。

有人能解释一下吗？

Answer 1

在项目根文件夹中创建 .coveragerc 文件，并包含以下内容：

[run]
omit = *tests*

Answer 2

覆盖率 html --omit="*/test*" -d 测试/覆盖率

Answer 3

如果任何 Django 开发人员需要为其项目提供 .coveragerc，请将其保留在此处。

[run]
source = .
omit = ./venv/*,*tests*,*apps.py,*manage.py,*__init__.py,*migrations*,*asgi*,*wsgi*,*admin.py,*urls.py

[report]
omit = ./venv/*,*tests*,*apps.py,*manage.py,*__init__.py,*migrations*,*asgi*,*wsgi*,*admin.py,*urls.py

在项目根目录中创建一个名为 .coveragerc 的文件，粘贴上面的代码，然后运行以下命令：

coverage run manage.py test

此外，如果您希望测试执行得更快，请运行此命令。

coverage run manage.py test --keepdb --parallel

这将保留测试数据库并并行运行测试。

Answer 4

您可以通过在项目根目录中创建 .coveragerc 来指定要排除的目录。

它支持通配符（您可以使用它来排除虚拟环境）和注释（对于有效跟踪非常有用）。

下面的代码块显示了如何使用 omit （取自 最新文档）包含多个文件和目录。

[run]
omit =
    # omit anything in a .local directory anywhere
    */.local/*
    # omit everything in /usr
    /usr/*
    # omit this single file
    utils/tirefire.py

对于您的情况，您的 .coveragerc 中可能包含以下内容：

[run]
omit = 
    # ignore all test cases in tests/
    tests/*

对于有关覆盖率报告的问题，您可以按以下方式考虑测试和覆盖率：

• 当您运行 pytest 时 或 unittest，执行源代码的所有测试用例

• 当您运行coverage时，它会显示该部分未使用的源代码。

• 当您运行具有覆盖率的 pytest（类似于 pytest -v --cov）时，它会运行所有测试用例并显示源代码中不存在的部分没有被使用。

额外：

• 您还可以在配置文件中指定 HTML 报告的位置，例如：

[html]
directory = tests/coverage/html_report/

这将创建 html、js、每次运行 coverage 或 pytest -v --cov 时，在 tests/coverage/html_report/ 内 >css 等

Answer 5

您还可以明确指定哪个目录包含您想要覆盖的代码，而不是说明要省略哪些内容。在 .coveragerc 文件中，如果感兴趣的目录名为 demo，则如下所示

[run]
source = demo

Answer 6

我遇到了同样的问题，并尝试了该线程上的所有回复。不想创建 .coveragerc 文件，我在这里找到了答案：
https://coverage.readthedocs.io/en/latest/source.html# source

你错过了星号：

coverage html --omit=tests/* -d tests/coverage

这对我有用 - 尽管我没有指定目录，所以我只是使用：

coverage html --omit=tests/*