twisted.web.client.HTTPPageGetter : API documentation

class documentation

class twisted.web.client.HTTPPageGetter(http.HTTPClient): (source)

Known subclasses: twisted.web.client.HTTPPageDownloader

Gets a resource via HTTP, then quits.

Typically used with HTTPClientFactory. Note that this class does not, by itself, do anything with the response. If you want to download a resource into a file, use HTTPPageDownloader instead.

Instance Variable	quietLoss	Undocumented
Class Variable	followRedirect	Undocumented
Instance Variable	failed	Undocumented
Method	connectionMade	Called when a connection is made.
Instance Variable	headers	Undocumented
Method	handleHeader	Called every time a header is received. Stores the header information as key-value pairs in the `headers` attribute.
Method	handleStatus	Handle the HTTP status line.
Instance Variable	version	Undocumented
Instance Variable	status	Undocumented
Instance Variable	message	Undocumented
Method	handleEndHeaders	Called when all headers have been received.
Method	handleStatus_200	Undocumented
Class Variable	handleStatus_201	Undocumented
Class Variable	handleStatus_202	Undocumented
Method	handleStatusDefault	Undocumented
Method	handleStatus_301	Undocumented
Method	handleStatus_302	Undocumented
Method	handleStatus_303	Undocumented
Method	connectionLost	When the connection used to issue the HTTP request is closed, notify the factory if we have not already, so it can produce a result.
Method	handleResponse	Undocumented
Method	timeout	Undocumented
Instance Variable	_completelyDone	A boolean indicating whether any further requests are necessary after this one completes in order to provide a result to `self.factory.deferred`. If it is `False`, then a redirect is going to be followed. Otherwise, this protocol's connection is the last one before firing the result Deferred. This is used to make sure the result Deferred is only fired after the connection is cleaned up.
Class Variable	_specialHeaders	Undocumented

Inherited from HTTPClient:

Instance Variable	length	The length of the request body in bytes.
Instance Variable	firstLine	Are we waiting for the first header line?
Method	sendCommand	Undocumented
Method	sendHeader	Undocumented
Method	endHeaders	Undocumented
Method	extractHeader	Given a complete HTTP header, extract the field name and value and process the header.
Method	lineReceived	Parse the status line and headers for an HTTP request.
Method	handleResponseEnd	The response has been completely received.
Method	handleResponsePart	Undocumented
Method	rawDataReceived	Override this for when raw data is received.
Instance Variable	__buffer	The buffer that stores the response to the HTTP request.
Instance Variable	_header	Part or all of an HTTP request header.

Inherited from LineReceiver (via HTTPClient):

Class Variable	delimiter	The line-ending delimiter to use. By default this is `b'\r\n'`.
Class Variable	MAX_LENGTH	The maximum length of a line to allow (If a sent line is longer than this, the connection is dropped). Default is 16384.
Instance Variable	line_mode	Undocumented
Method	clearLineBuffer	Clear buffered data.
Method	dataReceived	Protocol.dataReceived. Translates bytes into lines, and calls lineReceived (or rawDataReceived, depending on mode.)
Method	setLineMode	Sets the line-mode of this receiver.
Method	setRawMode	Sets the raw mode of this receiver. Further data received will be sent to rawDataReceived rather than lineReceived.
Method	sendLine	Sends a line to the other end of the connection.
Method	lineLengthExceeded	Called when the maximum line length has been reached. Override if it needs to be dealt with in some special way.
Instance Variable	_buffer	Undocumented
Instance Variable	_busyReceiving	Undocumented

Inherited from Protocol (via HTTPClient, LineReceiver):

Class Variable	factory	Undocumented
Method	logPrefix	Return a prefix matching the class name, to identify log messages related to this protocol instance.

Inherited from BaseProtocol (via HTTPClient, LineReceiver, Protocol):

Instance Variable	connected	Undocumented
Instance Variable	transport	Undocumented
Method	makeConnection	Make a connection to a transport and a server.

Inherited from _PauseableMixin (via HTTPClient, LineReceiver):

Instance Variable	paused	Undocumented
Method	pauseProducing	Undocumented
Method	resumeProducing	Undocumented
Method	stopProducing	Undocumented

_completelyDone = (source)

A boolean indicating whether any further requests are necessary after this one completes in order to provide a result to self.factory.deferred. If it is False, then a redirect is going to be followed. Otherwise, this protocol's connection is the last one before firing the result Deferred. This is used to make sure the result Deferred is only fired after the connection is cleaned up.

(type: bool)

quietLoss = (source)

Undocumented

(type: bool)

followRedirect = (source)

Undocumented

(type: bool)

failed = (source)

Undocumented

(type: int)

_specialHeaders = (source)

Undocumented

(type: set[bytes])

def connectionMade(self): (source)

from twisted.internet.interfaces.IProtocol

overrides twisted.web.http.HTTPClient.connectionMade

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

headers = (source)

Undocumented

(type: dict)

def handleHeader(self, key, value): (source)

overrides twisted.web.http.HTTPClient.handleHeader

Called every time a header is received. Stores the header information as key-value pairs in the headers attribute.

Parameters	key	An HTTP header field name. (type: `str`)
	value	An HTTP header field value. (type: `str`)

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

overrides twisted.web.http.HTTPClient.handleStatus

Handle the HTTP status line.

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`)