Decorator activated via a scan which treats the function being decorated as an event subscriber for the set of interfaces passed as
*ifacesto the decorator constructor.
from pyramid.events import NewRequest from pyramid.events import subscriber @subscriber(NewRequest) def mysubscriber(event): event.request.foo = 1
More than one event type can be passed as a construtor argument. The decorated subscriber will be called for each event type.
from pyramid.events import NewRequest, NewResponse from pyramid.events import subscriber @subscriber(NewRequest, NewResponse) def mysubscriber(event): print event
subscriberdecorator is used without passing an arguments, the function it decorates is called for every event sent:
from pyramid.events import subscriber @subscriber() def mysubscriber(event): print event
This method will have no effect until a scan is performed against the package or module which contains it, ala:
from pyramid.config import Configurator config = Configurator() config.scan('somepackage_containing_subscribers')
An instance of this class is emitted as an event when the
pyramid.config.Configurator.make_wsgi_app()is called. The instance has an attribute,
app, which is an instance of the router that will handle WSGI requests. This class implements the
For backwards compatibility purposes, this class can also be imported as
pyramid.events.WSGIApplicationCreatedEvent. This was the name of the event class before Pyramid 1.0.
An instance of this class is emitted as an event whenever Pyramid begins to process a new request. The even instance has an attribute,
request, which is a request object. This event class implements the
An instance of this class is emitted as an event after the Pyramid router finds a context object (after it performs traversal) but before any view code is executed. The instance has an attribute,
request, which is the request object generated by Pyramid.
Notably, the request object will have an attribute named
context, which is the context that will be provided to the view which will eventually be called, as well as other attributes attached by context-finding code.
This class implements the
As of Pyramid 1.0, for backwards compatibility purposes, this event may also be imported as
The instance has two attributes:
request, which is the request which caused the response, and
response, which is the response object returned by a view or renderer.
responsewas generated by an exception view, the request will have an attribute named
exception, which is the exception object which caused the exception view to be executed. If the response was generated by a ‘normal’ view, the request will not have this attribute.
This event will not be generated if a response cannot be created due to an exception that is not caught by an exception view (no response is created under this circumstace).
This class implements the
Return the value for key
kfrom the renderer globals dictionary, or the default if no such value exists.
Return the existing value for
namein the renderers globals dictionary. If no value with
nameexists in the dictionary, set the
defaultvalue into the renderer globals dictionary under the name passed. If a value already existed in the dictionary, return it. If a value did not exist in the dictionary, return the default
Update the renderer globals dictionary with another dictionary
See Using Events for more information about how to register code which subscribes to these events.