如何在`attrs`验证器中发出带有正确`stacklevel`的警告？

这个问题确实挺头疼的——attrs的验证器不管是在类实例化还是属性赋值时都会触发，但这两种场景下调用栈的深度不一样，固定写死stacklevel肯定不行。我给你分享几个实用的解决办法：

方法一：动态计算正确的stacklevel #

最优雅的方式是通过inspect模块遍历调用栈，自动跳过attrs内部和当前模块的代码帧，找到用户代码的位置，然后返回对应的stacklevel。这样不管是实例化还是属性赋值，警告都会精准指向用户的代码行。

示例代码：

import attrs
import warnings
import inspect

valid_names = ["a", "b", "c"]

def get_user_stacklevel():
    current_module = __name__
    # 跳过attrs相关的模块
    attrs_related_modules = {"attrs", "attr"}
    
    # 遍历调用栈
    for stack_index, frame_info in enumerate(inspect.stack()):
        frame_module = inspect.getmodule(frame_info[0])
        if frame_module is None:
            continue
        module_name = frame_module.__name__
        # 找到第一个不在attrs和当前模块的帧
        if module_name not in attrs_related_modules and module_name != current_module:
            # stacklevel是相对于warnings.warn调用的层数，所以要+1
            return stack_index + 1
    # 兜底返回默认值
    return 2

@attrs.define
class Example:
    name: str = attrs.field()

    @name.validator
    def ensure_name_valid(self, attribute, value):
        if value not in valid_names:
            warnings.warn("'name' not a valid name", stacklevel=get_user_stacklevel())

# 测试一下，警告会指向这两行
e = Example(name="x")
e.name = "y"

这个方法的好处是不需要关心attrs内部的调用逻辑，不管版本怎么变，只要用户代码在外部模块，就能正确定位。

方法二：区分构造和赋值场景手动设置stacklevel #

如果你不想用inspect，也可以通过检查调用栈里的函数名，判断当前是实例化（调用__init__）还是属性赋值（调用__setattr__），然后手动设置不同的stacklevel：

import attrs
import warnings
import inspect

valid_names = ["a", "b", "c"]

@attrs.define
class Example:
    name: str = attrs.field()

    @name.validator
    def ensure_name_valid(self, attribute, value):
        if value not in valid_names:
            # 检查是否在实例化阶段
            is_initializing = any(frame.function == "__init__" for frame in inspect.stack())
            # 实例化时stacklevel用3，赋值时用2
            stacklevel = 3 if is_initializing else 2
            warnings.warn("'name' not a valid name", stacklevel=stacklevel)

e = Example(name="x")
e.name = "y"

不过这个方法依赖于attrs内部的函数名，万一后续版本改动了__init__相关的实现，可能就失效了，所以不如第一种方法可靠。

替代方案：自定义警告输出（不用warnings模块） #

如果不想纠结stacklevel的问题，也可以自己捕获栈帧信息，直接打印带有用户代码位置的警告信息，比如：

import attrs
import inspect

valid_names = ["a", "b", "c"]

def warn_with_user_location(message):
    # 找到用户代码的栈帧
    current_module = __name__
    attrs_modules = {"attrs", "attr"}
    for frame_info in inspect.stack():
        module = inspect.getmodule(frame_info[0])
        if module and module.__name__ not in attrs_modules and module.__name__ != current_module:
            filename = frame_info.filename
            line_num = frame_info.lineno
            print(f"UserWarning: {message} (at {filename}:{line_num})")
            break

@attrs.define
class Example:
    name: str = attrs.field()

    @name.validator
    def ensure_name_valid(self, attribute, value):
        if value not in valid_names:
            warn_with_user_location("'name' not a valid name")

e = Example(name="x")
e.name = "y"

这种方式完全绕开了warnings模块的stacklevel问题，直接输出用户关心的位置信息，适合对警告格式有自定义需求的场景。

备注：内容来源于stack exchange，提问作者RedRuin