class documentation

class twisted.logger.STDLibLogObserver: (source)

View In Hierarchy

Log observer that writes to the python standard library's logging module.

NoteWarning: specific logging configurations (example: network) can lead to this observer blocking. Nothing is done here to prevent that, so be sure to not to configure the standard library logging module to block when used in conjunction with this module: code within Twisted, such as twisted.web, assumes that logging does not block.
Class Variable defaultStackDepth This is the default number of frames that it takes to get from STDLibLogObserver through the logging module, plus one; in other words, the number of frames if you were to call a STDLibLogObserver directly. This is useful to use as an offset for the stackDepth parameter to __init__, to add frames for other publishers.
Method __init__
Instance Variable logger Undocumented
Instance Variable stackDepth Undocumented
Method __call__ Format an event and bridge it to Python logging.
Method _findCaller Based on the stack depth passed to this STDLibLogObserver, identify the calling function.
defaultStackDepth = (source)
This is the default number of frames that it takes to get from STDLibLogObserver through the logging module, plus one; in other words, the number of frames if you were to call a STDLibLogObserver directly. This is useful to use as an offset for the stackDepth parameter to __init__, to add frames for other publishers.
(type: int)
def __init__(self, name='twisted', stackDepth=defaultStackDepth): (source)
Parametersnamelogger identifier. (type: str)
stackDepthThe depth of the stack to investigate for caller metadata. (type: int)
logger = (source)

Undocumented

stackDepth = (source)

Undocumented

def _findCaller(self, stackInfo=False, stackLevel=1): (source)

Based on the stack depth passed to this STDLibLogObserver, identify the calling function.

ParametersstackInfoWhether or not to construct stack information. (Currently ignored.) (type: bool)
stackLevelThe number of stack frames to skip when determining the caller (currently ignored; use stackDepth on the instance). (type: int)
ReturnsDepending on Python version, either a 3-tuple of (filename, lineno, name) or a 4-tuple of that plus stack information. (type: Tuple[str, int, str, None])
def __call__(self, event): (source)

Format an event and bridge it to Python logging.

ParameterseventUndocumented (type: LogEvent)
API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.