Python：装饰器可以确定函数是否在类中定义吗？

Question

我正在编写一个装饰器，出于各种烦人的原因[0]，检查它所包装的函数是独立定义还是作为类的一部分定义（以及新类是哪些类的子类）是很方便的。

例如：

def my_decorator(f):
    defined_in_class = ??
    print "%r: %s" %(f, defined_in_class)

@my_decorator
def foo(): pass

class Bar(object):
    @my_decorator
    def bar(self): pass

应该打印：

<function foo …>: False
<function bar …>: True

另外，请注意：

• 在应用装饰器时，该函数仍然是一个函数，而不是未绑定的方法，因此测试实例/未绑定的方法（使用 typeof 或 检查）将不起作用。
• 请仅提供解决这个问题的建议 - 我知道有很多类似的方法可以实现这一目标（例如，使用类装饰器），但我希望它们发生在装修时间，不晚。

[0]：具体来说，我正在编写一个装饰器，可以轻松使用 nose 进行参数化测试。但是，nose 不会在unittest.TestCase 的子类上运行测试生成器，因此我希望我的装饰器能够确定它是否正在运行在 TestCase 的子类中使用并失败并出现适当的错误。显而易见的解决方案 - 在调用包装函数之前使用 isinstance(self, TestCase) 不起作用，因为包装函数需要成为一个生成器，而这不能得到完全执行。

Answer 1

包装方法时，请查看 inspect.stack() 的输出。当装饰器执行时，当前堆栈帧是对装饰器的函数调用；下一个堆栈帧是应用于新方法的 @ 包装操作；第三个框架将是类定义本身，它需要一个单独的堆栈框架，因为类定义是它自己的名称空间（在执行完成时被包装以创建一个类）。

因此，我建议：

defined_in_class = (len(frames) > 2 and
                    frames[2][4][0].strip().startswith('class '))

如果所有这些疯狂的索引看起来无法维护，那么您可以通过将框架一块一块地拆开来更明确，如下所示：

import inspect
frames = inspect.stack()
defined_in_class = False
if len(frames) > 2:
    maybe_class_frame = frames[2]
    statement_list = maybe_class_frame[4]
    first_statment = statement_list[0]
    if first_statment.strip().startswith('class '):
        defined_in_class = True

请注意，我没有看到任何询问Python的方法关于包装器运行时的类名或继承层次结构；该点在处理步骤中“为时过早”，因为类创建尚未完成。要么自己解析以 class 开头的行，然后查看该框架的全局变量以查找超类，要么浏览 frames[1] 代码对象以查看您想要的内容可以学习 - 上面代码中的类名似乎是 frames[1][0].f_code.co_name ，但是我找不到任何方法来了解当类创建完成。

Answer 2

虽然有点晚了，但这已被证明是确定装饰器是否正在类中定义的函数上使用的可靠方法：

frames = inspect.stack()

className = None
for frame in frames[1:]:
    if frame[3] == "<module>":
        # At module level, go no further
        break
    elif '__module__' in frame[0].f_code.co_names:
        className = frame[0].f_code.co_name
        break

与已接受的答案相比，此方法的优点是它可以与例如 py2exe 一起使用。

Answer 3

我得到了一些 hacky 解决方案：

import inspect

def my_decorator(f):
    args = inspect.getargspec(f).args
    defined_in_class = bool(args and args[0] == 'self')
    print "%r: %s" %(f, defined_in_class)

但它依赖于函数中 self 参数的存在。

Answer 4

您可以使用包 wrapt 来检查
- 实例/类方法
- 课程
- 独立函数/静态方法：

参见 wrapt 的项目页面：https:// pypi.org/project/wrapt/

Answer 5

您可以检查装饰器本身是否在模块级别调用或嵌套在其他内容中。

defined_in_class = inspect.currentframe().f_back.f_code.co_name != "<module>"

Answer 6

我认为 inspect 模块中的函数将执行您想要的操作，特别是 isfunction 和 ismethod：

>>> import inspect
>>> def foo(): pass
... 
>>> inspect.isfunction(foo)
True
>>> inspect.ismethod(foo)
False
>>> class C(object):
...     def foo(self):
...             pass
... 
>>> inspect.isfunction(C.foo)
False
>>> inspect.ismethod(C.foo)
True
>>> inspect.isfunction(C().foo)
False
>>> inspect.ismethod(C().foo)
True

然后您可以按照类型和成员表 访问绑定或未绑定方法内的函数：

>>> C.foo.im_func
<function foo at 0x1062dfaa0>
>>> inspect.isfunction(C.foo.im_func)
True
>>> inspect.ismethod(C.foo.im_func)
False