如何使用给定的装饰器获取python类的所有方法


78

如何获取用@ decorator2装饰的给定类A的所有方法?

class A():
    def method_a(self):
      pass

    @decorator1
    def method_b(self, b):
      pass

    @decorator2
    def method_c(self, t=5):
      pass

2
您对“ decorator2”源代码有任何控制权吗?
2011年

8
我们说不,只是为了保持趣味。但是当它使解决方案变得更加容易时,我也对这种解决方案感兴趣。
克拉兹2011年

16
+1:“保持有趣”:通过这种方式了解更多信息
Lauritz V. Thaulow

10
@ S.Lott:您的意思是说,通过搜索可以减少学习。查看下面的最高答案。这对SO来说不是一个很好的贡献,可以增加它作为程序员资源的价值吗?我主张,主要的原因,为什么这个问题的答案是那么好,是@kraiz要“保持有趣”。您所链接问题的答案不包含以下答案的十分之一的信息,除非您将导致此情况的两个链接数都计算在内。
Lauritz V. Thaulow 2011年

Answers:


114

方法1:基本注册装饰器

我已经在这里回答了这个问题:在Python中通过数组索引调用函数=)


方法2:源代码解析

如果您无法控制定义(它是您想要的假设的一种解释),则这是不可能的(没有代码的读取-反射),因为装饰器可以是无操作的装饰器(例如在我的链接示例中)仅返回未修改的函数。(但是,如果您允许自己包装/重新定义装饰器,请参见方法3:将装饰器转换为“具有自我意识”,那么您将找到一个优雅的解决方案)

这是一个可怕的骇客,但是您可以使用该inspect模块读取源代码本身并进行解析。这在交互式解释器中将不起作用,因为检查模块将拒绝以交互方式提供源代码。但是,以下是概念证明。

#!/usr/bin/python3

import inspect

def deco(func):
    return func

def deco2():
    def wrapper(func):
        pass
    return wrapper

class Test(object):
    @deco
    def method(self):
        pass

    @deco2()
    def method2(self):
        pass

def methodsWithDecorator(cls, decoratorName):
    sourcelines = inspect.getsourcelines(cls)[0]
    for i,line in enumerate(sourcelines):
        line = line.strip()
        if line.split('(')[0].strip() == '@'+decoratorName: # leaving a bit out
            nextLine = sourcelines[i+1]
            name = nextLine.split('def')[1].split('(')[0].strip()
            yield(name)

有用!:

>>> print(list(  methodsWithDecorator(Test, 'deco')  ))
['method']

请注意,必须注意解析和python语法,例如@deco@deco(...是有效结果,但@deco2如果仅要求则不应返回'deco'。我们注意到,根据http://docs.python.org/reference/compound_stmts.html上的官方python语法,装饰器如下:

decorator      ::=  "@" dotted_name ["(" [argument_list [","]] ")"] NEWLINE

不必处理诸如此类的案件,我们松了一口气@(deco)。但请注意,这仍然没有真正帮助你,如果你真的很复杂的装饰,例如@getDecorator(...),如

def getDecorator():
    return deco

因此,这种分析代码的“尽力而为”策略无法检测到这种情况。尽管如果您正在使用此方法,那么您真正想要的是定义中该方法顶部的内容,在本例中为getDecorator

根据规范,@foo1.bar2.baz3(...)作为装饰者也是有效的。您可以扩展此方法以进行处理。您也可以<function object ...>花费很多精力来扩展此方法以返回a而不是函数的名称。但是,这种方法是骇人听闻的,而且很糟糕。


方法3:将装饰器转换为“自我意识”

如果您无法控制装饰器定义(这是您想要的另一种解释),那么所有这些问题都会消失,因为您可以控制装饰器的应用方式。因此,您可以通过包装装饰器来修改装饰器,以创建自己的装饰器,并使用装饰器装饰功能。让我再说一遍:您可以创建一个装饰器来装饰您无法控制的装饰器,“启发”它,在我们的例子中,这使其可以像以前那样做,还可以.decorator元数据属性附加到它返回的可调用对象上,让您跟踪“此功能是否经过装饰?让我们检查function.decorator!”。您可以遍历类的方法,然后检查装饰器是否具有适当的.decorator属性!=)如此处所示:

def makeRegisteringDecorator(foreignDecorator):
    """
        Returns a copy of foreignDecorator, which is identical in every
        way(*), except also appends a .decorator property to the callable it
        spits out.
    """
    def newDecorator(func):
        # Call to newDecorator(method)
        # Exactly like old decorator, but output keeps track of what decorated it
        R = foreignDecorator(func) # apply foreignDecorator, like call to foreignDecorator(method) would have done
        R.decorator = newDecorator # keep track of decorator
        #R.original = func         # might as well keep track of everything!
        return R

    newDecorator.__name__ = foreignDecorator.__name__
    newDecorator.__doc__ = foreignDecorator.__doc__
    # (*)We can be somewhat "hygienic", but newDecorator still isn't signature-preserving, i.e. you will not be able to get a runtime list of parameters. For that, you need hackish libraries...but in this case, the only argument is func, so it's not a big issue

    return newDecorator

