Python 如何实现类属性废弃：调用废弃属性时自动触发警告

基于Python标准库warnings模块，将需要废弃的属性封装为property，在访问/赋值逻辑中注入警告即可实现需求，完整示例如下：

import warnings

class A:
    def __init__(self, variable1: int, variable2: int):
        self.variable1 = variable1
        # 废弃属性内部用私有变量存储，避免外部直接访问
        self._variable2 = variable2

    @property
    def variable2(self):
        warnings.warn(
            "variable2 属性已废弃，后续版本将移除，请停止使用",
            DeprecationWarning,
            # stacklevel设为2可让警告指向用户调用属性的代码行，而非类内部代码
            stacklevel=2
        )
        return self._variable2

    # 若需要支持属性赋值也触发警告，添加如下setter方法
    @variable2.setter
    def variable2(self, value):
        warnings.warn(
            "variable2 属性已废弃，后续版本将移除，请停止使用",
            DeprecationWarning,
            stacklevel=2
        )
        self._variable2 = value

效果验证 #

当用户调用该属性时，就会收到废弃警告：

# 初始化实例不会触发警告
a = A(variable1=1, variable2=2)
# 访问属性触发警告
print(a.variable2)
# 给属性赋值也会触发警告（需实现setter方法）
a.variable2 = 3

注意事项 #

Python默认会过滤DeprecationWarning类型的警告，如果运行代码没有看到警告提示，可以通过两种方式开启：

• 运行脚本时加参数：python -Wd 你的脚本名.py
• 在代码开头添加配置：warnings.simplefilter('always', DeprecationWarning)

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