pyramid.interfaces

Event-Related Interfaces

interface IApplicationCreated

Event issued when the pyramid.config.Configurator.make_wsgi_app() method is called. See the documentation attached to pyramid.events.ApplicationCreated for more information.

Note

For backwards compatibility with Pyramid versions before 1.0, this interface can also be imported as pyramid.interfaces.IWSGIApplicationCreatedEvent.

interface INewRequest

An event type that is emitted whenever Pyramid begins to process a new request. See the documentation attached to pyramid.events.NewRequest for more information.

interface IContextFound

An event type that is emitted after Pyramid finds a context object but before it calls any view code. See the documentation attached to pyramid.events.ContextFound for more information.

Note

For backwards compatibility with versions of Pyramid before 1.0, this event interface can also be imported as pyramid.interfaces.IAfterTraversal.

interface INewResponse

An event type that is emitted whenever any Pyramid view returns a response. See the documentation attached to pyramid.events.NewResponse for more information.

interface IBeforeRender

Subscribers to this event may introspect the and modify the set of renderer globals before they are passed to a renderer. This event object iself has a dictionary-like interface that can be used for this purpose. For example:

from repoze.events import subscriber
from pyramid.interfaces import IBeforeRender

@subscriber(IBeforeRender)
def add_global(event):
    event['mykey'] = 'foo'

See also Using The Before Render Event.

Other Interfaces

interface IExceptionResponse

Extends: pyramid.interfaces.IException, pyramid.interfaces.IResponse

An interface representing a WSGI response which is also an exception object. Register an exception view using this interface as a context to apply the registered view for all exception types raised by Pyramid internally (pyramid.exceptions.NotFound and pyramid.exceptions.Forbidden).

interface IRoute

Interface representing the type of object returned from IRoutesMapper.get_route

interface IRoutePregenerator

interface ISession

An interface representing a session (a web session object, usually accessed via request.session.

Keys and values of a session must be pickleable.

interface ISessionFactory

An interface representing a factory which accepts a request object and returns an ISession object

interface IRendererInfo

An object implementing this interface is passed to every renderer factory constructor as its only argument (conventionally named info)

interface ITemplateRenderer

Extends: pyramid.interfaces.IRenderer

interface IViewMapperFactory

interface IViewMapper