20.7. `httplib` — HTTP 协议客户端 ¶

注意

The httplib module has been renamed to http.client in Python 3. The 2to3 tool will automatically adapt imports when converting your sources to Python 3.

源代码： Lib/httplib.py

此模块定义实现 HTTP 和 HTTPS 协议客户端侧的类。通常不直接使用它 — 模块 urllib 使用它来处理使用 HTTP 和 HTTPS 的 URL。

另请参阅

The Requests 包推荐为更高级别的 HTTP 客户端接口。

注意

HTTPS support is only available if the socket module was compiled with SSL support.

注意

The public interface for this module changed substantially in Python 2.0. The HTTP class is retained only for backward compatibility with 1.5.2. It should not be used in new code. Refer to the online docstrings for usage.

模块提供下列类：

class httplib. HTTPConnection ( host [ , port [ , strict [ , timeout [ , source_address ] ] ] ] ) ¶

class httplib. HTTPSConnection ( host [ , port [ , key_file [ , cert_file [ , strict [ , timeout [ , source_address [ , context ] ] ] ] ] ] ] ) ¶

class httplib. HTTPResponse ( sock , debuglevel=0 , strict=0 ) ¶

class httplib. HTTPMessage ¶

The following exceptions are raised as appropriate:

exception httplib. HTTPException ¶

exception httplib. NotConnected ¶

exception httplib. InvalidURL ¶

exception httplib. UnknownProtocol ¶

exception httplib. UnknownTransferEncoding ¶

exception httplib. UnimplementedFileMode ¶

exception httplib. IncompleteRead ¶

exception httplib. ImproperConnectionState ¶

exception httplib. CannotSendRequest ¶

exception httplib. CannotSendHeader ¶

exception httplib. ResponseNotReady ¶

exception httplib. BadStatusLine ¶

此模块中定义的常量：

httplib. HTTP_PORT ¶

httplib. HTTPS_PORT ¶

and also the following constants for integer status codes:

