summaryrefslogtreecommitdiff
path: root/docs/narr/events.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/narr/events.rst')
-rw-r--r--docs/narr/events.rst64
1 files changed, 31 insertions, 33 deletions
diff --git a/docs/narr/events.rst b/docs/narr/events.rst
index 06b30883f..929208083 100644
--- a/docs/narr/events.rst
+++ b/docs/narr/events.rst
@@ -38,52 +38,50 @@ you'll need to use the
need to use the :func:`pyramid.events.subscriber` decorator to decorate a
function found via a :term:`scan`.
-.. topic:: Configuring an Event Listener Imperatively
+Configuring an Event Listener Imperatively
+------------------------------------------
- You can imperatively configure a subscriber function to be called
- for some event type via the
- :meth:`pyramid.config.Configurator.add_subscriber`
- method (see also :term:`Configurator`):
+You can imperatively configure a subscriber function to be called
+for some event type via the
+:meth:`~pyramid.config.Configurator.add_subscriber`
+method (see also :term:`Configurator`):
- .. code-block:: python
- :linenos:
-
- from pyramid.events import NewRequest
+.. code-block:: python
+ :linenos:
- from subscribers import mysubscriber
+ from pyramid.events import NewRequest
- # "config" below is assumed to be an instance of a
- # pyramid.config.Configurator object
+ from subscribers import mysubscriber
- config.add_subscriber(mysubscriber, NewRequest)
+ # "config" below is assumed to be an instance of a
+ # pyramid.config.Configurator object
- The first argument to
- :meth:`pyramid.config.Configurator.add_subscriber` is the
- subscriber function (or a :term:`dotted Python name` which refers
- to a subscriber callable); the second argument is the event type.
+ config.add_subscriber(mysubscriber, NewRequest)
-.. topic:: Configuring an Event Listener Using a Decorator
+The first argument to
+:meth:`~pyramid.config.Configurator.add_subscriber` is the
+subscriber function (or a :term:`dotted Python name` which refers
+to a subscriber callable); the second argument is the event type.
- You can configure a subscriber function to be called for some event
- type via the :func:`pyramid.events.subscriber` function.
+Configuring an Event Listener Using a Decorator
+-----------------------------------------------
- .. code-block:: python
- :linenos:
+You can configure a subscriber function to be called for some event
+type via the :func:`pyramid.events.subscriber` function.
- from pyramid.events import NewRequest
- from pyramid.events import subscriber
+.. code-block:: python
+ :linenos:
- @subscriber(NewRequest)
- def mysubscriber(event):
- event.request.foo = 1
+ from pyramid.events import NewRequest
+ from pyramid.events import subscriber
- When the :func:`pyramid.subscriber` decorator is used a
- :term:`scan` must be performed against the package containing the
- decorated function for the decorator to have any effect. See
- :func:`pyramid.subscriber` for more information.
+ @subscriber(NewRequest)
+ def mysubscriber(event):
+ event.request.foo = 1
-.. note:: You can also configure an event listener via ZCML. See
- :ref:`zcml_event_listener`.
+When the :func:`~pyramid.events.subscriber` decorator is used a
+:term:`scan` must be performed against the package containing the
+decorated function for the decorator to have any effect.
Either of the above registration examples implies that every time the
:app:`Pyramid` framework emits an event object that supplies an