Paw Http Client 3 1 8

broken image


Source code:Lib/http/client.py

This module defines classes which implement the client side of the HTTP andHTTPS protocols. It is normally not used directly — the moduleurllib.request uses it to handle URLs that use HTTP and HTTPS.

HTTPie: human-friendly CLI HTTP client for the API era. HTTPie (pronounced aitch-tee-tee-pie) is a command-line HTTP client. Its goal is to make CLI interaction with web services as human-friendly as possible. HTTPie is designed for testing, debugging, and generally interacting with APIs & HTTP servers.

  • Client As of July 1, 2016 the fee for service is $17,000. Very few of our families pay for their service dog. Fundraising is completed in their communities to help raise the fee. Most of our clients carry out fundraising to cover their fee for service. Funds raised are sent to 4 Paws Headquarters in Xenia, Ohio, where money raised is deposited.
  • Paw HTTP Client 3.1.8 macOS 15Mb The most advanced API tool for Mac. Paw is a full-featured HTTP client that lets you test and describe the APIs you build or consume. It has a beautiful native macOS interface to compose requests, inspect server responses, generate client code and export API.

See also

The Requests packageis recommended for a higher-level HTTP client interface.

Note

HTTPS support is only available if Python was compiled with SSL support(through the ssl module).

The module provides the following classes:

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

An HTTPConnection instance represents one transaction with an HTTPserver. It should be instantiated passing it a host and optional portnumber. If no port number is passed, the port is extracted from the hoststring if it has the form host:port, else the default HTTP port (80) isused. If the optional timeout parameter is given, blockingoperations (like connection attempts) will timeout after that many seconds(if it is not given, the global default timeout setting is used).The optional source_address parameter may be a tuple of a (host, port)to use as the source address the HTTP connection is made from.The optional blocksize parameter sets the buffer size in bytes forsending a file-like message body.

For example, the following calls all create instances that connect to the serverat the same host and port:

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' arenot longer supported.

Changed in version 3.7: blocksize parameter was added.

class http.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 HTTPConnection that uses SSL for communication withsecure servers. Default port is 443. If context is specified, itmust be a ssl.SSLContext instance describing the various SSLoptions.

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 ssl.HAS_SNI is true).

Changed in version 3.4: The strict parameter was removed. HTTP 0.9-style 'Simple Responses' areno longer supported.

Changed in version 3.4.3: This class now performs all the necessary certificate and hostname checksby default. To revert to the previous, unverified, behaviorssl._create_unverified_context() can be passed to the contextparameter.

Changed in version 3.8: This class now enables TLS 1.3ssl.SSLContext.post_handshake_auth for the default context orwhen cert_file is passed with a custom context.

Deprecated since version 3.6: key_file and cert_file are deprecated in favor of context.Please use ssl.SSLContext.load_cert_chain() instead, or letssl.create_default_context() select the system's trusted CAcertificates for you.

The check_hostname parameter is also deprecated; thessl.SSLContext.check_hostname attribute of context shouldbe used instead.

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

Class whose instances are returned upon successful connection. Notinstantiated directly by user.

Changed in version 3.4: The strict parameter was removed. HTTP 0.9 style 'Simple Responses' areno longer supported.

This module provides the following function:

http.client.parse_headers(fp)

Parse the headers from a file pointer fp representing a HTTPrequest/response. The file has to be a BufferedIOBase reader(i.e. not text) and must provide a valid RFC 2822 style header.

This function returns an instance of http.client.HTTPMessagethat holds the header fields, but no payload(the same as HTTPResponse.msgand http.server.BaseHTTPRequestHandler.headers).After returning, the file pointer fp is ready to read the HTTP body.

Note

parse_headers() does not parse the start-line of a HTTP message;it only parses the Name:value lines. The file has to be ready toread these field lines, so the first line should already be consumedbefore calling the function.

The following exceptions are raised as appropriate:

exception http.client.HTTPException

The base class of the other exceptions in this module. It is a subclass ofException.

exception http.client.NotConnected

A subclass of HTTPException.

exception http.client.InvalidURL

A subclass of HTTPException, raised if a port is given and is eithernon-numeric or empty.

exception http.client.UnknownProtocol

A subclass of HTTPException.

