Gitiles
Code Review Sign In
gerrit-public.fairphone.software / platform / external / python / cpython2 / 79828343d8b31b0ccd738490d24c14bafe365099 / . / Doc / library / httplib.rst
blob: 23b0e6429095171c4aae24a2ca5071f8c739205d [file] [log] [blame]
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]1:mod:`httplib` --- HTTP protocol client
2=======================================
3
4.. module:: httplib
5 :synopsis: HTTP and HTTPS protocol client (requires sockets).
6
Georg Brandl8de91192008-05-26 15:01:48 +0000[diff] [blame]7.. note::
8 The :mod:`httplib` module has been renamed to :mod:`http.client` in Python
Ezio Melotti510ff542012-05-03 19:21:40 +0300[diff] [blame]9 3. The :term:`2to3` tool will automatically adapt imports when converting
10 your sources to Python 3.
Georg Brandl8de91192008-05-26 15:01:48 +0000[diff] [blame]11
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]12
13.. index::
14 pair: HTTP; protocol
15 single: HTTP; httplib (standard module)
16
17.. index:: module: urllib
18
Éric Araujo29a0b572011-08-19 02:14:03 +0200[diff] [blame]19**Source code:** :source:`Lib/httplib.py`
20
21--------------
22
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]23This module defines classes which implement the client side of the HTTP and
24HTTPS protocols. It is normally not used directly --- the module :mod:`urllib`
25uses it to handle URLs that use HTTP and HTTPS.
26
27.. note::
28
29 HTTPS support is only available if the :mod:`socket` module was compiled with
30 SSL support.
31
32.. note::
33
34 The public interface for this module changed substantially in Python 2.0. The
35 :class:`HTTP` class is retained only for backward compatibility with 1.5.2. It
36 should not be used in new code. Refer to the online docstrings for usage.
37
38The module provides the following classes:
39
40
Gregory P. Smith9d325212010-01-03 02:06:07 +0000[diff] [blame]41.. class:: HTTPConnection(host[, port[, strict[, timeout[, source_address]]]])
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]42
43 An :class:`HTTPConnection` instance represents one transaction with an HTTP
Georg Brandlab756f62008-05-11 11:09:35 +0000[diff] [blame]44 server. It should be instantiated passing it a host and optional port
45 number. If no port number is passed, the port is extracted from the host
46 string if it has the form ``host:port``, else the default HTTP port (80) is
Brett Cannon031f3fb2008-11-15 22:33:25 +0000[diff] [blame]47 used. When True, the optional parameter *strict* (which defaults to a false
48 value) causes ``BadStatusLine`` to
Georg Brandlab756f62008-05-11 11:09:35 +0000[diff] [blame]49 be raised if the status line can't be parsed as a valid HTTP/1.0 or 1.1
50 status line. If the optional *timeout* parameter is given, blocking
51 operations (like connection attempts) will timeout after that many seconds
Facundo Batista4f1b1ed2008-05-29 16:39:26 +0000[diff] [blame]52 (if it is not given, the global default timeout setting is used).
Gregory P. Smith9d325212010-01-03 02:06:07 +0000[diff] [blame]53 The optional *source_address* parameter may be a tuple of a (host, port)
54 to use as the source address the HTTP connection is made from.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]55
56 For example, the following calls all create instances that connect to the server
57 at the same host and port::
58
59 >>> h1 = httplib.HTTPConnection('www.cwi.nl')
60 >>> h2 = httplib.HTTPConnection('www.cwi.nl:80')
61 >>> h3 = httplib.HTTPConnection('www.cwi.nl', 80)
62 >>> h3 = httplib.HTTPConnection('www.cwi.nl', 80, timeout=10)
63
64 .. versionadded:: 2.0
65
66 .. versionchanged:: 2.6
67 *timeout* was added.
68
Gregory P. Smith9d325212010-01-03 02:06:07 +0000[diff] [blame]69 .. versionchanged:: 2.7
70 *source_address* was added.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]71
Gregory P. Smith9d325212010-01-03 02:06:07 +0000[diff] [blame]72
Benjamin Petersonfcfb18e2014-11-23 11:42:45 -0600[diff] [blame]73.. class:: HTTPSConnection(host[, port[, key_file[, cert_file[, strict[, timeout[, source_address, context, check_hostname]]]]]])
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]74
75 A subclass of :class:`HTTPConnection` that uses SSL for communication with
Benjamin Petersonfcfb18e2014-11-23 11:42:45 -0600[diff] [blame]76 secure servers. Default port is ``443``. If *context* is specified, it must
77 be a :class:`ssl.SSLContext` instance describing the various SSL options.
78
79 *key_file* and *cert_file* are deprecated, please use
80 :meth:`ssl.SSLContext.load_cert_chain` instead, or let
81 :func:`ssl.create_default_context` select the system's trusted CA
82 certificates for you.
83
84 Please read :ref:`ssl-security` for more information on best practices.
85
86 .. note::
87 If *context* is specified and has a :attr:`~ssl.SSLContext.verify_mode`
88 of either :data:`~ssl.CERT_OPTIONAL` or :data:`~ssl.CERT_REQUIRED`, then
89 by default *host* is matched against the host name(s) allowed by the
90 server's certificate. If you want to change that behaviour, you can
91 explicitly set *check_hostname* to False.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]92
Antoine Pitrou66bfda82010-09-29 11:30:52 +0000[diff] [blame]93 .. warning::
94 This does not do any verification of the server's certificate.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]95
96 .. versionadded:: 2.0
97
98 .. versionchanged:: 2.6
99 *timeout* was added.
100
Gregory P. Smith9d325212010-01-03 02:06:07 +0000[diff] [blame]101 .. versionchanged:: 2.7
102 *source_address* was added.
103
Benjamin Petersonfcfb18e2014-11-23 11:42:45 -0600[diff] [blame]104 .. versionchanged:: 2.7.9
105 *context* and *check_hostname* was added.
106
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]107
Hynek Schlawacke58ce012012-05-22 10:27:40 +0200[diff] [blame]108.. class:: HTTPResponse(sock, debuglevel=0, strict=0)
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]109
110 Class whose instances are returned upon successful connection. Not instantiated
111 directly by user.
112
113 .. versionadded:: 2.0
114
Senthil Kumaran2af7e6d2010-06-28 10:54:17 +0000[diff] [blame]115.. class:: HTTPMessage
116
117 An :class:`HTTPMessage` instance is used to hold the headers from an HTTP
118 response. It is implemented using the :class:`mimetools.Message` class and
119 provides utility functions to deal with HTTP Headers. It is not directly
120 instantiated by the users.
121
122
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]123The following exceptions are raised as appropriate:
124
125
126.. exception:: HTTPException
127
128 The base class of the other exceptions in this module. It is a subclass of
129 :exc:`Exception`.
130
131 .. versionadded:: 2.0
132
133
134.. exception:: NotConnected
135
136 A subclass of :exc:`HTTPException`.
137
138 .. versionadded:: 2.0
139
140
141.. exception:: InvalidURL
142
143 A subclass of :exc:`HTTPException`, raised if a port is given and is either
144 non-numeric or empty.
145
146 .. versionadded:: 2.3
147
148
149.. exception:: UnknownProtocol
150
151 A subclass of :exc:`HTTPException`.
152
153 .. versionadded:: 2.0
154
155
156.. exception:: UnknownTransferEncoding
157
158 A subclass of :exc:`HTTPException`.
159
160 .. versionadded:: 2.0
161
162
163.. exception:: UnimplementedFileMode
164
165 A subclass of :exc:`HTTPException`.
166
167 .. versionadded:: 2.0
168
169
170.. exception:: IncompleteRead
171
172 A subclass of :exc:`HTTPException`.
173
174 .. versionadded:: 2.0
175
176
177.. exception:: ImproperConnectionState
178
179 A subclass of :exc:`HTTPException`.
180
181 .. versionadded:: 2.0
182
183
184.. exception:: CannotSendRequest
185
186 A subclass of :exc:`ImproperConnectionState`.
187
188 .. versionadded:: 2.0
189
190
191.. exception:: CannotSendHeader
192
193 A subclass of :exc:`ImproperConnectionState`.
194
195 .. versionadded:: 2.0
196
197
198.. exception:: ResponseNotReady
199
200 A subclass of :exc:`ImproperConnectionState`.
201
202 .. versionadded:: 2.0
203
204
205.. exception:: BadStatusLine
206
207 A subclass of :exc:`HTTPException`. Raised if a server responds with a HTTP
208 status code that we don't understand.
209
210 .. versionadded:: 2.0
211
212The constants defined in this module are:
213
214
215.. data:: HTTP_PORT
216
217 The default port for the HTTP protocol (always ``80``).
218
219
220.. data:: HTTPS_PORT
221
222 The default port for the HTTPS protocol (always ``443``).
223
224and also the following constants for integer status codes:
225
226+------------------------------------------+---------+-----------------------------------------------------------------------+
227| Constant | Value | Definition |
228+==========================================+=========+=======================================================================+
229| :const:`CONTINUE` | ``100`` | HTTP/1.1, `RFC 2616, Section |
230| | | 10.1.1 |
231| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.1.1>`_ |
232+------------------------------------------+---------+-----------------------------------------------------------------------+
233| :const:`SWITCHING_PROTOCOLS` | ``101`` | HTTP/1.1, `RFC 2616, Section |
234| | | 10.1.2 |
235| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.1.2>`_ |
236+------------------------------------------+---------+-----------------------------------------------------------------------+
237| :const:`PROCESSING` | ``102`` | WEBDAV, `RFC 2518, Section 10.1 |
238| | | <http://www.webdav.org/specs/rfc2518.html#STATUS_102>`_ |
239+------------------------------------------+---------+-----------------------------------------------------------------------+
240| :const:`OK` | ``200`` | HTTP/1.1, `RFC 2616, Section |
241| | | 10.2.1 |
242| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.1>`_ |
243+------------------------------------------+---------+-----------------------------------------------------------------------+
244| :const:`CREATED` | ``201`` | HTTP/1.1, `RFC 2616, Section |
245| | | 10.2.2 |
246| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.2>`_ |
247+------------------------------------------+---------+-----------------------------------------------------------------------+
248| :const:`ACCEPTED` | ``202`` | HTTP/1.1, `RFC 2616, Section |
249| | | 10.2.3 |
250| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.3>`_ |
251+------------------------------------------+---------+-----------------------------------------------------------------------+
252| :const:`NON_AUTHORITATIVE_INFORMATION` | ``203`` | HTTP/1.1, `RFC 2616, Section |
253| | | 10.2.4 |
254| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.4>`_ |
255+------------------------------------------+---------+-----------------------------------------------------------------------+
256| :const:`NO_CONTENT` | ``204`` | HTTP/1.1, `RFC 2616, Section |
257| | | 10.2.5 |
258| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.5>`_ |
259+------------------------------------------+---------+-----------------------------------------------------------------------+
260| :const:`RESET_CONTENT` | ``205`` | HTTP/1.1, `RFC 2616, Section |
261| | | 10.2.6 |
262| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.6>`_ |
263+------------------------------------------+---------+-----------------------------------------------------------------------+
264| :const:`PARTIAL_CONTENT` | ``206`` | HTTP/1.1, `RFC 2616, Section |
265| | | 10.2.7 |
266| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.2.7>`_ |
267+------------------------------------------+---------+-----------------------------------------------------------------------+
268| :const:`MULTI_STATUS` | ``207`` | WEBDAV `RFC 2518, Section 10.2 |
269| | | <http://www.webdav.org/specs/rfc2518.html#STATUS_207>`_ |
270+------------------------------------------+---------+-----------------------------------------------------------------------+
271| :const:`IM_USED` | ``226`` | Delta encoding in HTTP, |
272| | | :rfc:`3229`, Section 10.4.1 |
273+------------------------------------------+---------+-----------------------------------------------------------------------+
274| :const:`MULTIPLE_CHOICES` | ``300`` | HTTP/1.1, `RFC 2616, Section |
275| | | 10.3.1 |
276| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.1>`_ |
277+------------------------------------------+---------+-----------------------------------------------------------------------+
278| :const:`MOVED_PERMANENTLY` | ``301`` | HTTP/1.1, `RFC 2616, Section |
279| | | 10.3.2 |
280| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.2>`_ |
281+------------------------------------------+---------+-----------------------------------------------------------------------+
282| :const:`FOUND` | ``302`` | HTTP/1.1, `RFC 2616, Section |
283| | | 10.3.3 |
284| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.3>`_ |
285+------------------------------------------+---------+-----------------------------------------------------------------------+
286| :const:`SEE_OTHER` | ``303`` | HTTP/1.1, `RFC 2616, Section |
287| | | 10.3.4 |
288| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.4>`_ |
289+------------------------------------------+---------+-----------------------------------------------------------------------+
290| :const:`NOT_MODIFIED` | ``304`` | HTTP/1.1, `RFC 2616, Section |
291| | | 10.3.5 |
292| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.5>`_ |
293+------------------------------------------+---------+-----------------------------------------------------------------------+
294| :const:`USE_PROXY` | ``305`` | HTTP/1.1, `RFC 2616, Section |
295| | | 10.3.6 |
296| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.6>`_ |
297+------------------------------------------+---------+-----------------------------------------------------------------------+
298| :const:`TEMPORARY_REDIRECT` | ``307`` | HTTP/1.1, `RFC 2616, Section |
299| | | 10.3.8 |
300| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.3.8>`_ |
301+------------------------------------------+---------+-----------------------------------------------------------------------+
302| :const:`BAD_REQUEST` | ``400`` | HTTP/1.1, `RFC 2616, Section |
303| | | 10.4.1 |
304| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.1>`_ |
305+------------------------------------------+---------+-----------------------------------------------------------------------+
306| :const:`UNAUTHORIZED` | ``401`` | HTTP/1.1, `RFC 2616, Section |
307| | | 10.4.2 |
308| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.2>`_ |
309+------------------------------------------+---------+-----------------------------------------------------------------------+
310| :const:`PAYMENT_REQUIRED` | ``402`` | HTTP/1.1, `RFC 2616, Section |
311| | | 10.4.3 |
312| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.3>`_ |
313+------------------------------------------+---------+-----------------------------------------------------------------------+
314| :const:`FORBIDDEN` | ``403`` | HTTP/1.1, `RFC 2616, Section |
315| | | 10.4.4 |
316| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.4>`_ |
317+------------------------------------------+---------+-----------------------------------------------------------------------+
318| :const:`NOT_FOUND` | ``404`` | HTTP/1.1, `RFC 2616, Section |
319| | | 10.4.5 |
320| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.5>`_ |
321+------------------------------------------+---------+-----------------------------------------------------------------------+
322| :const:`METHOD_NOT_ALLOWED` | ``405`` | HTTP/1.1, `RFC 2616, Section |
323| | | 10.4.6 |
324| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.6>`_ |
325+------------------------------------------+---------+-----------------------------------------------------------------------+
326| :const:`NOT_ACCEPTABLE` | ``406`` | HTTP/1.1, `RFC 2616, Section |
327| | | 10.4.7 |
328| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.7>`_ |
329+------------------------------------------+---------+-----------------------------------------------------------------------+
330| :const:`PROXY_AUTHENTICATION_REQUIRED` | ``407`` | HTTP/1.1, `RFC 2616, Section |
331| | | 10.4.8 |
332| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.8>`_ |
333+------------------------------------------+---------+-----------------------------------------------------------------------+
334| :const:`REQUEST_TIMEOUT` | ``408`` | HTTP/1.1, `RFC 2616, Section |
335| | | 10.4.9 |
336| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.9>`_ |
337+------------------------------------------+---------+-----------------------------------------------------------------------+
338| :const:`CONFLICT` | ``409`` | HTTP/1.1, `RFC 2616, Section |
339| | | 10.4.10 |
340| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.10>`_ |
341+------------------------------------------+---------+-----------------------------------------------------------------------+
342| :const:`GONE` | ``410`` | HTTP/1.1, `RFC 2616, Section |
343| | | 10.4.11 |
344| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.11>`_ |
345+------------------------------------------+---------+-----------------------------------------------------------------------+
346| :const:`LENGTH_REQUIRED` | ``411`` | HTTP/1.1, `RFC 2616, Section |
347| | | 10.4.12 |
348| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.12>`_ |
349+------------------------------------------+---------+-----------------------------------------------------------------------+
350| :const:`PRECONDITION_FAILED` | ``412`` | HTTP/1.1, `RFC 2616, Section |
351| | | 10.4.13 |
352| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.13>`_ |
353+------------------------------------------+---------+-----------------------------------------------------------------------+
354| :const:`REQUEST_ENTITY_TOO_LARGE` | ``413`` | HTTP/1.1, `RFC 2616, Section |
355| | | 10.4.14 |
356| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.14>`_ |
357+------------------------------------------+---------+-----------------------------------------------------------------------+
358| :const:`REQUEST_URI_TOO_LONG` | ``414`` | HTTP/1.1, `RFC 2616, Section |
359| | | 10.4.15 |
360| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.15>`_ |
361+------------------------------------------+---------+-----------------------------------------------------------------------+
362| :const:`UNSUPPORTED_MEDIA_TYPE` | ``415`` | HTTP/1.1, `RFC 2616, Section |
363| | | 10.4.16 |
364| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.16>`_ |
365+------------------------------------------+---------+-----------------------------------------------------------------------+
366| :const:`REQUESTED_RANGE_NOT_SATISFIABLE` | ``416`` | HTTP/1.1, `RFC 2616, Section |
367| | | 10.4.17 |
368| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.17>`_ |
369+------------------------------------------+---------+-----------------------------------------------------------------------+
370| :const:`EXPECTATION_FAILED` | ``417`` | HTTP/1.1, `RFC 2616, Section |
371| | | 10.4.18 |
372| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.4.18>`_ |
373+------------------------------------------+---------+-----------------------------------------------------------------------+
374| :const:`UNPROCESSABLE_ENTITY` | ``422`` | WEBDAV, `RFC 2518, Section 10.3 |
375| | | <http://www.webdav.org/specs/rfc2518.html#STATUS_422>`_ |
376+------------------------------------------+---------+-----------------------------------------------------------------------+
377| :const:`LOCKED` | ``423`` | WEBDAV `RFC 2518, Section 10.4 |
378| | | <http://www.webdav.org/specs/rfc2518.html#STATUS_423>`_ |
379+------------------------------------------+---------+-----------------------------------------------------------------------+
380| :const:`FAILED_DEPENDENCY` | ``424`` | WEBDAV, `RFC 2518, Section 10.5 |
381| | | <http://www.webdav.org/specs/rfc2518.html#STATUS_424>`_ |
382+------------------------------------------+---------+-----------------------------------------------------------------------+
383| :const:`UPGRADE_REQUIRED` | ``426`` | HTTP Upgrade to TLS, |
384| | | :rfc:`2817`, Section 6 |
385+------------------------------------------+---------+-----------------------------------------------------------------------+
386| :const:`INTERNAL_SERVER_ERROR` | ``500`` | HTTP/1.1, `RFC 2616, Section |
387| | | 10.5.1 |
388| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.1>`_ |
389+------------------------------------------+---------+-----------------------------------------------------------------------+
390| :const:`NOT_IMPLEMENTED` | ``501`` | HTTP/1.1, `RFC 2616, Section |
391| | | 10.5.2 |
392| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.2>`_ |
393+------------------------------------------+---------+-----------------------------------------------------------------------+
394| :const:`BAD_GATEWAY` | ``502`` | HTTP/1.1 `RFC 2616, Section |
395| | | 10.5.3 |
396| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.3>`_ |
397+------------------------------------------+---------+-----------------------------------------------------------------------+
398| :const:`SERVICE_UNAVAILABLE` | ``503`` | HTTP/1.1, `RFC 2616, Section |
399| | | 10.5.4 |
400| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.4>`_ |
401+------------------------------------------+---------+-----------------------------------------------------------------------+
402| :const:`GATEWAY_TIMEOUT` | ``504`` | HTTP/1.1 `RFC 2616, Section |
403| | | 10.5.5 |
404| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.5>`_ |
405+------------------------------------------+---------+-----------------------------------------------------------------------+
406| :const:`HTTP_VERSION_NOT_SUPPORTED` | ``505`` | HTTP/1.1, `RFC 2616, Section |
407| | | 10.5.6 |
408| | | <http://www.w3.org/Protocols/rfc2616/rfc2616-sec10.html#sec10.5.6>`_ |
409+------------------------------------------+---------+-----------------------------------------------------------------------+
410| :const:`INSUFFICIENT_STORAGE` | ``507`` | WEBDAV, `RFC 2518, Section 10.6 |
411| | | <http://www.webdav.org/specs/rfc2518.html#STATUS_507>`_ |
412+------------------------------------------+---------+-----------------------------------------------------------------------+
413| :const:`NOT_EXTENDED` | ``510`` | An HTTP Extension Framework, |
414| | | :rfc:`2774`, Section 7 |
415+------------------------------------------+---------+-----------------------------------------------------------------------+
416
417
418.. data:: responses
419
420 This dictionary maps the HTTP 1.1 status codes to the W3C names.
421
422 Example: ``httplib.responses[httplib.NOT_FOUND]`` is ``'Not Found'``.
423
424 .. versionadded:: 2.5
425
426
427.. _httpconnection-objects:
428
429HTTPConnection Objects
430----------------------
431
432:class:`HTTPConnection` instances have the following methods:
433
434
435.. method:: HTTPConnection.request(method, url[, body[, headers]])
436
437 This will send a request to the server using the HTTP request method *method*
438 and the selector *url*. If the *body* argument is present, it should be a
439 string of data to send after the headers are finished. Alternatively, it may
440 be an open file object, in which case the contents of the file is sent; this
441 file object should support ``fileno()`` and ``read()`` methods. The header
442 Content-Length is automatically set to the correct value. The *headers*
443 argument should be a mapping of extra HTTP headers to send with the request.
444
445 .. versionchanged:: 2.6
446 *body* can be a file object.
447
448
449.. method:: HTTPConnection.getresponse()
450
451 Should be called after a request is sent to get the response from the server.
452 Returns an :class:`HTTPResponse` instance.
453
454 .. note::
455
456 Note that you must have read the whole response before you can send a new
457 request to the server.
458
459
460.. method:: HTTPConnection.set_debuglevel(level)
461
462 Set the debugging level (the amount of debugging output printed). The default
463 debug level is ``0``, meaning no debugging output is printed.
464
465
Senthil Kumaran0732fd92009-12-20 07:29:31 +0000[diff] [blame]466.. method:: HTTPConnection.set_tunnel(host,port=None, headers=None)
Senthil Kumarane266f252009-05-24 09:14:50 +0000[diff] [blame]467
468 Set the host and the port for HTTP Connect Tunnelling. Normally used when
469 it is required to do HTTPS Conection through a proxy server.
470
Sandro Tosi45262732011-12-25 11:43:37 +0100[diff] [blame]471 The headers argument should be a mapping of extra HTTP headers to send
Senthil Kumaran0732fd92009-12-20 07:29:31 +0000[diff] [blame]472 with the CONNECT request.
473
Gregory P. Smithd03e1b42009-05-24 18:00:13 +0000[diff] [blame]474 .. versionadded:: 2.7
475
Senthil Kumarane266f252009-05-24 09:14:50 +0000[diff] [blame]476
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]477.. method:: HTTPConnection.connect()
478
479 Connect to the server specified when the object was created.
480
481
482.. method:: HTTPConnection.close()
483
484 Close the connection to the server.
485
486As an alternative to using the :meth:`request` method described above, you can
487also send your request step by step, by using the four functions below.
488
489
490.. method:: HTTPConnection.putrequest(request, selector[, skip_host[, skip_accept_encoding]])
491
492 This should be the first call after the connection to the server has been made.
493 It sends a line to the server consisting of the *request* string, the *selector*
494 string, and the HTTP version (``HTTP/1.1``). To disable automatic sending of
495 ``Host:`` or ``Accept-Encoding:`` headers (for example to accept additional
496 content encodings), specify *skip_host* or *skip_accept_encoding* with non-False
497 values.
498
499 .. versionchanged:: 2.4
500 *skip_accept_encoding* argument added.
501
502
503.. method:: HTTPConnection.putheader(header, argument[, ...])
504
505 Send an :rfc:`822`\ -style header to the server. It sends a line to the server
506 consisting of the header, a colon and a space, and the first argument. If more
507 arguments are given, continuation lines are sent, each consisting of a tab and
508 an argument.
509
510
Senthil Kumaran83cc5122011-10-03 07:37:58 +0800[diff] [blame]511.. method:: HTTPConnection.endheaders(message_body=None)
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]512
Senthil Kumaran41d663f2011-10-05 23:52:49 +0800[diff] [blame]513 Send a blank line to the server, signalling the end of the headers. The
514 optional *message_body* argument can be used to pass a message body
515 associated with the request. The message body will be sent in the same
516 packet as the message headers if it is string, otherwise it is sent in a
517 separate packet.
518
519 .. versionchanged:: 2.7
520 *message_body* was added.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]521
522
523.. method:: HTTPConnection.send(data)
524
525 Send data to the server. This should be used directly only after the
526 :meth:`endheaders` method has been called and before :meth:`getresponse` is
527 called.
528
529
530.. _httpresponse-objects:
531
532HTTPResponse Objects
533--------------------
534
535:class:`HTTPResponse` instances have the following methods and attributes:
536
537
538.. method:: HTTPResponse.read([amt])
539
540 Reads and returns the response body, or up to the next *amt* bytes.
541
542
543.. method:: HTTPResponse.getheader(name[, default])
544
545 Get the contents of the header *name*, or *default* if there is no matching
546 header.
547
548
549.. method:: HTTPResponse.getheaders()
550
551 Return a list of (header, value) tuples.
552
553 .. versionadded:: 2.4
554
Senthil Kumaranc916dd72010-09-21 02:10:45 +0000[diff] [blame]555.. method:: HTTPResponse.fileno()
556
557 Returns the ``fileno`` of the underlying socket.
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]558
559.. attribute:: HTTPResponse.msg
560
561 A :class:`mimetools.Message` instance containing the response headers.
562
563
564.. attribute:: HTTPResponse.version
565
566 HTTP protocol version used by server. 10 for HTTP/1.0, 11 for HTTP/1.1.
567
568
569.. attribute:: HTTPResponse.status
570
571 Status code returned by server.
572
573
574.. attribute:: HTTPResponse.reason
575
576 Reason phrase returned by server.
577
578
579.. _httplib-examples:
580
581Examples
582--------
583
584Here is an example session that uses the ``GET`` method::
585
586 >>> import httplib
587 >>> conn = httplib.HTTPConnection("www.python.org")
588 >>> conn.request("GET", "/index.html")
589 >>> r1 = conn.getresponse()
590 >>> print r1.status, r1.reason
591 200 OK
592 >>> data1 = r1.read()
593 >>> conn.request("GET", "/parrot.spam")
594 >>> r2 = conn.getresponse()
595 >>> print r2.status, r2.reason
596 404 Not Found
597 >>> data2 = r2.read()
598 >>> conn.close()
599
Fred Drake58404692010-05-12 01:22:03 +0000[diff] [blame]600Here is an example session that uses the ``HEAD`` method. Note that the
601``HEAD`` method never returns any data. ::
Senthil Kumaraned9204342010-04-28 17:20:43 +0000[diff] [blame]602
603 >>> import httplib
604 >>> conn = httplib.HTTPConnection("www.python.org")
605 >>> conn.request("HEAD","/index.html")
606 >>> res = conn.getresponse()
607 >>> print res.status, res.reason
608 200 OK
609 >>> data = res.read()
610 >>> print len(data)
611 0
612 >>> data == ''
613 True
614
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]615Here is an example session that shows how to ``POST`` requests::
616
617 >>> import httplib, urllib
Senthil Kumarancd57ef12011-07-20 22:02:27 +0800[diff] [blame]618 >>> params = urllib.urlencode({'@number': 12524, '@type': 'issue', '@action': 'show'})
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]619 >>> headers = {"Content-type": "application/x-www-form-urlencoded",
620 ... "Accept": "text/plain"}
Senthil Kumarancd57ef12011-07-20 22:02:27 +0800[diff] [blame]621 >>> conn = httplib.HTTPConnection("bugs.python.org")
622 >>> conn.request("POST", "", params, headers)
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]623 >>> response = conn.getresponse()
624 >>> print response.status, response.reason
Senthil Kumarancd57ef12011-07-20 22:02:27 +0800[diff] [blame]625 302 Found
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]626 >>> data = response.read()
Senthil Kumarancd57ef12011-07-20 22:02:27 +0800[diff] [blame]627 >>> data
628 'Redirecting to <a href="http://bugs.python.org/issue12524">http://bugs.python.org/issue12524</a>'
Georg Brandl8ec7f652007-08-15 14:28:01 +0000[diff] [blame]629 >>> conn.close()
630
Senthil Kumaran69c66f92013-03-13 13:30:25 -0700[diff] [blame]631Client side ``HTTP PUT`` requests are very similar to ``POST`` requests. The
632difference lies only the server side where HTTP server will allow resources to
633be created via ``PUT`` request. Here is an example session that shows how to do
634``PUT`` request using httplib::
635
636 >>> # This creates an HTTP message
637 >>> # with the content of BODY as the enclosed representation
638 >>> # for the resource http://localhost:8080/foobar
639 ...
640 >>> import httplib
641 >>> BODY = "***filecontents***"
642 >>> conn = httplib.HTTPConnection("localhost", 8080)
643 >>> conn.request("PUT", "/file", BODY)
644 >>> response = conn.getresponse()
Georg Brandld6896502013-10-06 12:42:18 +0200[diff] [blame]645 >>> print response.status, response.reason
Senthil Kumaran69c66f92013-03-13 13:30:25 -0700[diff] [blame]646 200, OK
647