twisted.web.client.HTTPDownloader

class documentation

class HTTPDownloader(HTTPClientFactory): (source)

Download to a file.

Method	`__init__`	Undocumented
Method	`gotHeaders`	Parse the response HTTP headers.
Method	`noPage`	Close the storage file and errback the waiting `Deferred` with the given reason.
Method	`openFile`	Undocumented
Method	`pageEnd`	Undocumented
Method	`pagePart`	Undocumented
Method	`pageStart`	Called on page download start.
Class Variable	`value`	Undocumented
Instance Variable	`file`	Undocumented
Instance Variable	`fileName`	Undocumented
Instance Variable	`requestedPartial`	Undocumented
Instance Variable	`waiting`	Undocumented
Class Variable	`_log`	Undocumented

Inherited from HTTPClientFactory:

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	`gotStatus`	Set the status of the request on us.
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.
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 (via HTTPClientFactory):

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

Inherited from Factory (via HTTPClientFactory, 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, fileOrName, method=b'GET', postdata=None, headers=None, agent=b'Twisted client', supportPartial=False, timeout=0, cookies=None, followRedirect=True, redirectLimit=20, afterFoundGet=False): (source)

overrides twisted.web.client.HTTPClientFactory.__init__

Undocumented

def gotHeaders(self, headers): (source)

overrides twisted.web.client.HTTPClientFactory.gotHeaders

Parse the response HTTP headers.

Parameters
headers:`dict`	The response HTTP headers.

def noPage(self, reason): (source)

overrides twisted.web.client.HTTPClientFactory.noPage

Close the storage file and errback the waiting Deferred with the given reason.

def openFile(self, partialContent): (source)

Undocumented

def pageEnd(self): (source)

Undocumented

def pagePart(self, data): (source)

Undocumented

def pageStart(self, partialContent): (source)

Called on page download start.

Parameters
partialContent	tells us if the download is partial download we requested.

value = (source)

Undocumented

file = (source)

Undocumented

fileName = (source)

Undocumented

requestedPartial: int = (source)

Undocumented

waiting: int = (source)

overrides twisted.web.client.HTTPClientFactory.waiting

Undocumented

_log = (source)

Undocumented