如何实现装饰器：识别类方法的实例直接调用并触发警告？

你需要的是一个装饰器，用于标记类中仅应内部调用的方法，当用户通过实例直接调用时触发警告，而类内部调用则正常执行。以下是可行的实现方案：

需求回顾 #

期望效果：

• 类内部调用被装饰方法（如callableMethod中调用self.otherMethod()）：无警告，正常执行
• 实例直接调用被装饰方法（如i.otherMethod()）：触发警告，仍正常执行方法逻辑

装饰器实现代码 #

import inspect
import warnings

def NoInstanceMethod(func):
    def wrapper(self, *args, **kwargs):
        # 获取调用当前方法的栈帧
        caller_frame = inspect.currentframe().f_back
        caller_func_name = caller_frame.f_code.co_name
        
        # 获取当前类的所有方法名称
        cls_methods = [m[0] for m in inspect.getmembers(self.__class__, inspect.isfunction)]
        
        # 判断调用者是否不属于当前类的方法
        if caller_func_name not in cls_methods:
            warnings.warn(
                f"警告：方法 {func.__name__} 仅建议在类内部调用，请勿直接通过实例调用",
                UserWarning
            )
        
        # 执行原方法逻辑
        return func(self, *args, **kwargs)
    return wrapper

测试示例 #

使用你提供的Example类测试：

class Example:
    def __init__(self):
        self.sth = 0

    def callableMethod(self, is_true):
        if is_true: 
            self.otherMethod()
        print(self.sth)

    @NoInstanceMethod
    def otherMethod(self):
        self.sth = 1

测试场景1：类内部调用 #

i = Example()
i.callableMethod(True)  # 无警告，输出结果：1

测试场景2：实例直接调用 #

i = Example()
i.otherMethod()  # 触发UserWarning警告，输出结果：1

实现原理 #

1. 调用栈分析：通过inspect.currentframe().f_back获取调用当前方法的栈帧，从而得到调用者的函数名
2. 类方法校验：通过inspect.getmembers获取当前类的所有方法名称，判断调用者是否属于类内部方法
3. 警告触发：如果调用者不在类方法列表中，说明是实例直接调用，通过warnings模块触发提示

可选调整 #

• 若不想使用warnings模块，可替换为打印日志或自定义提示信息
• 若需要更严格的校验（比如排除子类方法），可以扩展逻辑判断调用者的类归属

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