为授权编写 CherryPy 装饰器

Question

我有一个cherrypy 应用程序，在某些视图上我想开始只允许某些用户查看它们，并将其他任何人发送到需要授权的页面。

有没有办法使用自定义装饰器来做到这一点？我认为这将是最优雅的选择。

这是我想做的一个基本示例：

class MyApp:
    @authorization_required
    def view_page1(self,appID):
        ... do some stuff ...
        return html

def authorization_required(func):
    #what do I put here?

在作为装饰器调用时，authorization_required 函数是否也可以接受诸如 allow_group1、allow_group2 之类的参数？还是每个组都需要一个单独的装饰器？

Answer 1

好的，在这种情况下，你的装饰器看起来像这样：

# without any parameters
def authentication_required(f):
    @functools.wraps(f)
    def _authentication_required(*args, **kwargs):
        # Do you login stuff here
        return f(*args, **kwargs)
    return _authentication_required

# With parameters
def authentication_required(*allowed_groups):
    def _authentication_required(f):
        @functools.wraps(f)
        def __authentication_required(*args, **kwargs):
            # Do you login stuff here
            return f(*args, **kwargs)
        return __authentication_required
    return _authentication_required

Answer 2

您真的不想为 CherryPy 编写自定义装饰器。相反，您想编写一个新工具：

def myauth(allowed_groups=None, debug=False):
    # Do your auth here...
    authlib.auth(...)
cherrypy.tools.myauth = cherrypy.Tool("on_start_resource", myauth)

更多讨论请参见http://docs.cherrypy.org/en/latest/extend.html#tools。与编写自定义装饰器相比，这有几个好处：

1. 您可以从工具中免费获得装饰器：@cherrypy.tools.myauth(allowed_groups=['me'])，它已经知道如何在同一函数上不破坏cherrypy.exposed。
2. 您可以为每个处理程序（使用装饰器）、每个控制器树（通过_cp_config）或每个 URI 树（在配置文件或字典中）应用工具。您甚至可以混合它们并通过装饰器提供基本功能，然后在配置文件中覆盖它们的行为。
3. 如果配置文件关闭了您的功能，您无需支付调用装饰器函数来查看它是否关闭的性能损失。
4. 您会记得像所有内置工具一样添加一个“调试”参数。 ;)
5. 通过选择不同的“点”，您的功能可以比自定义装饰器更早（或更晚，如果您需要的话）运行。
6. 如果需要，您的功能可以在多个挂钩点上运行。