21.12. `http.client` — HTTP 协议客户端 ¶

源代码： Lib/http/client.py

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

另请参阅

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

注意

HTTPS support is only available if Python was compiled with SSL support (through the ssl 模块)。

模块提供下列类：

class http.client. HTTPConnection ( host , port=None , [ timeout , ] source_address=None ) ¶

class http.client. HTTPSConnection ( host , port=None , key_file=None , cert_file=None , [ timeout , ] source_address=None , * , context=None , check_hostname=None ) ¶

class http.client. HTTPResponse ( sock , debuglevel=0 , method=None , url=None ) ¶

The following exceptions are raised as appropriate:

exception http.client. HTTPException ¶

exception http.client. NotConnected ¶

exception http.client. InvalidURL ¶

exception http.client. UnknownProtocol ¶

exception http.client. UnknownTransferEncoding ¶

exception http.client. UnimplementedFileMode ¶

exception http.client. IncompleteRead ¶

exception http.client. ImproperConnectionState ¶

exception http.client. CannotSendRequest ¶

exception http.client. CannotSendHeader ¶

exception http.client. ResponseNotReady ¶

exception http.client. BadStatusLine ¶

exception http.client. LineTooLong ¶

exception http.client. RemoteDisconnected ¶

此模块中定义的常量：

http.client. HTTP_PORT ¶

http.client. HTTPS_PORT ¶

http.client. responses ¶

This dictionary maps the HTTP 1.1 status codes to the W3C names.

范例： http.client.responses[http.client.NOT_FOUND] is 'Not Found' .

见 HTTP 状态码 for a list of HTTP status codes that are available in this module as constants.

21.12.1. HTTPConnection 对象 ¶

HTTPConnection 实例具有下列方法：

HTTPConnection. request ( 方法 , url , body=None , headers={} ) ¶

This will send a request to the server using the HTTP request method 方法 and the selector url .

若 body is specified, the specified data is sent after the headers are finished. It may be a string, a 像字节对象 , an open 文件对象 , or an iterable of 像字节对象 s. If body is a string, it is encoded as ISO-8859-1, the default for HTTP. If it is a bytes-like object the bytes are sent as is. If it is a 文件对象 , the contents of the file is sent; this file object should support at least the read() method. If the file object has a mode attribute, the data returned by the read() method will be encoded as ISO-8859-1 unless the mode attribute contains the substring b , otherwise the data returned by read() is sent as is. If body is an iterable, the elements of the iterable are sent as is until the iterable is exhausted.

The headers argument should be a mapping of extra HTTP headers to send with the request.

若 headers does not contain a Content-Length item, one is added automatically if possible. If body is None , the Content-Length header is set to 0 for methods that expect a body ( PUT , POST ，和 PATCH )。若 body is a string or bytes object, the Content-Length header is set to its length. If body 是文件对象 and it works to call fstat() on the result of its fileno() method, then the Content-Length header is set to the st_size reported by the fstat call. Otherwise no Content-Length header is added.

3.2 版新增： body can now be an iterable.

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 ( 方法 , url , skip_host=False , skip_accept_encoding=False ) ¶: 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 方法 string, the url 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.

HTTPConnection. putheader ( header , argument [ , ... ] ) ¶: 发送 RFC 822 -style header to the server. It sends a line to the server consisting of the header, a colon and a space, and the first argument. If more arguments are given, continuation lines are sent, each consisting of a tab and an 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.

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

21.12.2. HTTPResponse 对象 ¶

An HTTPResponse instance wraps the HTTP response from the server. It provides access to the request headers and the entity body. The response is an iterable object and can be used in a with statement.

3.5 版改变： The io.BufferedIOBase interface is now implemented and all of its reader operations are supported.

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

HTTPResponse. readinto ( b ) ¶

Reads up to the next len(b) bytes of the response body into the buffer b . Returns the number of bytes read.

3.3 版新增。

HTTPResponse. getheader ( name , default=None ) ¶: Return the value of the header name ，或 default if there is no header matching name . If there is more than one header with the name name , return all of the values joined by ‘, ‘. If ‘default’ is any iterable other than a single string, its elements are similarly returned joined by commas.

HTTPResponse. getheaders ( ) ¶: Return a list of (header, value) tuples.

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

HTTPResponse. msg ¶: A http.client.HTTPMessage instance containing the response headers. http.client.HTTPMessage 是子类化的 email.message.Message .

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.

HTTPResponse. debuglevel ¶: A debugging hook. If debuglevel is greater than zero, messages will be printed to stdout as the response is read and parsed.

HTTPResponse. closed ¶: Is True 若流被关闭。

21.12.3. 范例 ¶

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

>>> import http.client
>>> conn = http.client.HTTPSConnection("www.python.org")
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> print(r1.status, r1.reason)
200 OK
>>> data1 = r1.read()  # This will return entire content.
>>> # The following example demonstrates reading data in chunks.
>>> conn.request("GET", "/")
>>> r1 = conn.getresponse()
>>> while not r1.closed:
...     print(r1.read(200))  # 200 bytes
b'<!doctype html>\n<!--[if"...
...
>>> # Example of an invalid request
>>> conn.request("GET", "/parrot.spam")
>>> r2 = conn.getresponse()
>>> print(r2.status, r2.reason)
404 Not Found
>>> data2 = r2.read()
>>> conn.close()

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

>>> import http.client
>>> conn = http.client.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 == b''
True

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

>>> import http.client, urllib.parse
>>> params = urllib.parse.urlencode({'@number': 12524, '@type': 'issue', '@action': 'show'})
>>> headers = {"Content-type": "application/x-www-form-urlencoded",
...            "Accept": "text/plain"}
>>> conn = http.client.HTTPConnection("bugs.python.org")
>>> conn.request("POST", "", params, headers)
>>> response = conn.getresponse()
>>> print(response.status, response.reason)
302 Found
>>> data = response.read()
>>> data
b'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. It should be noted that custom HTTP methods +are also handled in urllib.request.Request by sending the appropriate +method attribute.Here is an example session that shows how to do PUT request using http.client:

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

21.12.4. HTTPMessage 对象 ¶

An http.client.HTTPMessage instance holds the headers from an HTTP response. It is implemented using the email.message.Message 类。

21.12. http.client — HTTP 协议客户端 ¶

21.12.1. HTTPConnection 对象 ¶

21.12.2. HTTPResponse 对象 ¶

21.12.3. 范例 ¶

21.12.4. HTTPMessage 对象 ¶

内容表

上一话题

下一话题

本页

21.12. `http.client` — HTTP 协议客户端 ¶