示范@decorator

deco = makeRegisteringDecorator(deco)

class Test2(object):
    @deco
    def method(self):
        pass

    @deco2()
    def method2(self):
        pass

def methodsWithDecorator(cls, decorator):
    """ 
        Returns all methods in CLS with DECORATOR as the
        outermost decorator.

        DECORATOR must be a "registering decorator"; one
        can make any decorator "registering" via the
        makeRegisteringDecorator function.
    """
    for maybeDecorated in cls.__dict__.values():
        if hasattr(maybeDecorated, 'decorator'):
            if maybeDecorated.decorator == decorator:
                print(maybeDecorated)
                yield maybeDecorated

有用!:

>>> print(list(   methodsWithDecorator(Test2, deco)   ))
[<function method at 0x7d62f8>]

但是,“注册装饰器”必须是最外面的装饰器,否则.decorator属性注释将丢失。例如在火车上

@decoOutermost
@deco
@decoInnermost
def func(): ...

您只能看到decoOutermost公开的元数据,除非我们保留对“更内部”包装器的引用。

旁注:以上方法还可以构建一个.decorator,以跟踪整个已应用装饰器和输入函数以及装饰器工厂参数的堆栈。=)例如,如果考虑注释掉的行R.original = func,则使用这样的方法来跟踪所有包装层是可行的。如果我编写装饰器库,这是我个人要做的事情,因为它允许深入的自省。

@foo和之间也有区别@bar(...)。虽然它们都是规范中定义的“装饰器表达”,但请注意,这foo是一个装饰器,同时会bar(...)返回动态创建的装饰器,然后将其应用。因此,您需要一个单独的函数makeRegisteringDecoratorFactory,该函数有点像,makeRegisteringDecorator但甚至需要更多信息:

def makeRegisteringDecoratorFactory(foreignDecoratorFactory):
    def newDecoratorFactory(*args, **kw):
        oldGeneratedDecorator = foreignDecoratorFactory(*args, **kw)
        def newGeneratedDecorator(func):
            modifiedFunc = oldGeneratedDecorator(func)
            modifiedFunc.decorator = newDecoratorFactory # keep track of decorator
            return modifiedFunc
        return newGeneratedDecorator
    newDecoratorFactory.__name__ = foreignDecoratorFactory.__name__
    newDecoratorFactory.__doc__ = foreignDecoratorFactory.__doc__
    return newDecoratorFactory

示范@decorator(...)

def deco2():
    def simpleDeco(func):
        return func
    return simpleDeco

deco2 = makeRegisteringDecoratorFactory(deco2)

print(deco2.__name__)
# RESULT: 'deco2'

@deco2()
def f():
    pass

此生成器工厂包装器也可以工作:

>>> print(f.decorator)
<function deco2 at 0x6a6408>

奖金,让我们甚至尝试方法#3如下:

def getDecorator(): # let's do some dispatching!
    return deco

class Test3(object):
    @getDecorator()
    def method(self):
        pass

    @deco2()
    def method2(self):
        pass

结果:

>>> print(list(   methodsWithDecorator(Test3, deco)   ))
[<function method at 0x7d62f8>]

如您所见,与method2不同,@ deco可以正确识别,即使它从未在类中明确编写。与method2不同,如果方法是在运行时添加(手动,通过元类等)或继承的,则此方法也将起作用。

请注意,您还可以装饰一个类,因此,如果您“启发”用于装饰方法和类的装饰器,然后在要分析的类的主体内编写一个类,methodsWithDecorator则将装饰后的类返回为以及装饰方法。可以认为这是一项功能,但是您可以通过检查装饰器的参数来轻松编写逻辑以忽略那些逻辑,即.original实现所需的语义。


1
对于非显而易见的解决方案,这是一个很好的答案,我为此悬赏了。抱歉,我没有足够的代表给您更多!
尼尔·道格拉斯

1
@NiallDouglas:谢谢。=)(我不知道要多少编辑之后,答案会自动转换为“ community-wiki”,所以我没有得到大多数支持的代表……所以谢谢!)
ninjagecko

嗯,当原始装饰器是一个属性(或一个属性的修改形式)时,这似乎不起作用?有任何想法吗?
StevenMurray '16

14

