使用与函数和方法相同的装饰器(带参数)

时间:2009-08-17 15:08:12

标签: python function methods arguments decorator

我一直在尝试创建一个可以在python中与函数和方法一起使用的装饰器。它本身就不那么难,但是当创建一个带参数的装饰器时,似乎就是这样。

class methods(object):
    def __init__(self, *_methods):
        self.methods = _methods

    def __call__(self, func): 
        def inner(request, *args, **kwargs):
            print request
            return func(request, *args, **kwargs)
        return inner

    def __get__(self, obj, type=None):
        if obj is None:
            return self
        new_func = self.func.__get__(obj, type)
        return self.__class__(new_func)

上面的代码正确地包装了函数/方法,但是在方法的情况下,request参数是它正在操作的实例,而不是第一个非自参数。

有没有办法判断装饰器是否应用于函数而不是方法,并相应处理?

5 个答案:

答案 0 :(得分:16)

扩展__get__方法。这可以推广到装饰器装饰器中。

class _MethodDecoratorAdaptor(object):
    def __init__(self, decorator, func):
        self.decorator = decorator
        self.func = func
    def __call__(self, *args, **kwargs):
        return self.decorator(self.func)(*args, **kwargs)
    def __get__(self, instance, owner):
        return self.decorator(self.func.__get__(instance, owner))

def auto_adapt_to_methods(decorator):
    """Allows you to use the same decorator on methods and functions,
    hiding the self argument from the decorator."""
    def adapt(func):
        return _MethodDecoratorAdaptor(decorator, func)
    return adapt

通过这种方式,您可以让装饰者自动适应其使用的条件。

def allowed(*allowed_methods):
    @auto_adapt_to_methods
    def wrapper(func):
        def wrapped(request):
            if request not in allowed_methods:
                raise ValueError("Invalid method %s" % request)
            return func(request)
        return wrapped
    return wrapper

请注意,所有函数调用都会调用包装函数,所以不要在那里做任何昂贵的事情。

装饰器的用法:

class Foo(object):
    @allowed('GET', 'POST')
    def do(self, request):
        print "Request %s on %s" % (request, self)

@allowed('GET')
def do(request):
    print "Plain request %s" % request

Foo().do('GET')  # Works
Foo().do('POST') # Raises

答案 1 :(得分:5)

装饰器总是应用于一个函数对象 - 让装饰器print成为其参数的类型,你将能够确认它;它通常应该返回一个函数对象(它已经是一个具有正确的__get__! - 的装饰器),尽管后者有例外。

即,在代码中:

class X(object):

  @deco
  def f(self): pass
在类体中调用

deco(f),当你还在那里时,f是一个函数,而不是方法类型的实例。 (当f作为__get__或其实例的属性访问f后,该方法在X的{​​{1}}中生成并返回。

也许你可以更好地解释你想要装饰的玩具,所以我们可以提供更多帮助......?

编辑:这也适用于带有参数的装饰者,即

class X(object):

  @deco(23)
  def f(self): pass

然后它是deco(23)(f)在类体中被调用,f在作为参数传递给任何可调用的deco(23)返回时仍然是一个函数对象,并且该可调用仍然应该返回一个函数对象(通常 - 有例外; - )。

答案 2 :(得分:4)

由于你已经定义了__get__在绑定方法上使用装饰器,你可以传递一个标志,告诉它是否在方法或函数上使用。

class methods(object):
    def __init__(self, *_methods, called_on_method=False):
        self.methods = _methods
        self.called_on_method

    def __call__(self, func):
        if self.called_on_method:
            def inner(self, request, *args, **kwargs):
                print request
                return func(request, *args, **kwargs)
        else:
            def inner(request, *args, **kwargs):
                print request
                return func(request, *args, **kwargs)
        return inner

    def __get__(self, obj, type=None):
        if obj is None:
            return self
        new_func = self.func.__get__(obj, type)
        return self.__class__(new_func, called_on_method=True)

答案 3 :(得分:1)

我提出的部分(特定)解决方案依赖于异常处理。我试图创建一个装饰器,只允许某些HttpRequest方法,但使它适用于视图和视图方法。

所以,这个课将做我想做的事:

class methods(object):
    def __init__(self, *_methods):
        self.methods = _methods

    def __call__(self, func): 
        @wraps(func)
        def inner(*args, **kwargs):
            try:
                if args[0].method in self.methods:
                    return func(*args, **kwargs)
            except AttributeError:
                if args[1].method in self.methods:
                    return func(*args, **kwargs)
            return HttpResponseMethodNotAllowed(self.methods)
        return inner

以下是两个用例:装饰函数:

@methods("GET")
def view_func(request, *args, **kwargs):
    pass

和一个类的装饰方法:

class ViewContainer(object):
    # ...

    @methods("GET", "PUT")
    def object(self, request, pk, *args, **kwargs):
        # stuff that needs a reference to self...
        pass

有没有比使用异常处理更好的解决方案?

答案 4 :(得分:0)

这是我发现检测装饰的可调用函数是函数还是方法的一般方法:

import functools

class decorator(object):

  def __init__(self, func):
    self._func = func
    self._obj = None
    self._wrapped = None

  def __call__(self, *args, **kwargs):
    if not self._wrapped:
      if self._obj:
        self._wrapped = self._wrap_method(self._func)
        self._wrapped = functools.partial(self._wrapped, self._obj)
      else:
        self._wrapped = self._wrap_function(self._func)
    return self._wrapped(*args, **kwargs)

  def __get__(self, obj, type=None):
    self._obj = obj
    return self

  def _wrap_method(self, method):
    @functools.wraps(method)
    def inner(self, *args, **kwargs):
      print('Method called on {}:'.format(type(self).__name__))
      return method(self, *args, **kwargs)
    return inner

  def _wrap_function(self, function):
    @functools.wraps(function)
    def inner(*args, **kwargs):
      print('Function called:')
      return function(*args, **kwargs)
    return inner

使用示例:

class Foo(object):
  @decorator
  def foo(self, foo, bar):
    print(foo, bar)

@decorator
def foo(foo, bar):
  print(foo, bar)

foo(12, bar=42)      # Function called: 12 42
foo(12, 42)          # Function called: 12 42
obj = Foo()
obj.foo(12, bar=42)  # Method called on Foo: 12 42
obj.foo(12, 42)      # Method called on Foo: 12 42