Source code: Lib/http/client.py Show This module defines classes which implement the client side of the HTTP and HTTPS protocols. It is normally not used directly — the module
See also The Requests package is recommended for a higher-level HTTP client interface. Note HTTPS support is only available if Python was compiled with SSL support
(through the The module provides the following classes: classhttp.client. HTTPConnection (host, port=None, [timeout, ]source_address=None,
blocksize=8192)¶An For example, the following calls all create instances that connect to the server at the same host and port: >>> h2 = http.client.HTTPConnection('www.python.org') >>> h2 = http.client.HTTPConnection('www.python.org:80') >>> h3 = http.client.HTTPConnection('www.python.org', 80) >>> h4 = http.client.HTTPConnection('www.python.org', 80, timeout=10) Changed in version 3.2: source_address was added. Changed in version 3.4: The strict parameter was removed. HTTP 0.9-style “Simple Responses” are not longer supported. Changed in version 3.7: blocksize parameter was added. classhttp.client. HTTPSConnection (host, port=None, key_file=None, cert_file=None, [timeout, ]source_address=None, *, context=None, check_hostname=None,
blocksize=8192)¶A subclass of Please read Security considerations for more information on best practices. Changed in version 3.2: source_address, context and check_hostname were added. Changed in
version 3.2: This class now supports HTTPS virtual hosts if possible (that is, if Changed in version 3.4: The strict parameter was removed. HTTP 0.9-style “Simple Responses” are no longer supported. Changed in version 3.4.3: This class now performs all the necessary certificate and hostname checks by default. To revert
to the previous, unverified, behavior Changed in version 3.8: This class now enables TLS 1.3 Changed in version 3.10: This class now sends an
ALPN extension with protocol indicator http.client. HTTPResponse (sock, debuglevel=0, method=None,
url=None)¶Class whose instances are returned upon successful connection. Not instantiated directly by user. Changed in version 3.4: The strict parameter was removed. HTTP 0.9 style “Simple Responses” are no longer supported. This module provides the following function: Parse the headers from a file pointer fp representing a HTTP request/response. The file has to be a This function returns an instance of Note
The following exceptions are raised as appropriate: exceptionhttp.client. HTTPException ¶The base class of the other exceptions in this module. It is a subclass of http.client. NotConnected ¶A subclass of http.client. InvalidURL ¶A subclass of http.client. UnknownProtocol ¶A subclass of http.client. UnknownTransferEncoding ¶A subclass of http.client. UnimplementedFileMode ¶A subclass of http.client. IncompleteRead ¶A subclass of http.client. ImproperConnectionState ¶A subclass of http.client. CannotSendRequest ¶A subclass of A subclass of
http.client. ResponseNotReady ¶A subclass of
http.client. BadStatusLine ¶A subclass of
http.client. LineTooLong ¶A subclass of
http.client. RemoteDisconnected ¶A
subclass of New in version 3.5: Previously, The constants defined in this module are: http.client. HTTP_PORT ¶The default port for the HTTP protocol (always http.client. HTTPS_PORT ¶The default port for
the HTTPS protocol (always http.client. responses ¶This dictionary maps the HTTP 1.1 status codes to the W3C names. Example: See HTTP status codes for a list of HTTP status codes that are available in this module as constants. HTTPConnection Objects¶
HTTPConnection. request (method, url, body=None, headers={}, *,
encode_chunked=False)¶This will send a request to the server using the HTTP request method method and the selector url. If body is specified, the specified data is sent after the headers are finished. It may be a
The headers argument should be a mapping of extra HTTP headers to send with the request. If headers contains neither Content-Length nor Transfer-Encoding, but there is a request body, one of those header fields will be added automatically. If
body is The encode_chunked argument is only relevant if Transfer-Encoding is specified in headers. If encode_chunked is Note Chunked transfer encoding has been added to the HTTP protocol version 1.1. Unless the HTTP server is known to handle HTTP 1.1, the caller
must either specify the Content-Length, or must pass a New in version 3.2: body can now be an iterable. Changed in version 3.6: If neither Content-Length nor Transfer-Encoding are set in headers, file and iterable body objects are now chunk-encoded. The encode_chunked argument was added. No attempt is made to determine the Content-Length for file objects. HTTPConnection. getresponse ()¶Should be called after a request is sent to get the response from the server. Returns an
Note Note that you must have read the whole response before you can send a new request to the server. Changed in version 3.5: If a HTTPConnection. set_debuglevel (level)¶Set the debugging level. The default debug level is New in version 3.1. HTTPConnection. set_tunnel (host, port=None,
headers=None)¶Set the host and the port for HTTP Connect Tunnelling. This allows running the connection through a proxy server. The host and port arguments specify the endpoint of the tunneled connection (i.e. the address included in the CONNECT request, not the address of the proxy server). The headers argument should be a mapping of extra HTTP headers to send with the CONNECT request. For example, to tunnel through a HTTPS proxy server running locally on port 8080, we would pass the address of the proxy to the >>> import http.client >>> conn = http.client.HTTPSConnection("localhost", 8080) >>> conn.set_tunnel("www.python.org") >>> conn.request("HEAD","/index.html") New in version 3.2. HTTPConnection. connect ()¶Connect to the server specified when the object was created. By default, this is called automatically when making a request if the client does not already have a connection. Raises an
auditing event HTTPConnection. close ()¶Close the connection to the server. HTTPConnection. blocksize ¶Buffer size in bytes for sending a file-like message body. New in version 3.7. As an alternative to using the HTTPConnection. putrequest (method, 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 method string, the url string, and the HTTP version ( Send an 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. 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. If encode_chunked is Note Due to the chunked encoding specification, empty chunks yielded by an iterator body will be ignored by the chunk-encoder. This is to avoid premature termination of the read of the request by the target server due to malformed encoding. New in version 3.6: Chunked encoding support. The encode_chunked parameter was added. HTTPConnection. send (data)¶Send data to the server. This should be used directly only
after the Raises an
auditing event HTTPResponse Objects¶An
Changed in version 3.5: The
HTTPResponse. read ([amt])¶Reads and returns the response body, or up to the next amt bytes. 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. New in version 3.3. Return the value of the header name, or 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. Return a list of (header, value) tuples. HTTPResponse. fileno ()¶Return the HTTPResponse. msg ¶A HTTPResponse. version ¶HTTP protocol version used by server. 10 for HTTP/1.0, 11 for HTTP/1.1. HTTPResponse. url ¶
URL of the resource retrieved, commonly used to determine if a redirect was followed. Headers of the response in the form of an HTTPResponse. status ¶Status code returned by server. HTTPResponse. reason ¶Reason phrase returned by server. HTTPResponse. debuglevel ¶A debugging hook. If HTTPResponse. closed ¶Is HTTPResponse. geturl ()¶Deprecated since version 3.9: Deprecated in favor of HTTPResponse. info ()¶Deprecated since version 3.9: Deprecated in favor of HTTPResponse. getstatus ()¶Deprecated since version 3.9: Deprecated in favor of Examples¶Here is an example session that uses the >>> 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 chunk := r1.read(200): ... print(repr(chunk)) b'<!doctype html>\n<!--[if"... ... >>> # Example of an invalid request >>> conn = http.client.HTTPSConnection("docs.python.org") >>> conn.request("GET", "/parrot.spam") >>> r2 = conn.getresponse() >>> print(r2.status, r2.reason) 404 Not Found >>> data2 = r2.read() >>> conn.close() Here is an example session that uses the >>> 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 Here is an example session that shows how to >>> 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="https://bugs.python.org/issue12524">https://bugs.python.org/issue12524</a>' >>> conn.close() Client side
>>> # 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 HTTPMessage Objects¶An How do I print the body of API response in Python?Simple use requests. get() method to get all body content and use response. json() to get JSON data.
How do you get a response from a Python request?When one makes a request to a URI, it returns a response. This Response object in terms of python is returned by requests. method(), method being – get, post, put, etc.
What does Response json () do Python?json() returns a JSON object of the result (if the result was written in JSON format, if not it raises an error). Python requests are generally used to fetch the content from a particular resource URI. Whenever we make a request to a specified URI through Python, it returns a response object.
What type of object is returned by requests get ()?Answer: The requests. get() returns a Response object, which has a text attribute that contains the downloaded content as a string.
|