要扩展方法2:源代码解析中@ninjagecko的出色答案,您可以使用astPython 2.6中引入的模块执行自检,只要inspect模块可以访问源代码即可。

def findDecorators(target):
    import ast, inspect
    res = {}
    def visit_FunctionDef(node):
        res[node.name] = [ast.dump(e) for e in node.decorator_list]

    V = ast.NodeVisitor()
    V.visit_FunctionDef = visit_FunctionDef
    V.visit(compile(inspect.getsource(target), '?', 'exec', ast.PyCF_ONLY_AST))
    return res

我添加了一个稍微复杂的装饰方法:

@x.y.decorator2
def method_d(self, t=5): pass

结果:

> findDecorators(A)
{'method_a': [],
 'method_b': ["Name(id='decorator1', ctx=Load())"],
 'method_c': ["Name(id='decorator2', ctx=Load())"],
 'method_d': ["Attribute(value=Attribute(value=Name(id='x', ctx=Load()), attr='y', ctx=Load()), attr='decorator2', ctx=Load())"]}

1
很好,正确地进行了源解析,并带有适当的警告。=)如果他们决定改进或纠​​正python语法,则这将是向前兼容的(例如,通过取消对decorator-expression的表达式限制,这似乎是一种疏忽)。
ninjagecko 2012年

@ninjagecko我很高兴我不是唯一遇到装饰表达限制的人!当我在一个方法中绑定一个装饰函数闭包时,我经常会遇到它。变成一个愚蠢的两步,将其绑定到变量...
Shane Holloway


0

也许,如果装饰器不是太复杂(但我不知道是否有一种更简单的方法)。

def decorator1(f):
    def new_f():
        print "Entering decorator1", f.__name__
        f()
    new_f.__name__ = f.__name__
    return new_f

def decorator2(f):
    def new_f():
        print "Entering decorator2", f.__name__
        f()
    new_f.__name__ = f.__name__
    return new_f


class A():
    def method_a(self):
      pass

    @decorator1
    def method_b(self, b):
      pass

    @decorator2
    def method_c(self, t=5):
      pass

print A.method_a.im_func.func_code.co_firstlineno
print A.method_b.im_func.func_code.co_firstlineno
print A.method_c.im_func.func_code.co_firstlineno

不幸的是,这仅返回以下各行的行号:(def new_f():第一行,第4行),def new_f():(第二行,第11行)和def method_a(self):。您将很难找到所需的实际行,除非您有约定始终通过将新函数定义为第一行来编写装饰器,而且您不得编写任何文档字符串……尽管您可以避免不必这样做通过具有一种检查缩进的方法来编写文档字符串,当缩进一行一行地查找真正的装饰器的名称时,该方法就会进行检查。
ninjagecko 2011年

即使进行了修改,如果定义的函数不在装饰器中,这也将无法正常工作。装饰器也可以是可调用对象也是这种情况,因此此方法甚至可能引发异常。
ninjagecko 2011年

“ ...如果装饰器不太复杂...”-如果两个装饰方法的行号相同,则它们的装饰可能相同。大概。(好,也应该检查co_filename)。

0

解决此问题的一种简单方法是将代码放入装饰器中,该装饰器将传入的每个函数/方法添加到数据集(例如列表)中。

例如

def deco(foo):
    functions.append(foo)
    return foo

现在,带有装饰装饰器的每个功能都将添加到功能中


0

我不想添加太多,只是ninjagecko的方法2的简单变体。

相同的代码,但是使用列表推导而不是生成器,这是我需要的。

def methodsWithDecorator(cls, decoratorName):

    sourcelines = inspect.getsourcelines(cls)[0]
    return [ sourcelines[i+1].split('def')[1].split('(')[0].strip()
                    for i, line in enumerate(sourcelines)
                    if line.split('(')[0].strip() == '@'+decoratorName]

0

如果您确实可以控制装饰器,则可以使用装饰器类而不是函数:

class awesome(object):
    def __init__(self, method):
        self._method = method
    def __call__(self, obj, *args, **kwargs):
        return self._method(obj, *args, **kwargs)
    @classmethod
    def methods(cls, subject):
        def g():
            for name in dir(subject):
                method = getattr(subject, name)
                if isinstance(method, awesome):
                    yield name, method
        return {name: method for name,method in g()}

class Robot(object):
   @awesome
   def think(self):
      return 0

   @awesome
   def walk(self):
      return 0

   def irritate(self, other):
      return 0

如果我叫它awesome.methods(Robot)返回

{'think': <mymodule.awesome object at 0x000000000782EAC8>, 'walk': <mymodulel.awesome object at 0x000000000782EB00>}
By using our site, you acknowledge that you have read and understand our Cookie Policy and Privacy Policy.
Licensed under cc by-sa 3.0 with attribution required.