exception http.client.UnknownTransferEncoding

A subclass of HTTPException.

exception http.client.UnimplementedFileMode

A subclass of HTTPException.

exception http.client.IncompleteRead

A subclass of HTTPException.

exception http.client.ImproperConnectionState

A subclass of HTTPException.

exception http.client.CannotSendRequest

A subclass of ImproperConnectionState.

exception http.client.CannotSendHeader

A subclass of ImproperConnectionState.

exception http.client.ResponseNotReady

A subclass of ImproperConnectionState.

exception http.client.BadStatusLine

A subclass of HTTPException. Raised if a server responds with a HTTPstatus code that we don't understand.

exception http.client.LineTooLong

A subclass of HTTPException. Raised if an excessively long lineis received in the HTTP protocol from the server.

exception http.client.RemoteDisconnected

A subclass of ConnectionResetError and BadStatusLine. Raisedby HTTPConnection.getresponse() when the attempt to read the responseresults in no data read from the connection, indicating that the remote endhas closed the connection.

Paw Http Client 3 1 800

New in version 3.5: Previously, BadStatusLine(') was raised.

The constants defined in this module are:

http.client.HTTP_PORT

The default port for the HTTP protocol (always 80).

http.client.HTTPS_PORT

The default port for the HTTPS protocol (always 443).

http.client.responses

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

Example: http.client.responses[http.client.NOT_FOUND] is 'NotFound'.

See HTTP status codes for a list of HTTP status codes that areavailable in this module as constants.

HTTPConnection Objects¶

HTTPConnection instances have the following methods:

HTTPConnection.request(method, url, body=None, headers={}, *, encode_chunked=False)

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

If body is specified, the specified data is sent after the headers arefinished. It may be a str, a bytes-like object, anopen file object, or an iterable of bytes. If bodyis a string, it is encoded as ISO-8859-1, the default for HTTP. If itis a bytes-like object, the bytes are sent as is. If it is a fileobject, the contents of the file is sent; this file object shouldsupport at least the read() method. If the file object is aninstance of io.TextIOBase, the data returned by the read()method will be encoded as ISO-8859-1, otherwise the data returned byread() is sent as is. If body is an iterable, the elements of theiterable are sent as is until the iterable is exhausted.

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

If headers contains neither Content-Length nor Transfer-Encoding,but there is a request body, one of thoseheader fields will be added automatically. Ifbody is None, the Content-Length header is set to 0 formethods that expect a body (PUT, POST, and PATCH). Ifbody is a string or a bytes-like object that is not also afile, the Content-Length header isset to its length. Any other type of body (filesand iterables in general) will be chunk-encoded, and theTransfer-Encoding header will automatically be set instead ofContent-Length.

The encode_chunked argument is only relevant if Transfer-Encoding isspecified in headers. If encode_chunked is False, theHTTPConnection object assumes that all encoding is handled by thecalling code. If it is True, the body will be chunk-encoded.

Note

Chunked transfer encoding has been added to the HTTP protocolversion 1.1. Unless the HTTP server is known to handle HTTP 1.1,the caller must either specify the Content-Length, or must pass astr or bytes-like object that is not also a file as thebody representation.

Paw Http Client 3 1 83

Changed in version 3.6: If neither Content-Length nor Transfer-Encoding are set inheaders, 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 fileobjects.

HTTPConnection.getresponse()

Should be called after a request is sent to get the response from the server.Returns an HTTPResponse instance.

Note

Note that you must have read the whole response before you can send a newrequest to the server.

Changed in version 3.5: If a ConnectionError or subclass is raised, theHTTPConnection object will be ready to reconnect whena new request is sent.

Paw Http Client 3 1 8
HTTPConnection.set_debuglevel(level)

Set the debugging level. The default debug level is 0, meaning nodebugging output is printed. Any value greater than 0 will cause allcurrently defined debug output to be printed to stdout. The debuglevelis passed to any new HTTPResponse objects that are created.

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

Set the host and the port for HTTP Connect Tunnelling. This allows runningthe 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 theproxy server).

The headers argument should be a mapping of extra HTTP headers to send withthe CONNECT request.

