用于用户身份验证的 CherryPy 自定义工具

Question

我正在尝试在 CherryPy 控制器类中设置一种简单的装饰方法，以便用户在尚未经过身份验证时被重定向到登录页面。我本来打算做一个基本的Python装饰器，但是这里的答案建议我请改用 CherryPy 自定义工具。所以我正在尝试这样做，但我无法让它发挥作用。这是我所拥有的：

def authenticate():
    user = cherrypy.session.get('user', None)
    if not user:
        raise cherrypy.HTTPRedirect('/?errMsg=Please%20log%20in%20first')

cherrypy.tools.authenticate = cherrypy.Tool('on_start_resource', authenticate)

/home 页面是一个应该仅限于经过身份验证的用户的页面，因此我有以下内容：

@cherrypy.expose
@cherrypy.tools.authenticate
def home(self, **kwargs):
    tmpl = TemplateDir.get_template('home.mako')
    return tmpl.render()

但是，当我尝试启动我的网站时，我收到此错误：

Traceback (most recent call last):
  File ".\example.py", line 3, in <module>
    from controller.main import Root
  File "C:\...\controller\main.py", line 9, in <module>
    class Root(BaseModule):
  File "C:\...\controller\main.py", line 19, in Root
    @cherrypy.tools.authenticate
  File "C:\Python26\lib\site-packages\cherrypy\_cptools.py", line 119, in
   __call__ % self._name)
TypeError: The 'authenticate' Tool does not accept positional arguments; you must
  use keyword arguments.

编辑：好的，如果我将自定义工具的使用更改为带有括号，我会收到不同的错误。

@cherrypy.expose
@cherrypy.tools.authenticate() # Magic parentheses...
def home(self, **kwargs):
    ...

现在我得到：

Traceback (most recent call last):
  File "C:\Python26\lib\site-packages\cherrypy\_cprequest.py", line 625, in respond
    self.hooks.run('on_start_resource')
  File "C:\Python26\lib\site-packages\cherrypy\_cprequest.py", line 97, in run
    hook()
  File "C:\Python26\lib\site-packages\cherrypy\_cprequest.py", line 57, in __call__
    return self.callback(**self.kwargs)
  File ".\example.py", line 40, in authenticate
    user = cherrypy.session.get('user', None)
AttributeError: 'module' object has no attribute 'session'

编辑： 我已打开会话：

cherrypy.tools.sessions.storage_type = 'file'
cherrypy.tools.sessions.storage_path = r'%s\sessions' % curDir
cherrypy.tools.sessions.timeout = 60
cherrypy.tree.mount(Root(), "/", config={
    '/static': {
        'tools.staticdir.on':True,
        'tools.staticdir.dir':r'%s\static' % curDir,
    },
    '/': {
        'tools.sessions.on':True,
    }
})

当我第一次在 Web 方法上使用自定义工具装饰器加载页面时，出现以下错误：

属性错误：“模块”对象没有属性“会话”

然后当我重新加载页面时，出现此错误：

属性错误：“_Serving”对象没有属性“会话”

编辑： 即使在我的控制器类中尝试了这么多，我仍然收到 'module object has no attribute session' 错误：

class Root(BaseModule):
    _cp_config = {'tools.sessions.on': True}
    sess = cherrypy.session # Error here
    ...

Answer 1

我使用了错误的钩子。更改：

cherrypy.tools.authenticate = cherrypy.Tool('on_start_resource', authenticate)

至：

cherrypy.tools.authenticate = cherrypy.Tool('before_handler', authenticate)

解决了问题。显然，我的 authenticate 方法在会话打开之前被调用，因此它无法访问 cherrypy.session。我的控制器中不需要任何会话开启的东西；所需要的只是我的服务器启动脚本中的以下内容：

def authenticate():
    ...
cherrypy.tools.authenticate = cherrypy.Tool('before_handler', authenticate)
cherrypy.tree.mount(Root(), "/", config={
    "/": {
        'tools.sessions.on':True,
        'tools.sessions.storage_type':'file',
        'tools.sessions.storage_path':r'%s\sessions' % curDir,
        'tools.sessions.timeout':60
    }, ...
})

然后，在我的控制器中的受限方法上：

@cherrypy.expose
@cherrypy.tools.authenticate()
def home(self, **kwargs):
    ...

Answer 2

最有可能的是会话未启用。 会话 wiki 页面 上有一个示例配置文件，或者查看 教程#7。