Python装饰器和类继承

Question

我正在尝试使用装饰器来管理用户可能访问或不访问Web应用程序(在Google App Engine上运行)中的资源的方式.请注意,我不允许用户使用其Google帐户登录,因此无法在app.yaml中设置特定路径的特定访问权限.

我使用了以下资源:
- Bruce Eckel的装饰器指南
- SO:get-class-in-python-decorator2
- SO:python-decorators-and-inheritance
- SO:get-class-in-python-decorator

不过我还是有点困惑......

这是我的代码!在以下示例中,current_user是属于RequestHandler类的@property方法.它返回存储在数据存储区中的User(db.model)对象,其级别为IntProperty().

class FoobarController(RequestHandler):

    # Access decorator
    def requiredLevel(required_level):
        def wrap(func):
            def f(self, *args):
                if self.current_user.level >= required_level:
                    func(self, *args)
                else:
                    raise Exception('Insufficient level to access this resource') 
            return f
        return wrap

    @requiredLevel(100)
    def get(self, someparameters):
        #do stuff here...

    @requiredLevel(200)
    def post(self):
        #do something else here...

但是,我的应用程序对不同类型的资源使用不同的控制器.为了在所有子类中使用@requiredLevel装饰器,我需要将它移动到父类(RequestHandler):

class RequestHandler(webapp.RequestHandler):

    #Access decorator
    def requiredLevel(required_level):
        #See code above

我的想法是使用以下代码访问所有控制器子类中的装饰器:

class FoobarController(RequestHandler):

    @RequestHandler.requiredLevel(100)
    def get(self):
        #do stuff here...

我想我刚刚达到了关于装饰器和类继承的知识限制:).有什么想法吗 ？

Answer 1

您的原始代码经过两个小调整也应该可以工作。对于这样一个简单的装饰器来说，基于类的方法似乎相当重量级：

class RequestHandler(webapp.RequestHandler):

    # The decorator is now a class method.
    @classmethod     # Note the 'klass' argument, similar to 'self' on an instance method
    def requiredLevel(klass, required_level):
        def wrap(func):
            def f(self, *args):
                if self.current_user.level >= required_level:
                    func(self, *args)
                else:
                    raise Exception('Insufficient level to access this resource') 
            return f
        return wrap


class FoobarController(RequestHandler):
    @RequestHandler.requiredLevel(100)
    def get(self, someparameters):
        #do stuff here...

    @RequestHandler.requiredLevel(200)
    def post(self):
        #do something else here...

或者，您可以使用@staticmethod：

class RequestHandler(webapp.RequestHandler):

    # The decorator is now a static method.
    @staticmethod     # No default argument required...
    def requiredLevel(required_level):

原始代码不起作用的原因是 requiredLevel 被假定为一个实例方法，该方法在类声明时（当您装饰其他方法时）不可用，也不会从类对象（将装饰器放在 RequestHandler 基类上是一个好主意，并且生成的装饰器调用可以很好地自我记录）。

您可能有兴趣阅读有关@classmethod和 的文档@staticmethod。

另外，我喜欢在装饰器中放入一些样板：

    @staticmethod
    def requiredLevel(required_level):
        def wrap(func):
            def f(self, *args):
                if self.current_user.level >= required_level:
                    func(self, *args)
                else:
                    raise Exception('Insufficient level to access this resource') 
            # This will maintain the function name and documentation of the wrapped function.
            # Very helpful when debugging or checking the docs from the python shell:
            wrap.__doc__ = f.__doc__
            wrap.__name__ = f.__name__
            return f
        return wrap