For example, to tunnel through a HTTPS proxy server running locally on port8080, we would pass the address of the proxy to the HTTPSConnectionconstructor, and the address of the host that we eventually want to reach tothe set_tunnel() method:

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 notalready have a connection.

HTTPConnection.close()

Close the connection to the server.

HTTPConnection.blocksize

Paw Http Client 3 1 8 Commentary

Buffer size in bytes for sending a file-like message body.

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

HTTPConnection.putrequest(method, url, skip_host=False, skip_accept_encoding=False)

This should be the first call after the connection to the server has beenmade. It sends a line to the server consisting of the method string,the url string, and the HTTP version (HTTP/1.1). To disable automaticsending of Host: or Accept-Encoding: headers (for example to acceptadditional content encodings), specify skip_host or skip_accept_encodingwith non-False values.

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

Send an RFC 822-style header to the server. It sends a line to the serverconsisting of the header, a colon and a space, and the first argument. If morearguments are given, continuation lines are sent, each consisting of a tab andan argument.

HTTPConnection.endheaders(message_body=None, *, encode_chunked=False)

Send a blank line to the server, signalling the end of the headers. Theoptional message_body argument can be used to pass a message bodyassociated with the request.

If encode_chunked is True, the result of each iteration ofmessage_body will be chunk-encoded as specified in RFC 7230,Section 3.3.1. How the data is encoded is dependent on the type ofmessage_body. If message_body implements the buffer interface the encoding will result in a single chunk.If message_body is a collections.abc.Iterable, each iterationof message_body will result in a chunk. If message_body is afile object, each call to .read() will result in a chunk.The method automatically signals the end of the chunk-encoded dataimmediately after message_body.

Note

Due to the chunked encoding specification, empty chunksyielded by an iterator body will be ignored by the chunk-encoder.This is to avoid premature termination of the read of the request bythe target server due to malformed encoding.

New in version 3.6: Chunked encoding support. The encode_chunked parameter wasadded.

HTTPConnection.send(data)

Send data to the server. This should be used directly only after theendheaders() method has been called and before getresponse() iscalled.

HTTPResponse Objects¶

An HTTPResponse instance wraps the HTTP response from theserver. It provides access to the request headers and the entitybody. The response is an iterable object and can be used in a withstatement.

Changed in version 3.5: The io.BufferedIOBase interface is now implemented andall of its reader operations are supported.

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.

HTTPResponse.getheader(name, default=None)

Return the value of the header name, or default if there is no headermatching name. If there is more than one header with the name name,return all of the values joined by ‘, ‘. If ‘default' is any iterable otherthan a single string, its elements are similarly returned joined by commas.

HTTPResponse.getheaders()

Return a list of (header, value) tuples.

HTTPResponse.fileno()

Return the fileno of the underlying socket.

HTTPResponse.msg

A http.client.HTTPMessage instance containing the responseheaders. http.client.HTTPMessage is a subclass ofemail.message.Message.

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.

HTTPResponse.headers

Headers of the response in the form of an email.message.EmailMessage instance.

HTTPResponse.status

Status code returned by server.

HTTPResponse.reason

Reason phrase returned by server.

HTTPResponse.debuglevel

A debugging hook. If debuglevel is greater than zero, messageswill be printed to stdout as the response is read and parsed.

HTTPResponse.closed

Is True if the stream is closed.

HTTPResponse.geturl()

Deprecated since version 3.9: Deprecated in favor of url.

HTTPResponse.info()

Deprecated since version 3.9: Deprecated in favor of headers.

HTTPResponse.getstatus()

Deprecated since version 3.9: Deprecated in favor of status.

Examples¶

Here is an example session that uses the GET method:

Here is an example session that uses the HEAD method. Note that theHEAD method never returns any data.

Paw Http Client 3 1 8t

Here is an example session that shows how to POST requests:

3/1 Usmc

Client side HTTPPUT requests are very similar to POST requests. Thedifference lies only the server side where HTTP server will allow resources tobe created via PUT request. It should be noted that custom HTTP methodsare also handled in urllib.request.Request by setting the appropriatemethod attribute. Here is an example session that shows how to send a PUTrequest using http.client:

HTTPMessage Objects¶

An http.client.HTTPMessage instance holds the headers from an HTTPresponse. It is implemented using the email.message.Message class.





broken image