summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorJeff Cook <jeff@deserettechnology.com>2012-06-17 01:20:37 -0600
committerJeff Cook <jeff@deserettechnology.com>2012-06-17 01:20:37 -0600
commit2516df30d73afdf6606ad3d89b7c24ab496f356d (patch)
tree673992988e89ef2e1de390c3a356dbdf39bdfc78 /docs
parenta319249fdb6e0539e65e0b297829ed8c7f799b98 (diff)
downloadpyramid-2516df30d73afdf6606ad3d89b7c24ab496f356d.tar.gz
pyramid-2516df30d73afdf6606ad3d89b7c24ab496f356d.tar.bz2
pyramid-2516df30d73afdf6606ad3d89b7c24ab496f356d.zip
docs: Add view callable example to section on rendering_val.
Diffstat (limited to 'docs')
-rw-r--r--docs/narr/hooks.rst31
1 files changed, 23 insertions, 8 deletions
diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst
index 30eec04f0..332805152 100644
--- a/docs/narr/hooks.rst
+++ b/docs/narr/hooks.rst
@@ -291,18 +291,33 @@ factories must be unique.
The dictionary returned from the view is accessible through the
:attr:`rendering_val` attribute of a :class:`~pyramid.events.BeforeRender`
-event, like so:
+event.
+
+Suppose you return ``{'mykey': 'somevalue', 'mykey2': 'somevalue2'}`` from
+your view callable, like so:
.. code-block:: python
- :linenos:
+ :linenos:
- from pyramid.events import subscriber
- from pyramid.events import BeforeRender
+ from pyramid.view import view_config
- @subscriber(BeforeRender)
- def read_return(event):
- # 'mykey' is returned from the view
- print(event.rendering_val['mykey'])
+ @view_config(renderer='some_renderer')
+ def myview(request):
+ return {'mykey': 'somevalue', 'mykey2': 'somevalue2'}
+
+:attr:`rendering_val` can be used to access these values from the
+:class:`~pyramid.events.BeforeRender` object:
+
+.. code-block:: python
+ :linenos:
+
+ from pyramid.events import subscriber
+ from pyramid.events import BeforeRender
+
+ @subscriber(BeforeRender)
+ def read_return(event):
+ # {'mykey': 'somevalue'} is returned from the view
+ print(event.rendering_val['mykey'])
See the API documentation for the :class:`~pyramid.events.BeforeRender` event
interface at :class:`pyramid.interfaces.IBeforeRender`.