twisted.web.client.HTTPClientFactory : API documentation

class documentation

class twisted.web.client.HTTPClientFactory(protocol.ClientFactory): (source)

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.
Instance Variable	status	The status of the response.
Instance Variable	version	The version of the response.
Instance Variable	message	The text message returned with the status.
Instance Variable	response_headers	The headers that were specified in the response from the server.
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	redirectLimit	The maximum number of HTTP redirects that can occur before it is assumed that the redirection is endless.
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	url	Undocumented
Instance Variable	scheme	Undocumented
Instance Variable	host	Undocumented
Instance Variable	port	Undocumented
Instance Variable	path	Undocumented
Method	__init__	Undocumented
Instance Variable	followRedirect	Undocumented
Instance Variable	timeout	Undocumented
Instance Variable	agent	Undocumented
Instance Variable	cookies	Undocumented
Instance Variable	headers	Undocumented
Instance Variable	postdata	Undocumented
Instance Variable	waiting	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.
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 Variable	protocol	Undocumented
Instance Variable	numPorts	Undocumented
Class Variable	noisy	Undocumented
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 = (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.

(type: Deferred)

status = (source)

The status of the response.

(type: bytes)

version = (source)

The version of the response.

(type: bytes)

message = (source)

The text message returned with the status.

(type: bytes)

response_headers = (source)

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

(type: dict)

method = (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.

(type: bytes)

redirectLimit = (source)

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

(type: int)

afterFoundGet = (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

(type: bool)

_redirectCount = (source)

The current number of HTTP redirects encountered.

(type: int)

_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.

url = (source)

Undocumented

scheme = (source)

Undocumented

host = (source)

Undocumented

port = (source)

Undocumented

path = (source)

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

followRedirect = (source)

Undocumented

timeout = (source)

Undocumented

agent = (source)

Undocumented

cookies = (source)

Undocumented

headers = (source)

Undocumented

postdata = (source)

Undocumented

waiting = (source)

overridden in twisted.web.client.HTTPDownloader

Undocumented

(type: int)

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

Returns Undocumented (type: str)

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.

Parameters addr an 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.

Parameters headers The response HTTP headers. (type: dict)

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

Set the status of the request on us.

Parameters	version	The HTTP version. (type: `bytes`)
	status	The HTTP status code, an integer represented as a bytestring. (type: `bytes`)
	message	The 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 20.12.1 at 2021-02-28 19:53:36.