Python Pyramid - 会话

会话是指客户端登录服务器到注销服务器之间的时间间隔。会话对象也是一个字典对象，包含会话变量及其关联值的键值对。在 Pyramid 中，它作为请求对象的属性可用。

为了处理会话机制，Pyramid 应用对象必须配置一个会话工厂，该工厂返回会话对象。Pyramid 核心提供了一个基本的会话工厂，它使用 Cookie 来存储会话信息。

默认会话工厂

pyramid.session 模块定义了 SignedCookieSessionFactory 类。它的对象需要一个密钥来对会话 Cookie 信息进行数字签名。

from pyramid.session import SignedCookieSessionFactory
my_session_factory = SignedCookieSessionFactory('abcQWE123!@#')

Configurator 类的 set_session_factory() 方法使用此工厂对象来设置会话。

config.set_session_factory(my_session_factory)

完成此操作后，会话对象现在可用于实现为 request.session 属性。要添加会话变量，请使用：

request.session['user'] = 'Admin'

要检索会话变量，请使用：

user=request.session['user']

要删除会话变量，请使用 pop() 方法。

request.session.pop('user')

会话示例

下面描述了在 Pyramid 应用中使用会话变量的方法。首先，登录路由（与 login() 视图函数相关联）在浏览器上显示登录表单。

@view_config(route_name='login')
def login(request):
   html="""
   <html>
   <body>
      <form action='/add'> Enter User name :
         <input type='text' name='user'>
         <input type='submit' value='submit'>
      </form>
   </body>
   </html>
   """
return Response(html)

add() 函数读取“user”表单属性，并使用其值添加会话变量。

@view_config(route_name='addsession')
def add(request):
   request.session['user']=request.params['user']
   return Response("<h2>Session object added.</h2><br><h3><a href='/read'>click here</a></h3>")

read() 视图读取回会话变量数据并显示欢迎消息。

@view_config(route_name='readsession')
def read(request):
   user=request.session['user']
   response="<h2>Welcome {} </h2>".format(user)+"<br><h3><a href='/logout'>Logout</a></h3>"
   return Response(response)

这些视图以及会话工厂都添加到应用配置中。

config.set_session_factory(my_session_factory)
config.add_route('login','/')
config.add_route('logout','/logout')
config.add_route('addsession', '/add')
config.add_route('readsession', '/read')
config.scan('session')

示例

完整代码如下：

from wsgiref.simple_server import make_server
from pyramid.config import Configurator
from pyramid.response import Response
from pyramid.view import view_config
from pyramid.session import SignedCookieSessionFactory
my_session_factory = SignedCookieSessionFactory('abcQWE123!@#')

@view_config(route_name='login')
def login(request):
   html="""
   <html>
   <body>
   <form action='/add'>
      Enter User name :
      <input type='text' name='user'>
      <input type='submit' value='submit'>
   </form>
   </body>
   </html>
"""
   return Response(html)
@view_config(route_name='addsession')
def add(request):
   request.session['user']=request.params['user']
   return Response("<h2>Session object added.</h2><br><h3><a href='/read'>click here</a></h3>")

@view_config(route_name='readsession')
def read(request):
   user=request.session['user']
   response="<h2>Welcome {} </h2>".format(user)+"<br><h3><a href='/logout'>Logout</a>>/<h3>"
   return Response(response)
   
@view_config(route_name='logout')
def logout(request):
   request.session.pop('user')
   response="<h2>You have been logged out </h2><br><h3><a href='/'>Login</a></h3>"
   return Response(response)
   
if __name__ == '__main__':
   with Configurator() as config:
      config.set_session_factory(my_session_factory)
      config.add_route('login','/')
      config.add_route('logout','/logout')
      config.add_route('addsession', '/add')
      config.add_route('readsession', '/read')
      config.scan('session')
      app = config.make_wsgi_app()
   server = make_server('0.0.0.0', 6543, app)
   server.serve_forever()

将此脚本另存为 Pyramid 虚拟环境文件夹中的子文件夹（称为“session”）中的 main.py。请注意，此子文件夹必须有一个空的 __init__.py 文件才能被视为包。

输出

运行 main.py 并输入 https://:6543/ 以在浏览器中打开登录表单。

输入用户名并按下“提交”按钮。给定的名称将保存为“user”会话变量。

“点击此处”链接读取回 session 变量并显示欢迎消息。

“注销”链接弹出 session 变量并将浏览器带回登录页面。

打印页面