Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / httplib2 / 5dc440bc08bef6a1e18780cfecc8dcbe587486c8 / . / ref / http-objects.html
blob: 4def8526b53d82e10539c3403d4a2afa74d54811 [file] [log] [blame]
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]1<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.0 Transitional//EN">
2<html>
3<head>
4<link rel="STYLESHEET" href="ref.css" type='text/css' />
5<link rel="first" href="ref.html" title='The httplib2 Library' />
6<link rel='contents' href='contents.html' title="Contents" />
7<link rel='last' href='about.html' title='About this document...' />
8<link rel='help' href='about.html' title='About this document...' />
9<link rel="next" href="cache-objects.html" />
10<link rel="prev" href="module-httplib2.html" />
11<link rel="parent" href="module-httplib2.html" />
12<link rel="next" href="cache-objects.html" />
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]13<meta http-equiv="Content-Type" content="text/html; charset=utf-8" />
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]14<meta name='aesop' content='information' />
15<title>1.1.1 Http Objects</title>
16</head>
17<body>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]18<div class="navigation">
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]19<div id='top-navigation-panel' xml:id='top-navigation-panel'>
20<table align="center" width="100%" cellpadding="0" cellspacing="2">
21<tr>
22<td class='online-navigation'><a rel="prev" title="1.1 httplib2 A comprehensive"
23 href="module-httplib2.html"><img src='previous.png'
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]24 border='0' height='32' alt='Previous Page' width='32' /></a></td>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]25<td class='online-navigation'><a rel="parent" title="1.1 httplib2 A comprehensive"
26 href="module-httplib2.html"><img src='up.png'
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]27 border='0' height='32' alt='Up one Level' width='32' /></a></td>
28<td class='online-navigation'><a rel="next" title="1.1.2 cache Objects"
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]29 href="cache-objects.html"><img src='next.png'
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]30 border='0' height='32' alt='Next Page' width='32' /></a></td>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]31<td align="center" width="100%">The httplib2 Library</td>
32<td class='online-navigation'><a rel="contents" title="Table of Contents"
33 href="contents.html"><img src='contents.png'
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]34 border='0' height='32' alt='Contents' width='32' /></a></td>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]35<td class='online-navigation'><img src='blank.png'
36 border='0' height='32' alt='' width='32' /></td>
37<td class='online-navigation'><img src='blank.png'
38 border='0' height='32' alt='' width='32' /></td>
39</tr></table>
40<div class='online-navigation'>
41<b class="navlabel">Previous:</b>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]42<a class="sectref" rel="prev" href="module-httplib2.html">1.1 httplib2 A comprehensive</a>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]43<b class="navlabel">Up:</b>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]44<a class="sectref" rel="parent" href="module-httplib2.html">1.1 httplib2 A comprehensive</a>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]45<b class="navlabel">Next:</b>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]46<a class="sectref" rel="next" href="cache-objects.html">1.1.2 Cache Objects</a>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]47</div>
48<hr /></div>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]49</div>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]50<!--End of Navigation Panel-->
51
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]52<h2><a name="SECTION002110000000000000000"></a>
53<a name="http-objects"></a>
54<br>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]551.1.1 Http Objects
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]56</h2>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]57
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]58<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]59Http objects have the following methods:
60
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]61<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]62<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
jcgregoriocde4f092007-03-08 21:59:04 +0000[diff] [blame]63 <td><nobr><b><tt id='l2h-14' xml:id='l2h-14' class="method">request</tt></b>(</nobr></td>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]64 <td><var>uri, </var><big>[</big><var>method="GET", body=None, headers=None, redirections=DEFAULT_MAX_REDIRECTS</var><big>]</big><var></var>)</td></tr></table></dt>
65<dd>
66Performs a single HTTP request.
67The <var>uri</var> is the URI of the HTTP resource and can begin with either <code>http</code> or <code>https</code>. The value of <var>uri</var> must be an absolute URI.
68
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]69<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]70The <var>method</var> is the HTTP method to perform, such as <code>GET</code>, <code>POST</code>, <code>DELETE</code>, etc. There is no restriction
71on the methods allowed.
72
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]73<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]74The <var>body</var> is the entity body to be sent with the request. It is a string
75object.
76
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]77<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]78Any extra headers that are to be sent with the request should be provided in the
79<var>headers</var> dictionary.
80
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]81<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]82The maximum number of redirect to follow before raising an exception is <var>redirections</var>. The default is 5.
83
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]84<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]85The return value is a tuple of (response, content), the first being and instance of the
86<tt class="class">Response</tt> class, the second being a string that contains the response entity body.
87</dl>
88
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]89<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]90<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
jcgregoriocde4f092007-03-08 21:59:04 +0000[diff] [blame]91 <td><nobr><b><tt id='l2h-15' xml:id='l2h-15' class="method">add_credentials</tt></b>(</nobr></td>
jcgregorio87eee732007-03-09 03:23:11 +0000[diff] [blame]92 <td><var>name, password, </var><big>[</big><var>domain=None</var><big>]</big><var></var>)</td></tr></table></dt>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]93<dd>
94Adds a name and password that will be used when a request
jcgregorio87eee732007-03-09 03:23:11 +0000[diff] [blame]95requires authentication. Supplying the optional <var>domain</var> name will
96restrict these credentials to only be sent to the specified
97domain. If <var>domain</var> is not specified then the given credentials will
98be used to try to satisfy every HTTP 401 challenge.
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]99</dl>
100
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]101<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]102<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
jcgregorio87eee732007-03-09 03:23:11 +0000[diff] [blame]103 <td><nobr><b><tt id='l2h-16' xml:id='l2h-16' class="method">add_certificate</tt></b>(</nobr></td>
104 <td><var>key, cert, domain</var>)</td></tr></table></dt>
105<dd>
106Add a <var>key</var> and <var>cert</var> that will be used for an SSL connection
107to the specified domain. <var>keyfile</var> is the name of a PEM formatted
108file that contains your private key. <var>certfile</var> is a PEM formatted certificate chain file.
109</dl>
110
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]111<p>
jcgregorio87eee732007-03-09 03:23:11 +0000[diff] [blame]112<dl><dt><table cellpadding="0" cellspacing="0"><tr valign="baseline">
113 <td><nobr><b><tt id='l2h-17' xml:id='l2h-17' class="method">clear_credentials</tt></b>(</nobr></td>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]114 <td><var></var>)</td></tr></table></dt>
115<dd>
116Remove all the names and passwords used for authentication.
117</dl>
118
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]119<p>
120<dl><dt><b><tt id='l2h-18' xml:id='l2h-18' class="member">follow_redirects</tt></b></dt>
121<dd>
122If <code>True</code>, which is the default, safe redirects are followed, where
123safe means that the client is only doing a <code>GET</code> or <code>HEAD</code> on the
124URI to which it is being redirected. If <code>False</code> then no redirects are followed.
125Note that a False 'follow_redirects' takes precedence over a True 'follow_all_redirects'.
126Another way of saying that is for 'follow_all_redirects' to have any affect, 'follow_redirects'
jcgregorio5dc440b2007-05-03 13:23:27 +0000[diff] [blame^]127must be True.
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]128</dl>
129
130<p>
131<dl><dt><b><tt id='l2h-19' xml:id='l2h-19' class="member">follow_all_redirects</tt></b></dt>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]132<dd>
jcgregoriof76c9512006-11-07 18:01:50 +0000[diff] [blame]133If <code>False</code>, which is the default, only safe redirects are followed, where
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]134safe means that the client is only doing a <code>GET</code> or <code>HEAD</code> on the
jcgregoriof76c9512006-11-07 18:01:50 +0000[diff] [blame]135URI to which it is being redirected. If <code>True</code> then all redirects are followed.
jcgregorio5dc440b2007-05-03 13:23:27 +0000[diff] [blame^]136Note that a False 'follow_redirects' takes precedence over a True 'follow_all_redirects'.
137Another way of saying that is for 'follow_all_redirects' to have any affect, 'follow_redirects'
138must be True.
jcgregoriof76c9512006-11-07 18:01:50 +0000[diff] [blame]139</dl>
140
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]141<p>
142<dl><dt><b><tt id='l2h-20' xml:id='l2h-20' class="member">force_exception_to_status_code</tt></b></dt>
jcgregoriocde4f092007-03-08 21:59:04 +0000[diff] [blame]143<dd>
144If <code>True</code>, which is the default, then no <tt class="module">httplib2</tt> exceptions will be thrown. Instead,
145those error conditions will be turned into <tt class="class">Response</tt> objects
146that will be returned normally.
147
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]148<p>
jcgregoriocde4f092007-03-08 21:59:04 +0000[diff] [blame]149If <code>False</code>, then exceptions will be thrown.
150</dl>
151
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]152<p>
153<dl><dt><b><tt id='l2h-21' xml:id='l2h-21' class="member">ignore_etag</tt></b></dt>
jcgregoriof76c9512006-11-07 18:01:50 +0000[diff] [blame]154<dd>
jcgregorio87eee732007-03-09 03:23:11 +0000[diff] [blame]155Defaults to <code>False</code>. If <code>True</code>, then any etags present in the cached response
156are ignored when processing the current request, i.e. httplib2 does <strong>not</strong> use
jcgregoriof76c9512006-11-07 18:01:50 +0000[diff] [blame]157'if-match' for PUT or 'if-none-match' when GET or HEAD requests are made. This
158is mainly to deal with broken servers which supply an etag, but change it capriciously.
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]159</dl>
160
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]161<p>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]162
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]163<div class="navigation">
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]164<div class='online-navigation'>
165<p></p><hr />
166<table align="center" width="100%" cellpadding="0" cellspacing="2">
167<tr>
168<td class='online-navigation'><a rel="prev" title="1.1 httplib2 A comprehensive"
169 href="module-httplib2.html"><img src='previous.png'
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]170 border='0' height='32' alt='Previous Page' width='32' /></a></td>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]171<td class='online-navigation'><a rel="parent" title="1.1 httplib2 A comprehensive"
172 href="module-httplib2.html"><img src='up.png'
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]173 border='0' height='32' alt='Up one Level' width='32' /></a></td>
174<td class='online-navigation'><a rel="next" title="1.1.2 cache Objects"
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]175 href="cache-objects.html"><img src='next.png'
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]176 border='0' height='32' alt='Next Page' width='32' /></a></td>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]177<td align="center" width="100%">The httplib2 Library</td>
178<td class='online-navigation'><a rel="contents" title="Table of Contents"
179 href="contents.html"><img src='contents.png'
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]180 border='0' height='32' alt='Contents' width='32' /></a></td>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]181<td class='online-navigation'><img src='blank.png'
182 border='0' height='32' alt='' width='32' /></td>
183<td class='online-navigation'><img src='blank.png'
184 border='0' height='32' alt='' width='32' /></td>
185</tr></table>
186<div class='online-navigation'>
187<b class="navlabel">Previous:</b>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]188<a class="sectref" rel="prev" href="module-httplib2.html">1.1 httplib2 A comprehensive</a>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]189<b class="navlabel">Up:</b>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]190<a class="sectref" rel="parent" href="module-httplib2.html">1.1 httplib2 A comprehensive</a>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]191<b class="navlabel">Next:</b>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]192<a class="sectref" rel="next" href="cache-objects.html">1.1.2 Cache Objects</a>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]193</div>
194</div>
195<hr />
jcgregoriocde4f092007-03-08 21:59:04 +0000[diff] [blame]196<span class="release-info">Release 0.3, documentation updated on Mar 8, 2007.</span>
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]197</div>
jcgregorio26c0cd72006-07-03 17:36:17 +0000[diff] [blame]198<!--End of Navigation Panel-->
199
jcgregorio88ada9a2007-05-03 13:20:38 +0000[diff] [blame]200</body>
201</html>