如何在coverage.py报告中排除仅含pass的可选重写方法？

针对你遇到的父类中可选重写的空方法（仅含pass）在coverage报告中显示未覆盖的问题，有以下几种精准且不破坏代码风格的解决方案：

1. 用单行注释精准排除特定代码 #

在需要忽略的pass语句上方添加# pragma: no cover注释，coverage.py会自动跳过该行的覆盖率统计。修改后的代码示例：

class MySuperclass:
    def hello(self):
        print("Hello")
        self._hello_printed()

    # A child class is allowed to override this if needed, but does not have to
    def _hello_printed(self):
        # pragma: no cover
        pass

class MyChild1(MySuperclass):
    def _hello_printed(self):
        print("World")

class MyChild2(MySuperclass):
    # Some other child class stuff
    pass

这种方式只针对目标代码，不会误排除其他逻辑，也无需改变原有代码结构。

2. 通过coverage配置文件批量排除 #

如果有大量这类空方法，可以创建.coveragerc配置文件，用正则匹配规则来批量排除。比如针对下划线开头的空实现方法，配置如下：

[run]
omit =
    # 匹配类中仅包含pass的下划线开头方法
    */*.py:def _.*\(\):
    */*.py:    pass

注意：正则规则需要根据你的实际方法命名风格调整，避免误匹配其他有效代码。

3. 自定义装饰器统一标记排除 #

先定义一个无实际功能的装饰器，用来标记这类可选重写的方法：

def optional_override(func):
    return func

然后给父类中的目标方法添加装饰器：

class MySuperclass:
    def hello(self):
        print("Hello")
        self._hello_printed()

    # A child class is allowed to override this if needed, but does not have to
    @optional_override
    def _hello_printed(self):
        pass

最后在.coveragerc中配置排除被该装饰器标记的方法：

[run]
omit =
    */*.py:@optional_override

这种方式适合需要统一管理这类方法的场景，后续新增同类方法只需添加装饰器即可。

推荐方案 #

优先选择第一种方法，它改动最小、精准度最高，完全符合你不想改变代码风格的需求。

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