常量	值	Definition
`CONTINUE`	`100`	HTTP/1.1, RFC 2616, Section 10.1.1
`SWITCHING_PROTOCOLS`	`101`	HTTP/1.1, RFC 2616, Section 10.1.2
`PROCESSING`	`102`	WEBDAV, RFC 2518, Section 10.1
`OK`	`200`	HTTP/1.1, RFC 2616, Section 10.2.1
`CREATED`	`201`	HTTP/1.1, RFC 2616, Section 10.2.2
`ACCEPTED`	`202`	HTTP/1.1, RFC 2616, Section 10.2.3
`NON_AUTHORITATIVE_INFORMATION`	`203`	HTTP/1.1, RFC 2616, Section 10.2.4
`NO_CONTENT`	`204`	HTTP/1.1, RFC 2616, Section 10.2.5
`RESET_CONTENT`	`205`	HTTP/1.1, RFC 2616, Section 10.2.6
`PARTIAL_CONTENT`	`206`	HTTP/1.1, RFC 2616, Section 10.2.7
`MULTI_STATUS`	`207`	WEBDAV RFC 2518, Section 10.2
`IM_USED`	`226`	Delta encoding in HTTP, RFC 3229 ，章节 10.4.1
`MULTIPLE_CHOICES`	`300`	HTTP/1.1, RFC 2616, Section 10.3.1
`MOVED_PERMANENTLY`	`301`	HTTP/1.1, RFC 2616, Section 10.3.2
`FOUND`	`302`	HTTP/1.1, RFC 2616, Section 10.3.3
`SEE_OTHER`	`303`	HTTP/1.1, RFC 2616, Section 10.3.4
`NOT_MODIFIED`	`304`	HTTP/1.1, RFC 2616, Section 10.3.5
`USE_PROXY`	`305`	HTTP/1.1, RFC 2616, Section 10.3.6
`TEMPORARY_REDIRECT`	`307`	HTTP/1.1, RFC 2616, Section 10.3.8
`BAD_REQUEST`	`400`	HTTP/1.1, RFC 2616, Section 10.4.1
`UNAUTHORIZED`	`401`	HTTP/1.1, RFC 2616, Section 10.4.2
`PAYMENT_REQUIRED`	`402`	HTTP/1.1, RFC 2616, Section 10.4.3
`FORBIDDEN`	`403`	HTTP/1.1, RFC 2616, Section 10.4.4
`NOT_FOUND`	`404`	HTTP/1.1, RFC 2616, Section 10.4.5
`METHOD_NOT_ALLOWED`	`405`	HTTP/1.1, RFC 2616, Section 10.4.6
`NOT_ACCEPTABLE`	`406`	HTTP/1.1, RFC 2616, Section 10.4.7
`PROXY_AUTHENTICATION_REQUIRED`	`407`	HTTP/1.1, RFC 2616, Section 10.4.8
`REQUEST_TIMEOUT`	`408`	HTTP/1.1, RFC 2616, Section 10.4.9
`CONFLICT`	`409`	HTTP/1.1, RFC 2616, Section 10.4.10
`GONE`	`410`	HTTP/1.1, RFC 2616, Section 10.4.11
`LENGTH_REQUIRED`	`411`	HTTP/1.1, RFC 2616, Section 10.4.12
`PRECONDITION_FAILED`	`412`	HTTP/1.1, RFC 2616, Section 10.4.13
`REQUEST_ENTITY_TOO_LARGE`	`413`	HTTP/1.1, RFC 2616, Section 10.4.14
`REQUEST_URI_TOO_LONG`	`414`	HTTP/1.1, RFC 2616, Section 10.4.15
`UNSUPPORTED_MEDIA_TYPE`	`415`	HTTP/1.1, RFC 2616, Section 10.4.16
`REQUESTED_RANGE_NOT_SATISFIABLE`	`416`	HTTP/1.1, RFC 2616, Section 10.4.17
`EXPECTATION_FAILED`	`417`	HTTP/1.1, RFC 2616, Section 10.4.18
`UNPROCESSABLE_ENTITY`	`422`	WEBDAV, RFC 2518, Section 10.3
`LOCKED`	`423`	WEBDAV RFC 2518, Section 10.4
`FAILED_DEPENDENCY`	`424`	WEBDAV, RFC 2518, Section 10.5
`UPGRADE_REQUIRED`	`426`	HTTP Upgrade to TLS, RFC 2817 ，章节 6
`INTERNAL_SERVER_ERROR`	`500`	HTTP/1.1, RFC 2616, Section 10.5.1
`NOT_IMPLEMENTED`	`501`	HTTP/1.1, RFC 2616, Section 10.5.2
`BAD_GATEWAY`	`502`	HTTP/1.1 RFC 2616, Section 10.5.3
`SERVICE_UNAVAILABLE`	`503`	HTTP/1.1, RFC 2616, Section 10.5.4
`GATEWAY_TIMEOUT`	`504`	HTTP/1.1 RFC 2616, Section 10.5.5
`HTTP_VERSION_NOT_SUPPORTED`	`505`	HTTP/1.1, RFC 2616, Section 10.5.6
`INSUFFICIENT_STORAGE`	`507`	WEBDAV, RFC 2518, Section 10.6
`NOT_EXTENDED`	`510`	An HTTP Extension Framework, RFC 2774 , Section 7

httplib. responses ¶

20.7.1. HTTPConnection 对象 ¶

HTTPConnection 实例具有下列方法：

HTTPConnection. request ( 方法 , url [ , body [ , headers ] ] ) ¶

This will send a request to the server using the HTTP request method 方法 and the selector url 。若 body argument is present, it should be a string of data to send after the headers are finished. Alternatively, it may be an open file object, in which case the contents of the file is sent; this file object should support fileno() and read() methods. The headers argument should be a mapping of extra HTTP headers to send with the request.

If one is not provided in headers ， Content-Length header is added automatically for all methods if the length of the body can be determined, either from the length of the str representation, or from the reported size of the file on disk. If body is None the header is not set except for methods that expect a body ( PUT , POST ，和 PATCH ) in which case it is set to 0 .

2.6 版改变： body can be a file object.

HTTPConnection. getresponse ( ) ¶

HTTPConnection. set_debuglevel ( level ) ¶

HTTPConnection. set_tunnel ( host , port=None , headers=None ) ¶

HTTPConnection. connect ( ) ¶

HTTPConnection. close ( ) ¶

As an alternative to using the request() method described above, you can also send your request step by step, by using the four functions below.

