summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorChris McDonough <chrism@agendaless.com>2009-12-30 00:51:00 +0000
committerChris McDonough <chrism@agendaless.com>2009-12-30 00:51:00 +0000
commitbf76adfca191a3ece130c53c3ee8a300428a8302 (patch)
tree6ac03f3804962e8e3ed999162dc405378dcb4c8f /docs/narr
parentd22e8dc6772b15de7ed1372e1eb2dcd01311591e (diff)
downloadpyramid-bf76adfca191a3ece130c53c3ee8a300428a8302.tar.gz
pyramid-bf76adfca191a3ece130c53c3ee8a300428a8302.tar.bz2
pyramid-bf76adfca191a3ece130c53c3ee8a300428a8302.zip
Less restrictive license; add Ian attribution.
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/webob.rst22
1 files changed, 22 insertions, 0 deletions
diff --git a/docs/narr/webob.rst b/docs/narr/webob.rst
index 6f2b9ff21..4284c4110 100644
--- a/docs/narr/webob.rst
+++ b/docs/narr/webob.rst
@@ -1,8 +1,14 @@
+.. index::
+ pair: ian; bicking
+
.. _webob_chapter:
Request and Response Objects
============================
+.. note:: This chapter is adapted from a portion of the :term:`WebOb`
+ documentation, originally written by Ian Bicking.
+
:mod:`repoze.bfg` uses the :term:`WebOb` package to supply
:term:`request` and :term:`response` object implementations. The
:term:`request` object that is passed to a :mod:`repoze.bfg`
@@ -98,6 +104,9 @@ instance, ``req.if_modified_since`` returns a `datetime
`Request reference
<http://pythonpaste.org/webob/class-webob.Request.html>`_.
+.. index::
+ pair: request; URL
+
URLs
++++
@@ -121,6 +130,10 @@ of the request. I'll show various values for an example URL
Gives a URL, relative to the current URL. If ``to_application``
is True, then resolves it relative to ``req.application_url``.
+
+.. index::
+ pair: request; methods
+
Methods
+++++++
@@ -141,6 +154,9 @@ only a few you'll use often:
and returns a `Response`_ object. You can also use this for
subrequests or testing.
+.. index::
+ pair: request; unicode
+
Unicode
+++++++
@@ -242,6 +258,9 @@ properties. These are parsed, so you can do things like
The details are available in the `extracted Response documentation
<http://pythonpaste.org/webob/class-webob.Response.html>`_.
+.. index::
+ pair: response; creating
+
Instantiating the Response
++++++++++++++++++++++++++
@@ -329,6 +348,9 @@ key/value pairs will show up. Similarly ``request.GET.keys()``
returns ``['pref', 'pref']``. Multidict is a view on a list of
tuples; all the keys are ordered, and all the values are ordered.
+.. index::
+ triple: response; attributes; special
+
Special :mod:`repoze.bfg` Attributes Added to the Request
---------------------------------------------------------