twisted.web._newclient.Request : API documentation

class documentation

class twisted.web._newclient.Request: (source)

Implements interfaces: twisted.web.iweb.IClientRequest

A Request instance describes an HTTP request to be sent to an HTTP server.

Instance Variable	method	The HTTP method for this request, as `bytes`. For example: `b'GET'`, `b'HEAD'`, `b'POST'`, etc.
Instance Variable	uri	See `__init__`.
Instance Variable	headers	Headers to be sent to the server, as a `twisted.web.http_headers.Headers` instance.
Instance Variable	bodyProducer	See `__init__`.
Instance Variable	persistent	See `__init__`.
Method	__init__
Property	absoluteURI	The absolute URI of the request as `bytes`, or `None` if the absolute URI cannot be determined.
Method	writeTo	Format this `Request` as an HTTP/1.1 request and write it to the given transport. If bodyProducer is not None, it will be associated with an `IConsumer`.
Method	stopWriting	No summary
Instance Variable	_parsedURI	Parsed URI for the request, or `None`.
Class Variable	_log	Undocumented
Class Method	_construct	Private constructor.
Method	_writeHeaders	Undocumented
Method	_writeToBodyProducerChunked	Write this request to the given transport using chunked transfer-encoding to frame the body.
Method	_writeToBodyProducerContentLength	Write this request to the given transport using content-length to frame the body.
Method	_writeToEmptyBodyContentLength	Write this request to the given transport using content-length to frame the (empty) body.

method = (source)

from twisted.web.iweb.IClientRequest

See __init__.

uri = (source)

See __init__.

headers = (source)

from twisted.web.iweb.IClientRequest

See __init__.

bodyProducer = (source)

See __init__.

persistent = (source)

See __init__.

_parsedURI = (source)

Parsed URI for the request, or None.

(type: twisted.web.client.URI or None)

_log = (source)

Undocumented

def __init__(self, method, uri, headers, bodyProducer, persistent=False): (source)

Parameters	method	The HTTP method for this request, ex: b'GET', b'HEAD', b'POST', etc. (type: `bytes`)
	uri	The relative URI of the resource to request. For example, `b'/foo/bar?baz=quux'`. (type: `bytes`)
	headers	Headers to be sent to the server. It is important to note that this object does not create any implicit headers. So it is up to the HTTP Client to add required headers such as 'Host'. (type: `twisted.web.http_headers.Headers`)
	bodyProducer	`None` or an `IBodyProducer` provider which produces the content body to send to the remote HTTP server.
	persistent	Set to `True` when you use HTTP persistent connection, defaults to `False`. (type: `bool`)

@classmethod
def _construct(cls, method, uri, headers, bodyProducer, persistent=False, parsedURI=None): (source)

Private constructor.

Parameters	method	See `__init__`.
	uri	See `__init__`.
	headers	See `__init__`.
	bodyProducer	See `__init__`.
	persistent	See `__init__`.
	parsedURI	See `Request._parsedURI`.
Returns	`Request` instance.

@property
absoluteURI = (source)

from twisted.web.iweb.IClientRequest

The absolute URI of the request as bytes, or None if the absolute URI cannot be determined.

def _writeHeaders(self, transport, TEorCL): (source)

Undocumented

def _writeToBodyProducerChunked(self, transport): (source)

Write this request to the given transport using chunked transfer-encoding to frame the body.

Parameters	transport	See `writeTo`.
Returns	See `writeTo`.

def _writeToBodyProducerContentLength(self, transport): (source)

Write this request to the given transport using content-length to frame the body.

Parameters	transport	See `writeTo`.
Returns	See `writeTo`.

def _writeToEmptyBodyContentLength(self, transport): (source)

Write this request to the given transport using content-length to frame the (empty) body.

Parameters	transport	See `writeTo`.
Returns	See `writeTo`.

def writeTo(self, transport): (source)

Format this Request as an HTTP/1.1 request and write it to the given transport. If bodyProducer is not None, it will be associated with an IConsumer.

Parameters	transport	The transport to which to write. (type: `twisted.internet.interfaces.ITransport` provider)
Returns	A `Deferred` which fires with `None` when the request has been completely written to the transport or with a `Failure` if there is any problem generating the request bytes.

def stopWriting(self): (source)

Stop writing this request to the transport. This can only be called after writeTo and before the Deferred returned by writeTo fires. It should cancel any asynchronous task started by writeTo. The Deferred returned by writeTo need not be fired if this method is called.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.