twisted.web._newclient

module documentation
(source)

An HTTP 1.1 client.

The way to use the functionality provided by this module is to:

Various other classes in this module support this usage:

  • HTTPParser is the basic HTTP parser. It can handle the parts of HTTP which are symmetric between requests and responses.
  • HTTPClientParser extends HTTPParser to handle response-specific parts of HTTP. One instance is created for each request to parse the corresponding response.
Class ChunkedEncoder Helper object which exposes IConsumer on top of HTTP11ClientProtocol for streaming request bodies to the server.
Class HTTP11ClientProtocol HTTP11ClientProtocol is an implementation of the HTTP 1.1 client protocol. It supports as few features as possible.
Class HTTPClientParser An HTTP parser which only handles HTTP responses.
Class HTTPParser HTTPParser handles the parsing side of HTTP processing. With a suitable subclass, it can parse either the client side or the server side of the connection.
Class LengthEnforcingConsumer An IConsumer proxy which enforces an exact length requirement on the total data written to it.
Class Request A Request instance describes an HTTP request to be sent to an HTTP server.
Class TransportProxyProducer An twisted.internet.interfaces.IPushProducer implementation which wraps another such thing and proxies calls to it until it is told to stop.
Exception BadHeaders Headers passed to Request were in some way invalid.
Exception BadResponseVersion The version string in a status line was unparsable.
Exception ConnectionAborted The connection was explicitly aborted by application code.
Exception ExcessWrite The body IBodyProducer for a request tried to write data after indicating it had finished writing data.
Exception ParseError Some received data could not be parsed.
Exception RequestNotSent RequestNotSent indicates that an attempt was made to issue a request but for reasons unrelated to the details of the request itself, the request could not be sent. For example, this may indicate that an attempt was made to send a request using a protocol which is no longer connected to a server.
Exception WrongBodyLength An IBodyProducer declared the number of bytes it was going to produce (via its length attribute) and then produced a different number of bytes.
Function makeStatefulDispatcher Given a dispatch name and a function, return a function which can be used as a method and which, when called, will call another method defined on the instance and return the result. The other method which is called is determined by the value of the ...
Constant BODY Undocumented
Constant DONE Undocumented
Constant HEADER Undocumented
Constant STATUS Undocumented
Exception _WrapperException _WrapperException is the base exception type for exceptions which include one or more other exceptions as the low-level causes.
Function _contentLength Parse the I{Content-Length} connection header.
Function _ensureValidMethod An HTTP method is an HTTP token, which consists of any visible ASCII character that is not a delimiter (i.e. one of "(),/:;<=>?@[\]{}.)
Function _ensureValidURI A valid URI cannot contain control characters (i.e., characters between 0-32, inclusive and 127) or non-ASCII characters (i.e., characters with values between 128-255, inclusive).
Constant _VALID_URI Undocumented
Variable _ClientRequestProxy Undocumented
Variable _ignoreDecoderErrors Undocumented
Variable _ignoreStopProducerStopWriting Undocumented
Variable _ignoreStopProducerWrite Undocumented
Variable _moduleLog Undocumented
def makeStatefulDispatcher(name, template): (source)

Given a dispatch name and a function, return a function which can be used as a method and which, when called, will call another method defined on the instance and return the result. The other method which is called is determined by the value of the _state attribute of the instance.

Parameters
nameA string which is used to construct the name of the subsidiary method to invoke. The subsidiary method is named like '_%s_%s' % (name, _state).
templateA function object which is used to give the returned function a docstring.
Returns
The dispatcher function.
BODY: str = (source)

Undocumented

Value
'BODY'
DONE: str = (source)

Undocumented

Value
'DONE'
HEADER: str = (source)

Undocumented

Value
'HEADER'
STATUS: str = (source)

Undocumented

Value
'STATUS'
def _contentLength(connHeaders: Headers) -> Optional[int]: (source)

Parse the I{Content-Length} connection header. Two forms of duplicates are permitted. Header repetition: Content-Length: 42 Content-Length: 42 And field value repetition: Content-Length: 42, 42 Duplicates are only permitted if they have the same decimal value (so C{7, 007} are also permitted). @param connHeaders: Connection headers per L{HTTPParser.connHeaders} @returns: A non-negative number of octets, or L{None} when there is no I{Content-Length} header. @raises ValueError: when there are conflicting headers, a header value isn't an integer, or a header value is negative. @see: U{https://datatracker.ietf.org/doc/html/rfc9110#section-8.6}

def _ensureValidMethod(method): (source)

An HTTP method is an HTTP token, which consists of any visible ASCII character that is not a delimiter (i.e. one of "(),/:;<=>?@[\]{}.)

Parameters
method:bytesthe method to check
Returns
bytesthe method if it is valid
Raises
ValueErrorif the method is not valid
See Also
https://tools.ietf.org/html/rfc7230#section-3.1.1, https://tools.ietf.org/html/rfc7230#section-3.2.6, https://tools.ietf.org/html/rfc5234#appendix-B.1
def _ensureValidURI(uri): (source)

A valid URI cannot contain control characters (i.e., characters between 0-32, inclusive and 127) or non-ASCII characters (i.e., characters with values between 128-255, inclusive).

Parameters
uri:bytesthe URI to check
Returns
bytesthe URI if it is valid
Raises
ValueErrorif the URI is not valid
See Also
https://tools.ietf.org/html/rfc3986#section-3.3, https://tools.ietf.org/html/rfc3986#appendix-A, https://tools.ietf.org/html/rfc5234#appendix-B.1
_VALID_URI = (source)

Undocumented

Value
re.compile(rb'\A[!-~]+\Z')
_ClientRequestProxy = (source)

Undocumented

_ignoreDecoderErrors = (source)

Undocumented

_ignoreStopProducerStopWriting = (source)

Undocumented

_ignoreStopProducerWrite = (source)

Undocumented

_moduleLog = (source)

Undocumented