如何从pytest-cov中批量排除自定义异常类？

方案一：利用coverage.py的配置规则自动匹配（推荐） #

如果使用Python主流的coverage.py工具，可以通过配置文件的正则匹配规则，自动排除所有以Error或Exception结尾的类及其核心方法，无需手动逐个添加。

配置方式： #

在项目根目录创建或修改.coveragerc文件，添加以下规则：

[run]
# 如果异常类单独放在以Error/Exception结尾的文件中，直接排除整个文件
omit =
    */*Error.py
    */*Exception.py

[report]
# 如果异常类和其他代码在同一文件中，匹配类定义行及方法定义行排除
exclude_lines =
    # 排除所有以Error/Exception结尾的类定义
    ^class .*Error:$
    ^class .*Exception:$
    # 排除这些异常类的__init__方法
    ^    def __init__\(self
    # 排除这些异常类的__str__方法（如果不需要测试的话）
    ^    def __str__\(self

这种方式完全基于配置实现，扩展性极强，新增符合命名规则的异常类会自动被纳入排除范围。

方案二：用元类批量标记排除注释 #

如果需要更灵活的控制（比如仅排除部分方法，或给异常类统一添加排除标记），可以通过元类自动为所有自定义异常类的目标方法添加# pragma: no cover标记（coverage工具会识别该注释并跳过统计）。

实现代码： #

class ExceptionMeta(type):
    def __new__(cls, name, bases, attrs):
        # 仅处理以Error或Exception结尾的类
        if name.endswith(('Error', 'Exception')):
            # 自动为__init__方法添加排除标记
            if '__init__' in attrs:
                original_init = attrs['__init__']
                def wrapped_init(self, *args, **kwargs):
                    # pragma: no cover
                    return original_init(self, *args, **kwargs)
                attrs['__init__'] = wrapped_init
            
            # 自动为__str__方法添加排除标记（按需启用）
            if '__str__' in attrs:
                original_str = attrs['__str__']
                def wrapped_str(self):
                    # pragma: no cover
                    return original_str(self)
                attrs['__str__'] = wrapped_str
        
        return super().__new__(cls, name, bases, attrs)

# 自定义异常基类，所有业务异常继承此类即可
class BaseCustomException(Exception, metaclass=ExceptionMeta):
    pass

# 示例异常类，无需手动添加排除标记
class DataValidationError(BaseCustomException):
    def __init__(self, field, message):
        self.field = field
        self.message = message
    
    def __str__(self):
        return f"Validation failed for {self.field}: {self.message}"

后续新增自定义异常类时，只需继承BaseCustomException，对应的方法会自动被排除在覆盖率统计外，无需重复配置。

方案三：自定义coverage插件实现动态排除 #

如果项目有特殊的异常类命名规则或更复杂的排除逻辑，可以编写自定义coverage插件，动态扫描代码中的异常类并排除指定方法。

核心实现示例： #

from coverage.plugin import CoveragePlugin
from coverage.python import PythonFileReporter

class ExceptionCoveragePlugin(CoveragePlugin):
    def file_reporter(self, filename):
        return ExceptionPythonFileReporter(filename)

class ExceptionPythonFileReporter(PythonFileReporter):
    def lines_to_exclude(self):
        exclude_lines = super().lines_to_exclude()
        with open(self.filename, 'r', encoding='utf-8') as f:
            lines = f.readlines()
        
        in_exception_class = False
        for line_num, line in enumerate(lines, 1):
            stripped_line = line.strip()
            # 识别以Error/Exception结尾的类定义
            if stripped_line.startswith('class') and stripped_line.endswith(('Error:', 'Exception:')):
                in_exception_class = True
            # 识别异常类内的__init__和__str__方法并排除
            elif in_exception_class and stripped_line.startswith(('def __init__(self', 'def __str__(self')):
                exclude_lines.add(line_num)
            # 退出异常类识别（遇到非缩进的非空行）
            elif in_exception_class and stripped_line and not stripped_line.startswith((' ', '\t', '#')):
                in_exception_class = False
        
        return exclude_lines

然后在.coveragerc中注册插件：

[run]
plugins =
    path.to.your.plugin.module.ExceptionCoveragePlugin

这种方案灵活性最高，可根据项目需求调整扫描和排除逻辑。

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