twisted.web.client.HTTPClientFactory(protocol.ClientFactory) class documentation

Part of twisted.web.client View Source (View In Hierarchy)

Known subclasses: twisted.web.client.HTTPDownloader

Download a given URL.

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. (type: Deferred)
Instance Variable status The status of the response. (type: bytes)
Instance Variable version The version of the response. (type: bytes)
Instance Variable message The text message returned with the status. (type: bytes)
Instance Variable response_headers The headers that were specified in the response from the server. (type: dict)
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. (type: bytes)
Instance Variable redirectLimit The maximum number of HTTP redirects that can occur before it is assumed that the redirection is endless. (type: int)
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 (type: bool)
Method __init__ Undocumented
Method __repr__ Undocumented
Method setURL Undocumented
Method buildProtocol Create an instance of a subclass of Protocol.
Method gotHeaders Parse the response HTTP headers.
Method gotStatus Set the status of the request on us.
Method page Undocumented
Method noPage Undocumented
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.
Instance Variable _redirectCount The current number of HTTP redirects encountered. (type: int)
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.
Method _waitForDisconnect Chain onto the _disconnectedDeferred, preserving passthrough, so that the result is only available after the associated connection has been closed.
Method _cancelTimeout Undocumented

Inherited from ClientFactory:

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

Inherited from Factory (via ClientFactory):

Class Method forProtocol Create a factory for the given protocol.
Method logPrefix Describe this factory for log messages.
Method doStart Make sure startFactory is called.
Method doStop Make sure stopFactory is called.
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.
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. (type: Deferred)
status =
The status of the response. (type: bytes)
version =
The version of the response. (type: bytes)
message =
The text message returned with the status. (type: bytes)
response_headers =
The headers that were specified in the response from the server. (type: dict)
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. (type: bytes)
redirectLimit =
The maximum number of HTTP redirects that can occur before it is assumed that the redirection is endless. (type: int)
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 (type: bool)
_redirectCount =
The current number of HTTP redirects encountered. (type: int)
_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.
def __init__(self, url, method='GET', postdata=None, headers=None, agent='Twisted PageGetter', timeout=0, cookies=None, followRedirect=True, redirectLimit=20, afterFoundGet=False): (source)
overridden in twisted.web.client.HTTPDownloader
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.

def __repr__(self): (source)
Undocumented
def setURL(self, url): (source)
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.

Parametersaddran object implementing twisted.internet.interfaces.IAddress
def _cancelTimeout(self, result, timeoutCall): (source)
Undocumented
def gotHeaders(self, headers): (source)
overridden in twisted.web.client.HTTPDownloader

Parse the response HTTP headers.

ParametersheadersThe response HTTP headers. (type: dict)
def gotStatus(self, version, status, message): (source)

Set the status of the request on us.

ParametersversionThe HTTP version. (type: bytes)
statusThe HTTP status code, an integer represented as a bytestring. (type: bytes)
messageThe HTTP status message. (type: bytes)
def page(self, page): (source)
Undocumented
def noPage(self, reason): (source)
overridden in twisted.web.client.HTTPDownloader
Undocumented
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.

API Documentation for Twisted, generated by pydoctor at 2017-09-23 19:45:03.