twisted.web.client.HTTPClientFactory

class documentation

class HTTPClientFactory(protocol.ClientFactory): (source)

Known subclasses: twisted.web.client.HTTPDownloader

Download a given URL.

Method	`__init__`	Undocumented
Method	`__repr__`	Undocumented
Method	`buildProtocol`	Create an instance of a subclass of Protocol.
Method	`clientConnectionFailed`	When a connection attempt fails, the request cannot be issued. If no result has yet been provided to the result Deferred, provide the connection failure reason as an error result.
Method	`gotHeaders`	Parse the response HTTP headers.
Method	`gotStatus`	Set the status of the request on us.
Method	`noPage`	Undocumented
Method	`page`	Undocumented
Method	`setURL`	Undocumented
Instance Variable	`afterFoundGet`	Deviate from the HTTP 1.1 RFC by handling redirects the same way as most web browsers; if the request method is POST and a 302 status is encountered, the redirect is followed with a GET method
Instance Variable	`agent`	Undocumented
Instance Variable	`cookies`	Undocumented
Instance Variable	`deferred`	A Deferred that will fire when the content has been retrieved. Once this is fired, the ivars `status', `version', and `message' will be set.
Instance Variable	`followRedirect`	Undocumented
Instance Variable	`headers`	Undocumented
Instance Variable	`host`	Undocumented
Instance Variable	`message`	The text message returned with the status.
Instance Variable	`method`	The HTTP method to use in the request. This should be one of OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, or CONNECT (case matters). Other values may be specified if the server being contacted supports them.
Instance Variable	`path`	Undocumented
Instance Variable	`port`	Undocumented
Instance Variable	`postdata`	Undocumented
Instance Variable	`redirectLimit`	The maximum number of HTTP redirects that can occur before it is assumed that the redirection is endless.
Instance Variable	`response_headers`	The headers that were specified in the response from the server.
Instance Variable	`scheme`	Undocumented
Instance Variable	`status`	The status of the response.
Instance Variable	`timeout`	Undocumented
Instance Variable	`url`	Undocumented
Instance Variable	`version`	The version of the response.
Instance Variable	`waiting`	Undocumented
Method	`_cancelTimeout`	Undocumented
Method	`_waitForDisconnect`	Chain onto the _disconnectedDeferred, preserving `passthrough`, so that the result is only available after the associated connection has been closed.
Instance Variable	`_disconnectedDeferred`	A `Deferred` which only fires after the last connection associated with the request (redirects may cause multiple connections to be required) has closed. The result Deferred will only fire after this Deferred, so that callers can be assured that there are no more event sources in the reactor once they get the result.
Instance Variable	`_redirectCount`	The current number of HTTP redirects encountered.

Inherited from ClientFactory:

Method	`clientConnectionLost`	Called when an established connection is lost.
Method	`startedConnecting`	Called when a connection has been started.

Inherited from Factory (via ClientFactory):

Class Method	`forProtocol`	Create a factory for the given protocol.
Method	`doStart`	Make sure startFactory is called.
Method	`doStop`	Make sure stopFactory is called.
Method	`logPrefix`	Describe this factory for log messages.
Method	`startFactory`	This will be called before I begin listening on a Port or Connector.
Method	`stopFactory`	This will be called before I stop listening on all Ports/Connectors.
Class Variable	`noisy`	Undocumented
Class Variable	`protocol`	Undocumented
Instance Variable	`numPorts`	Undocumented

def __init__(self, url, method=b'GET', postdata=None, headers=None, agent=b'Twisted PageGetter', timeout=0, cookies=None, followRedirect=True, redirectLimit=20, afterFoundGet=False): (source)

overridden in twisted.web.client.HTTPDownloader

Undocumented

def __repr__(self): (source)

Undocumented

Returns
`str`	Undocumented

def buildProtocol(self, addr): (source)

from twisted.internet.interfaces.IProtocolFactory

overrides twisted.internet.protocol.Factory.buildProtocol

Create an instance of a subclass of Protocol.

The returned instance will handle input on an incoming server connection, and an attribute "factory" pointing to the creating factory.

Alternatively, None may be returned to immediately close the new connection.

Override this method to alter how Protocol instances get created.

Parameters
addr	an object implementing `twisted.internet.interfaces.IAddress`

def clientConnectionFailed(self, _, reason): (source)

overrides twisted.internet.protocol.ClientFactory.clientConnectionFailed

When a connection attempt fails, the request cannot be issued. If no result has yet been provided to the result Deferred, provide the connection failure reason as an error result.

def gotHeaders(self, headers): (source)

overridden in twisted.web.client.HTTPDownloader

Parse the response HTTP headers.

Parameters
headers:`dict`	The response HTTP headers.

def gotStatus(self, version, status, message): (source)

Set the status of the request on us.

Parameters
version:`bytes`	The HTTP version.
status:`bytes`	The HTTP status code, an integer represented as a bytestring.
message:`bytes`	The HTTP status message.

def noPage(self, reason): (source)

overridden in twisted.web.client.HTTPDownloader

Undocumented

def page(self, page): (source)

Undocumented

def setURL(self, url): (source)

Undocumented

afterFoundGet: bool = (source)

Deviate from the HTTP 1.1 RFC by handling redirects the same way as most web browsers; if the request method is POST and a 302 status is encountered, the redirect is followed with a GET method

agent = (source)

Undocumented

cookies = (source)

Undocumented

deferred: Deferred = (source)

A Deferred that will fire when the content has been retrieved. Once this is fired, the ivars `status', `version', and `message' will be set.

followRedirect = (source)

Undocumented

headers = (source)

Undocumented

host = (source)

Undocumented

message: bytes = (source)

The text message returned with the status.

method: bytes = (source)

The HTTP method to use in the request. This should be one of OPTIONS, GET, HEAD, POST, PUT, DELETE, TRACE, or CONNECT (case matters). Other values may be specified if the server being contacted supports them.

path = (source)

Undocumented

port = (source)

Undocumented

postdata = (source)

Undocumented

redirectLimit: int = (source)

The maximum number of HTTP redirects that can occur before it is assumed that the redirection is endless.

response_headers: dict = (source)

The headers that were specified in the response from the server.

scheme = (source)

Undocumented

status: bytes = (source)

The status of the response.

timeout = (source)

Undocumented

url = (source)

Undocumented

version: bytes = (source)

The version of the response.

waiting: int = (source)

overridden in twisted.web.client.HTTPDownloader

Undocumented

def _cancelTimeout(self, result, timeoutCall): (source)

Undocumented

def _waitForDisconnect(self, passthrough): (source)

Chain onto the _disconnectedDeferred, preserving passthrough, so that the result is only available after the associated connection has been closed.

_disconnectedDeferred = (source)

A Deferred which only fires after the last connection associated with the request (redirects may cause multiple connections to be required) has closed. The result Deferred will only fire after this Deferred, so that callers can be assured that there are no more event sources in the reactor once they get the result.

_redirectCount: int = (source)

The current number of HTTP redirects encountered.