twisted.web.http.HTTPFactory

class documentation

class HTTPFactory(protocol.ServerFactory): (source)

Known subclasses: twisted.web.server.Site

Constructor: HTTPFactory(logPath, timeout, logFormatter, reactor)

Factory for HTTP server.

Method	`__init__`	No summary
Method	`buildProtocol`	Create an instance of a subclass of Protocol.
Method	`log`	Write a line representing `request` to the access log file.
Method	`startFactory`	Set up request logging if necessary.
Method	`stopFactory`	This will be called before I stop listening on all Ports/Connectors.
Class Variable	`logFile`	A file (object with `write(data: str)` and `close()` methods) that will be used for logging HTTP requests and responses in the standard Combined Log Format .
Instance Variable	`logPath`	Undocumented
Instance Variable	`reactor`	An `IReactorTime` provider used to manage connection timeouts and compute logging timestamps.
Instance Variable	`timeOut`	Undocumented
Method	`_get_logFile`	Undocumented
Method	`_get_logFile.setter`	Undocumented
Method	`_openLogFile`	Override in subclasses, e.g. to use `twisted.python.logfile`.
Method	`_updateLogDateTime`	Update log datetime periodically, so we aren't always recalculating it.
Instance Variable	`_logDateTime`	A cached datetime string for log messages, updated by `_logDateTimeCall`.
Instance Variable	`_logDateTimeCall`	A delayed call for the next update to the cached log datetime string.
Instance Variable	`_logFile`	Undocumented
Instance Variable	`_logFormatter`	See the `logFormatter` parameter to `__init__`
Instance Variable	`_nativeize`	A flag that indicates whether the log file being written to wants native strings (`True`) or bytes (`False`). This is only to support writing to `twisted.python.log` which, unfortunately, works with native strings.

Inherited from Factory (via ServerFactory):

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.
Class Variable	`noisy`	Undocumented
Class Variable	`protocol`	Undocumented
Instance Variable	`numPorts`	Undocumented

overridden in twisted.web.server.Site

Parameters
logPath:`str` or `bytes`	File path to which access log messages will be written or `None` to disable logging.
timeout:`float`	The initial value of `timeOut`, which defines the idle connection timeout in seconds, or `None` to disable the idle timeout.
logFormatter:`IAccessLogFormatter` provider	An object to format requests into log lines for the access log. `combinedLogFormatter` when `None` is passed.
reactor:`IReactorTime \| None`	An `IReactorTime` provider used to manage connection timeouts and compute logging timestamps. Defaults to the global reactor.

def buildProtocol(self, addr: IAddress) -> Protocol | None: (source) ¶

from twisted.internet.interfaces.IProtocolFactory

overrides twisted.internet.protocol.Factory.buildProtocol

overridden in twisted.web.server.Site

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:`IAddress`	an object implementing `IAddress`
Returns
`Protocol \| None`	Undocumented

def log(self, request: Request): (source) ¶

Write a line representing request to the access log file.

Parameters
request:`Request`	The request object about which to log.

def startFactory(self): (source) ¶

overrides twisted.internet.protocol.Factory.startFactory

Set up request logging if necessary.

def stopFactory(self): (source) ¶

overrides twisted.internet.protocol.Factory.stopFactory

This will be called before I stop listening on all Ports/Connectors.

This can be overridden to perform 'shutdown' tasks such as disconnecting database connections, closing files, etc.

It will be called, for example, before an application shuts down, if it was connected to a port. User code should not call this function directly.

logFile = (source) ¶

A file (object with write(data: str) and close() methods) that will be used for logging HTTP requests and responses in the standard Combined Log Format .

Note
for backwards compatibility purposes, this may be set to an object with a `write(data: bytes)` method, but these will be detected (by checking if it's an instance of `BufferedIOBase`) and replaced with a `TextIOWrapper` when retrieved by getting the attribute again.

logPath = (source) ¶

Undocumented

reactor: IReactorTime = (source) ¶

An IReactorTime provider used to manage connection timeouts and compute logging timestamps.

timeOut = (source) ¶

Undocumented

@logFile.getter
def _get_logFile(self) -> _MinimalLogFile: (source) ¶

Undocumented

@_get_logFile.setter
def _get_logFile(self, newLogFile: BufferedIOBase | _MinimalLogFile): (source) ¶

Undocumented

def _openLogFile(self, path: str | bytes) -> _MinimalLogFile: (source) ¶

overridden in twisted.web.server.Site

Override in subclasses, e.g. to use twisted.python.logfile.

def _updateLogDateTime(self): (source) ¶

Update log datetime periodically, so we aren't always recalculating it.

_logDateTime: str = (source) ¶

A cached datetime string for log messages, updated by _logDateTimeCall.

_logDateTimeCall: IDelayedCall provided = (source) ¶

A delayed call for the next update to the cached log datetime string.

_logFile: _MinimalLogFile | None = (source) ¶

Undocumented

_logFormatter = (source) ¶

See the logFormatter parameter to __init__

_nativeize = (source) ¶

A flag that indicates whether the log file being written to wants native strings (True) or bytes (False). This is only to support writing to twisted.python.log which, unfortunately, works with native strings.