a session is a time interval between client logs into a server and it logs out of it. session object is also a dictionary object containing key-value pairs of session variables and associated values. in pyramid, it is available as an attribute of request object.

in order to handle session mechanism, the pyramid application object must be configured with a session factory that returns the session object. pyramid core provides a basic session factory, which uses cookies to store session information.

default session factory

the pyramid.session module defines signedcookiesessionfactory class. its object needs a secret key for digitally signing the session cookie information.

from pyramid.session import signedcookiesessionfactory
my_session_factory = signedcookiesessionfactory('abcqwe123!@#')

the set_session_factory() method of the configurator class uses this factory object to set up the session.

config.set_session_factory(my_session_factory)

once this is done, the session object is now available for implementation as request.session attribute. to add a session variable, use −

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

to retrieve a session variable, use −

user=request.session['user']

to remove a session variable, use the pop() method.

request.session.pop('user')

session example

described below is the usage of session variable in a pyramid application. first, the login route (associated with login() view function) brings up a login form on the browser.

@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)

the add() function reads the 'user' form attribute and uses its value to add a session variable.

@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>")

the read() view reads back the session variable data and displays a welcome message.

@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)

these views along with the session factory are added in the application configuration.

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')

example

the complete code is given below −

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()

save this script as main.py in a subfolder (called 'session') within the pyramid virtual environment folder. note that this subfolder must have an empty __init__.py file for it to be treated as a package.

output

run main.py and enter http://localhost:6543/ to open up the login form in the browser.

enter the user name and press the "submit" button. the given name is saved as a 'user' session variable.

the 'click here' link reads back the session variable and displays welcome message.

the logout link pops the session variable and takes the browser back to the login page.

Save or share this article