summaryrefslogtreecommitdiff
path: root/docs/api/renderers.rst
diff options
context:
space:
mode:
authorChris McDonough <chrism@plope.com>2011-07-21 22:02:37 -0400
committerChris McDonough <chrism@plope.com>2011-07-21 22:02:37 -0400
commitaa2fe1b0a02ba4edde4d285ec0a5a6ec545b7fec (patch)
tree72511de87df7b6369a073434e1fe2c38c1624a13 /docs/api/renderers.rst
parent73c0aee5571bbdd7273033eda3a798d5597a76af (diff)
downloadpyramid-aa2fe1b0a02ba4edde4d285ec0a5a6ec545b7fec.tar.gz
pyramid-aa2fe1b0a02ba4edde4d285ec0a5a6ec545b7fec.tar.bz2
pyramid-aa2fe1b0a02ba4edde4d285ec0a5a6ec545b7fec.zip
- Added the ``pyramid.renderers.null_renderer`` object as an API. The null
renderer is an object that can be used in advanced integration cases as input to the view configuration ``renderer=`` argument. When the null renderer is used as a view renderer argument, Pyramid avoids converting the view callable result into a Response object. This is useful if you want to reuse the view configuration and lookup machinery outside the context of its use by the Pyramid router. This feature was added for consumption by the ``pyramid_rpc`` package, which uses view configuration and lookup outside the context of a router in exactly this way. ``pyramid_rpc`` has been broken under 1.1 since 1.1b1; adding it allows us to make it work again.
Diffstat (limited to 'docs/api/renderers.rst')
-rw-r--r--docs/api/renderers.rst9
1 files changed, 9 insertions, 0 deletions
diff --git a/docs/api/renderers.rst b/docs/api/renderers.rst
index c13694219..15670c46e 100644
--- a/docs/api/renderers.rst
+++ b/docs/api/renderers.rst
@@ -13,3 +13,12 @@
.. autoclass:: JSONP
+.. attribute:: null_renderer
+
+ An object that can be used in advanced integration cases as input to the
+ view configuration ``renderer=`` argument. When the null renderer is used
+ as a view renderer argument, Pyramid avoids converting the view callable
+ result into a Response object. This is useful if you want to reuse the
+ view configuration and lookup machinery outside the context of its use by
+ the Pyramid router (e.g. the package named ``pyramid_rpc`` does this).
+