Release 0.8. Repoze Developers

Transcription

1 pyramid b eakerdocumentation Release 0.8 Repoze Developers July 04, 2015

2

3 Contents 1 Overview 1 2 Installation 3 3 Setup 5 4 Usage Session management Beaker cache region support API API Documentation Indices and tables Glossary Python Module Index 15 i

4 ii

5 CHAPTER 1 Overview A Beaker session factory backend for Pyramid, also cache configurator. 1

6 pyramid b eakerdocumentation, Release0.8 2 Chapter 1. Overview

7 CHAPTER 2 Installation Install using setuptools, e.g. (within a virtualenv): $ easy_install pyramid_beaker 3

8 pyramid b eakerdocumentation, Release0.8 4 Chapter 2. Installation

9 CHAPTER 3 Setup Once pyramid_beaker is installed, you typically use the config.include mechanism to include it into your Pyramid project s configuration. In your Pyramid project s init.py: config = Configurator(...) config.include('pyramid_beaker') Alternately, instead of using the Configurator s include method, you can activate pyramid_beaker by changing your application s.ini file, use the following line: pyramid.includes = pyramid_beaker 5

10 pyramid b eakerdocumentation, Release0.8 6 Chapter 3. Setup

11 CHAPTER 4 Usage 4.1 Session management If you have included pyramid_beaker in your Pyramid project s configuration as shown above then pyramid_beaker.session_factory_from_settings() is called automatically and you need do nothing else. Otherwise you will need to create a Pyramid session factory by adding a call to either the pyramid_beaker.beakersessionfactoryconfig() function or the pyramid_beaker.session_factory_from_settings() function in the configuration code of your Pyramid project s init.py file and subsequently register that session factory with Pyramid. At that point, accessing request.session will provide a Pyramid session using Beaker as a backend. pyramid_beaker.session_factory_from_settings() obtains session settings from the **settings dictionary passed to the Configurator. It assumes that you ve placed session configuration parameters prefixed with session. in your Pyramid application s.ini file. For example: [app:myapp].. other settings.. session.type = file session.data_dir = %(here)s/data/sessions/data session.lock_dir = %(here)s/data/sessions/lock session.key = mykey session.secret = mysecret session.cookie_on_exception = true If your.ini file has such settings, you can use pyramid_beaker.session_factory_from_settings() in your application s configuration. For example, let s assume this code is in the init.py of your Pyramid application that uses an.ini file with the session. settings above to obtain its **settings dictionary. from pyramid_beaker import session_factory_from_settings from pyramid.config import Configurator def app(global_config, **settings): """ This function returns a WSGI application. It is usually called by the PasteDeploy framework during ``paster serve``. """ session_factory = session_factory_from_settings(settings) config = Configurator(root_factory=get_root, settings=settings) config.set_session_factory(session_factory) #... other configuration stuff... return config.make_wsgi_app() 7

12 pyramid b eakerdocumentation, Release0.8 The cookie_on_exception option is specific to pyramid_beaker (as opposed to all other options, which are specific to Beaker itself). It indicates that the session cookie should be set even when a Pyramid exception view is being rendered. The default is True, meaning that session cookies will be sent back in responses generated by exception views. Additionally, the constant_csrf_token option can be set to override the CSRF token value with some constant value. This is useful for testing but should not be set in production. 4.2 Beaker cache region support In the configuration portion of your Pyramid app, if you are not using the default activation setup, use the pyramid_beaker.set_cache_regions_from_settings() function to set Beaker s cache regions. At that point, you can use Beaker s cache_region functionality to enable caching for Your application. pyramid_beaker.set_cache_regions_from_settings() obtains region settings from the **settings dictionary passed to the Configurator. It assumes that you ve placed cache configuration parameters prefixed with cache. in your Pyramid application s.ini file. For example: [app:myapp].. other settings.. cache.regions = default_term, second, short_term, long_term cache.type = memory cache.second.expire = 1 cache.short_term.expire = 60 cache.default_term.expire = 300 cache.long_term.expire = 3600 If your.ini file has such settings, you can use pyramid_beaker.set_cache_regions_from_settings() in your application s configuration. For example, let s assume this code is in the init.py of your Pyramid application that uses an.ini file with the cache. settings above to obtain its **settings dictionary. from pyramid_beaker import set_cache_regions_from_settings from pyramid.configuration import configurator def app(global_config, **settings): """ This function returns a WSGI application. It is usually called by the PasteDeploy framework during ``paster serve``. """ set_cache_regions_from_settings(settings) config = Configurator(root_factory=get_root, settings=settings) #... other configuration stuff... return config.make_wsgi_app() Inherited region settings The following optional region settings inherit from the main cache configuration or default as specified: data_dir Inherits if specified. enabled Inherits or defaults to True. expire Inherits or defaults to 60 seconds. key_length Inherits or defaults to 250 characters. 8 Chapter 4. Usage

13 pyramid b eakerdocumentation, Release0.8 lock_dir Inherits if specified. type Inherits or defaults to memory. url Inherits if specified Beaker cache region support 9

14 pyramid b eakerdocumentation, Release Chapter 4. Usage

15 CHAPTER 5 API 5.1 API Documentation pyramid_beaker.set_cache_regions_from_settings(settings) Add cache support to the Pylons application. The settings passed to the configurator are used to setup the cache options. Cache options in the settings should start with either beaker.cache. or cache.. pyramid_beaker.session_factory_from_settings(settings) Return a Pyramid session factory using Beaker session settings supplied from a Paste configuration file pyramid_beaker.beakersessionfactoryconfig(**options) Return a Pyramid session factory using Beaker session settings supplied directly as **options 11

16 pyramid b eakerdocumentation, Release Chapter 5. API

17 CHAPTER 6 Indices and tables Glossary genindex modindex search 6.1 Glossary Beaker A sessioning and caching package by Ben Bangert. Pyramid A web framework. session factory A callable, which, when called with a single argument named request, returns a session object. 13

18 pyramid b eakerdocumentation, Release Chapter 6. Indices and tables

19 Python Module Index p pyramid_beaker, 11 15

20 pyramid b eakerdocumentation, Release Python Module Index

21 Index B Beaker, 13 BeakerSessionFactoryConfig() (in module pyramid_beaker), 11 P Pyramid, 13 pyramid_beaker (module), 11 S session factory, 13 session_factory_from_settings() (in module pyramid_beaker), 11 set_cache_regions_from_settings() (in module pyramid_beaker), 11 17