HTTPConnection. putrequest ( request , 选择器 [ , skip_host [ , skip_accept_encoding ] ] ) ¶

This should be the first call after the connection to the server has been made. It sends a line to the server consisting of the request string, the 选择器 string, and the HTTP version ( HTTP/1.1 ). To disable automatic sending of Host: or Accept-Encoding: headers (for example to accept additional content encodings), specify skip_host or skip_accept_encoding with non-False values.

2.4 版改变： skip_accept_encoding argument added.

HTTPConnection. putheader ( header , argument [ , ... ] ) ¶

HTTPConnection. endheaders ( message_body=None ) ¶

Send a blank line to the server, signalling the end of the headers. The optional message_body argument can be used to pass a message body associated with the request. The message body will be sent in the same packet as the message headers if it is string, otherwise it is sent in a separate packet.

2.7 版改变： message_body 被添加。

HTTPConnection. send ( data ) ¶: Send data to the server. This should be used directly only after the endheaders() method has been called and before getresponse() 被调用。

20.7.2. HTTPResponse 对象 ¶

HTTPResponse 实例拥有下列方法和属性：

HTTPResponse. read ( [ amt ] ) ¶: Reads and returns the response body, or up to the next amt 字节。

HTTPResponse. getheader ( 名称 [ , default ] ) ¶: Get the contents of the header name ，或 default if there is no matching header.

HTTPResponse. getheaders ( ) ¶

Return a list of (header, value) tuples.

2.4 版新增。

HTTPResponse. fileno ( ) ¶: 返回 fileno of the underlying socket.

HTTPResponse. msg ¶: A mimetools.Message instance containing the response headers.

HTTPResponse. version ¶: HTTP protocol version used by server. 10 for HTTP/1.0, 11 for HTTP/1.1.

HTTPResponse. status ¶: 由服务器返回的状态码。

HTTPResponse. reason ¶: Reason phrase returned by server.

20.7.3. 范例 ¶

这里是范例会话使用 GET 方法：

>>> import httplib
>>> conn = httplib.HTTPSConnection("www.python.org")
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> print r1.status, r1.reason
200 OK
>>> data1 = r1.read()
>>> conn.request("GET", "/")
>>> r2 = conn.getresponse()
>>> print r2.status, r2.reason
404 Not Found
>>> data2 = r2.read()
>>> conn.close()

这里是范例会话使用 HEAD 方法。注意， HEAD 方法从不返回任何数据。

>>> import httplib
>>> conn = httplib.HTTPSConnection("www.python.org")
>>> conn.request("HEAD","/")
>>> res = conn.getresponse()
>>> print res.status, res.reason
200 OK
>>> data = res.read()
>>> print len(data)
0
>>> data == ''
True

这里是范例会话展示如何 POST 请求：

>>> import httplib, urllib
>>> params = urllib.urlencode({'@number': 12524, '@type': 'issue', '@action': 'show'})
>>> headers = {"Content-type": "application/x-www-form-urlencoded",
...            "Accept": "text/plain"}
>>> conn = httplib.HTTPConnection("bugs.python.org")
>>> conn.request("POST", "", params, headers)
>>> response = conn.getresponse()
>>> print response.status, response.reason
302 Found
>>> data = response.read()
>>> data
'Redirecting to <a href="http://bugs.python.org/issue12524">http://bugs.python.org/issue12524</a>'
>>> conn.close()

客户端侧 HTTP PUT 请求非常类似于 POST requests. The difference lies only the server side where HTTP server will allow resources to be created via PUT request. Here is an example session that shows how to do PUT request using httplib:

>>> # This creates an HTTP message
>>> # with the content of BODY as the enclosed representation
>>> # for the resource http://localhost:8080/foobar
...
>>> import httplib
>>> BODY = "***filecontents***"
>>> conn = httplib.HTTPConnection("localhost", 8080)
>>> conn.request("PUT", "/file", BODY)
>>> response = conn.getresponse()
>>> print response.status, response.reason
200, OK

20.7. httplib — HTTP 协议客户端 ¶

20.7.1. HTTPConnection 对象 ¶

20.7.2. HTTPResponse 对象 ¶

20.7.3. 范例 ¶

内容表

上一话题

下一话题

本页

快速搜索

20.7. `httplib` — HTTP 协议客户端 ¶