summaryrefslogtreecommitdiff
path: root/ref/response-objects.html
diff options
context:
space:
mode:
authorjcgregorio <devnull@localhost>2006-11-07 18:01:50 +0000
committerjcgregorio <devnull@localhost>2006-11-07 18:01:50 +0000
commitf76c951c4c1666d04602b9b3bbc72efb7fade4e5 (patch)
treefe61c9d11779df4290619bec0aa9c79cc2ef2970 /ref/response-objects.html
parent8e300b98651994cb2501469ab6faf583d6ec97e7 (diff)
downloadhttplib2-f76c951c4c1666d04602b9b3bbc72efb7fade4e5.tar.gz
Added documentation for -location
Diffstat (limited to 'ref/response-objects.html')
-rw-r--r--ref/response-objects.html18
1 files changed, 13 insertions, 5 deletions
diff --git a/ref/response-objects.html b/ref/response-objects.html
index 0878dc3..7848f3e 100644
--- a/ref/response-objects.html
+++ b/ref/response-objects.html
@@ -61,32 +61,32 @@ to header values. In addition to the dict methods
a Response object also has:
<P>
-<dl><dt><b><tt id='l2h-18' xml:id='l2h-18' class="member">fromcache</tt></b></dt>
+<dl><dt><b><tt id='l2h-19' xml:id='l2h-19' class="member">fromcache</tt></b></dt>
<dd>
If <code>true</code> the the response was returned from the cache.
</dl>
<P>
-<dl><dt><b><tt id='l2h-19' xml:id='l2h-19' class="member">version</tt></b></dt>
+<dl><dt><b><tt id='l2h-20' xml:id='l2h-20' class="member">version</tt></b></dt>
<dd>
The version of HTTP that the server supports. A value
of 11 means '1.1'.
</dl>
<P>
-<dl><dt><b><tt id='l2h-20' xml:id='l2h-20' class="member">status</tt></b></dt>
+<dl><dt><b><tt id='l2h-21' xml:id='l2h-21' class="member">status</tt></b></dt>
<dd>
The numerical HTTP status code returned in the response.
</dl>
<P>
-<dl><dt><b><tt id='l2h-21' xml:id='l2h-21' class="member">reason</tt></b></dt>
+<dl><dt><b><tt id='l2h-22' xml:id='l2h-22' class="member">reason</tt></b></dt>
<dd>
The human readable component of the HTTP response status code.
</dl>
<P>
-<dl><dt><b><tt id='l2h-22' xml:id='l2h-22' class="member">previous</tt></b></dt>
+<dl><dt><b><tt id='l2h-23' xml:id='l2h-23' class="member">previous</tt></b></dt>
<dd>
If redirects are followed then the <tt class="class">Response</tt> object returned
is just for the very last HTTP request and <var>previous</var> points to
@@ -96,6 +96,14 @@ Will be <code>None</code> if there are no previous respones.
</dl>
<P>
+The Response object also has a special key value <code>-location</code>, that
+contains the URI that was ultimately requested. This is useful if
+redirects were encountered, you can determine the ultimate URI that
+the request was sent to. All Response objects contain this key value,
+including <code>previous</code> responses so you can determine the entire
+chain of redirects.
+
+<P>
<DIV CLASS="navigation">
<div class='online-navigation'>