summaryrefslogtreecommitdiff
path: root/docs/narr/hooks.rst
diff options
context:
space:
mode:
authorIan Joseph Wilson <ianjosephwilson@gmail.com>2012-06-17 10:34:48 -0700
committerIan Joseph Wilson <ianjosephwilson@gmail.com>2012-06-17 10:34:48 -0700
commit2e1d2009f3abe8163e9e2adc5ff5c0bbeb1b4630 (patch)
tree48244d0278a25f145e9d5e0f00703836a0492059 /docs/narr/hooks.rst
parentcf46a12292cf15303d68d27c6ba4155ecc2b4586 (diff)
parent3da92290bfaa8b4072019c916e75cd96ebc0f6dc (diff)
downloadpyramid-2e1d2009f3abe8163e9e2adc5ff5c0bbeb1b4630.tar.gz
pyramid-2e1d2009f3abe8163e9e2adc5ff5c0bbeb1b4630.tar.bz2
pyramid-2e1d2009f3abe8163e9e2adc5ff5c0bbeb1b4630.zip
Merge branch 'master' of https://github.com/Pylons/pyramid
Diffstat (limited to 'docs/narr/hooks.rst')
-rw-r--r--docs/narr/hooks.rst30
1 files changed, 30 insertions, 0 deletions
diff --git a/docs/narr/hooks.rst b/docs/narr/hooks.rst
index a2143b3c5..332805152 100644
--- a/docs/narr/hooks.rst
+++ b/docs/narr/hooks.rst
@@ -289,6 +289,36 @@ keys added to the renderer globals dictionary by all
:class:`pyramid.events.BeforeRender` subscribers and renderer globals
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.
+
+Suppose you return ``{'mykey': 'somevalue', 'mykey2': 'somevalue2'}`` from
+your view callable, like so:
+
+.. code-block:: python
+ :linenos:
+
+ from pyramid.view import view_config
+
+ @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`.