diff options
author | jcgregorio <devnull@localhost> | 2007-03-09 03:23:11 +0000 |
---|---|---|
committer | jcgregorio <devnull@localhost> | 2007-03-09 03:23:11 +0000 |
commit | 87eee73c0c7b2c7b7e5251738703251a42f2633a (patch) | |
tree | 11fab3385ba028cbb524eb4ca83b459aa58c8ef9 /ref | |
parent | e6a0196b53a41a956739094cd80113abe4cdeb5c (diff) | |
download | httplib2-87eee73c0c7b2c7b7e5251738703251a42f2633a.tar.gz |
Updated docs
Diffstat (limited to 'ref')
-rw-r--r-- | ref/cache-objects.html | 6 | ||||
-rw-r--r-- | ref/http-objects.html | 29 | ||||
-rw-r--r-- | ref/response-objects.html | 10 |
3 files changed, 29 insertions, 16 deletions
diff --git a/ref/cache-objects.html b/ref/cache-objects.html index 6863974..b10324d 100644 --- a/ref/cache-objects.html +++ b/ref/cache-objects.html @@ -62,7 +62,7 @@ supports this interface natively. <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> - <td><nobr><b><tt id='l2h-20' xml:id='l2h-20' class="method">get</tt></b>(</nobr></td> + <td><nobr><b><tt id='l2h-21' xml:id='l2h-21' class="method">get</tt></b>(</nobr></td> <td><var>key</var>)</td></tr></table></dt> <dd> Takes a string <var>key</var> and returns the value as a string. @@ -70,7 +70,7 @@ Takes a string <var>key</var> and returns the value as a string. <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> - <td><nobr><b><tt id='l2h-21' xml:id='l2h-21' class="method">set</tt></b>(</nobr></td> + <td><nobr><b><tt id='l2h-22' xml:id='l2h-22' class="method">set</tt></b>(</nobr></td> <td><var>key, value</var>)</td></tr></table></dt> <dd> Takes a string <var>key</var> and <var>value</var> and stores it in the cache. @@ -78,7 +78,7 @@ Takes a string <var>key</var> and <var>value</var> and stores it in the cache. <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> - <td><nobr><b><tt id='l2h-22' xml:id='l2h-22' class="method">delete</tt></b>(</nobr></td> + <td><nobr><b><tt id='l2h-23' xml:id='l2h-23' class="method">delete</tt></b>(</nobr></td> <td><var>key</var>)</td></tr></table></dt> <dd> Deletes the cached value stored at <var>key</var>. The value diff --git a/ref/http-objects.html b/ref/http-objects.html index 2596974..0bcce37 100644 --- a/ref/http-objects.html +++ b/ref/http-objects.html @@ -88,22 +88,35 @@ The return value is a tuple of (response, content), the first being and instance <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> <td><nobr><b><tt id='l2h-15' xml:id='l2h-15' class="method">add_credentials</tt></b>(</nobr></td> - <td><var>name, password</var>)</td></tr></table></dt> + <td><var>name, password, </var><big>[</big><var>domain=None</var><big>]</big><var></var>)</td></tr></table></dt> <dd> Adds a name and password that will be used when a request -requires authentication. +requires authentication. Supplying the optional <var>domain</var> name will +restrict these credentials to only be sent to the specified +domain. If <var>domain</var> is not specified then the given credentials will +be used to try to satisfy every HTTP 401 challenge. </dl> <P> <dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> - <td><nobr><b><tt id='l2h-16' xml:id='l2h-16' class="method">clear_credentials</tt></b>(</nobr></td> + <td><nobr><b><tt id='l2h-16' xml:id='l2h-16' class="method">add_certificate</tt></b>(</nobr></td> + <td><var>key, cert, domain</var>)</td></tr></table></dt> +<dd> +Add a <var>key</var> and <var>cert</var> that will be used for an SSL connection +to the specified domain. <var>keyfile</var> is the name of a PEM formatted +file that contains your private key. <var>certfile</var> is a PEM formatted certificate chain file. +</dl> + +<P> +<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline"> + <td><nobr><b><tt id='l2h-17' xml:id='l2h-17' class="method">clear_credentials</tt></b>(</nobr></td> <td><var></var>)</td></tr></table></dt> <dd> Remove all the names and passwords used for authentication. </dl> <P> -<dl><dt><b><tt id='l2h-17' xml:id='l2h-17' class="member">follow_all_redirects</tt></b></dt> +<dl><dt><b><tt id='l2h-18' xml:id='l2h-18' class="member">follow_all_redirects</tt></b></dt> <dd> If <code>False</code>, which is the default, only safe redirects are followed, where safe means that the client is only doing a <code>GET</code> or <code>HEAD</code> on the @@ -111,7 +124,7 @@ URI to which it is being redirected. If <code>True</code> then all redirects are </dl> <P> -<dl><dt><b><tt id='l2h-18' xml:id='l2h-18' class="member">force_exception_to_status_code</tt></b></dt> +<dl><dt><b><tt id='l2h-19' xml:id='l2h-19' class="member">force_exception_to_status_code</tt></b></dt> <dd> If <code>True</code>, which is the default, then no <tt class="module">httplib2</tt> exceptions will be thrown. Instead, those error conditions will be turned into <tt class="class">Response</tt> objects @@ -122,10 +135,10 @@ If <code>False</code>, then exceptions will be thrown. </dl> <P> -<dl><dt><b><tt id='l2h-19' xml:id='l2h-19' class="member">ignore_etag</tt></b></dt> +<dl><dt><b><tt id='l2h-20' xml:id='l2h-20' class="member">ignore_etag</tt></b></dt> <dd> -Defaults to <code>False</code>. If True, then any etags present in the cached response -are ignored when processing the current request, i.e. httplib2 does *not* use +Defaults to <code>False</code>. If <code>True</code>, then any etags present in the cached response +are ignored when processing the current request, i.e. httplib2 does <strong>not</strong> use 'if-match' for PUT or 'if-none-match' when GET or HEAD requests are made. This is mainly to deal with broken servers which supply an etag, but change it capriciously. </dl> diff --git a/ref/response-objects.html b/ref/response-objects.html index 0b78a16..8430539 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-23' xml:id='l2h-23' class="member">fromcache</tt></b></dt> +<dl><dt><b><tt id='l2h-24' xml:id='l2h-24' 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-24' xml:id='l2h-24' class="member">version</tt></b></dt> +<dl><dt><b><tt id='l2h-25' xml:id='l2h-25' 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-25' xml:id='l2h-25' class="member">status</tt></b></dt> +<dl><dt><b><tt id='l2h-26' xml:id='l2h-26' class="member">status</tt></b></dt> <dd> The numerical HTTP status code returned in the response. </dl> <P> -<dl><dt><b><tt id='l2h-26' xml:id='l2h-26' class="member">reason</tt></b></dt> +<dl><dt><b><tt id='l2h-27' xml:id='l2h-27' 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-27' xml:id='l2h-27' class="member">previous</tt></b></dt> +<dl><dt><b><tt id='l2h-28' xml:id='l2h-28' 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 |