diff options
| author | Chris McDonough <chrism@agendaless.com> | 2010-09-12 12:45:07 +0000 |
|---|---|---|
| committer | Chris McDonough <chrism@agendaless.com> | 2010-09-12 12:45:07 +0000 |
| commit | 8f45bee662176e1b2a850a4a9fe25d26b03093a6 (patch) | |
| tree | 852a99ba184e1c1b24fb09197df2801372200541 /docs | |
| parent | 887a0c78919e6c3d1acfe1f9cc16a3aaf054a514 (diff) | |
| download | pyramid-8f45bee662176e1b2a850a4a9fe25d26b03093a6.tar.gz pyramid-8f45bee662176e1b2a850a4a9fe25d26b03093a6.tar.bz2 pyramid-8f45bee662176e1b2a850a4a9fe25d26b03093a6.zip | |
- The BFG router now emits an additional event unconditionally at the
end of request processing:
``repoze.bfg.interfaces.IFinishedRequest``. This event is meant to
be used when it is necessary to perform unconditional cleanup after
request processing. See the ``repoze.bfg.events.FinishedRequest``
class documentation for more information.
- The ``repoze.bfg.interfaces.IWSGIApplicationCreatedEvent`` event
interface was renamed to
``repoze.bfg.interfaces.IApplicationCreated``. Likewise, the
``repoze.bfg.events.WSGIApplicationCreatedEvent`` class was renamed
to ``repoze.bfg.events.ApplicationCreated``. The older aliases will
continue to work indefinitely.
- The ``repoze.bfg.interfaces.IAfterTraversal`` event interface was
renamed to ``repoze.bfg.interfaces.IContextFound``. Likewise, the
``repoze.bfg.events.AfterTraveral`` class was renamed to
``repoze.bfg.events.ContextFound``. The older aliases will continue
to work indefinitely.
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/api/events.rst | 8 | ||||
| -rw-r--r-- | docs/api/interfaces.rst | 6 | ||||
| -rw-r--r-- | docs/narr/router.rst | 2 | ||||
| -rw-r--r-- | docs/narr/startup.rst | 4 |
4 files changed, 13 insertions, 7 deletions
diff --git a/docs/api/events.rst b/docs/api/events.rst index cad199be3..53fdeda86 100644 --- a/docs/api/events.rst +++ b/docs/api/events.rst @@ -10,14 +10,20 @@ Functions .. autofunction:: subscriber +.. _event_types: + Event Types ~~~~~~~~~~~ +.. autoclass:: ApplicationCreated + .. autoclass:: NewRequest +.. autoclass:: ContextFound + .. autoclass:: NewResponse -.. autoclass:: WSGIApplicationCreatedEvent +.. autoclass:: FinishedRequest See :ref:`events_chapter` for more information about how to register code which subscribes to these events. diff --git a/docs/api/interfaces.rst b/docs/api/interfaces.rst index bda636940..974ab2ae9 100644 --- a/docs/api/interfaces.rst +++ b/docs/api/interfaces.rst @@ -8,13 +8,13 @@ Event-Related Interfaces ++++++++++++++++++++++++ - .. autointerface:: IAfterTraversal + .. autointerface:: IApplicationCreated .. autointerface:: INewRequest - .. autointerface:: INewResponse + .. autointerface:: IContextFound - .. autointerface:: IWSGIApplicationCreatedEvent + .. autointerface:: INewResponse Other Interfaces ++++++++++++++++ diff --git a/docs/narr/router.rst b/docs/narr/router.rst index 025d70157..af8f057b0 100644 --- a/docs/narr/router.rst +++ b/docs/narr/router.rst @@ -67,7 +67,7 @@ processing? they can be accessed via e.g. ``request.context`` within :term:`view` code. -#. A :class:`repoze.bfg.interfaces.IAfterTraversal` :term:`event` is +#. A :class:`repoze.bfg.interfaces.IContextFound` :term:`event` is sent to any subscribers. #. :mod:`repoze.bfg` looks up a :term:`view` callable using the diff --git a/docs/narr/startup.rst b/docs/narr/startup.rst index c3850fb4e..5b4365229 100644 --- a/docs/narr/startup.rst +++ b/docs/narr/startup.rst @@ -127,8 +127,8 @@ press ``return`` after running ``paster serve MyProject.ini``. by the configurator previously populated by ZCML. The router is a WSGI application. -#. A :class:`repoze.bfg.interfaces.WSGIApplicationCreatedEvent` event - is emitted (see :ref:`events_chapter` for more information about +#. A :class:`repoze.bfg.interfaces.IApplicationCreated` event is + emitted (see :ref:`events_chapter` for more information about events). #. Assuming there were no errors, the ``app`` function in |