twisted.logger.LoggingFile

class documentation

class LoggingFile: (source)

File-like object that turns write() calls into logging events.

Note that because event formats are str, bytes received via write() are converted to str, which is the opposite of what file does.

Method	`__init__`	No summary
Method	`close`	Close this file so it can no longer be written to.
Method	`fileno`	Returns an invalid file descriptor, since this is not backed by an FD.
Method	`flush`	No-op; this file does not buffer.
Method	`isatty`	A `LoggingFile` is not a TTY.
Method	`softspace.setter`	Undocumented
Method	`write`	Log the given message.
Method	`writelines`	Log each of the given lines as a separate message.
Instance Variable	`level`	Undocumented
Instance Variable	`log`	Undocumented
Property	`closed`	Read-only property. Is the file closed?
Property	`encoding`	Read-only property. File encoding.
Property	`mode`	Read-only property. File mode.
Property	`name`	The name of this file; a repr-style string giving information about its namespace.
Property	`newlines`	Read-only property. Types of newlines encountered.
Property	`softspace`	Undocumented
Method	`_unsupported`	Template for unsupported operations.
Instance Variable	`_buffer`	Undocumented
Instance Variable	`_closed`	Undocumented
Instance Variable	`_encoding`	Undocumented
Instance Variable	`_softspace`	Undocumented

def __init__(self, logger: Logger, level: NamedConstant = LogLevel.info, encoding: str | None = None): (source) ¶

Parameters
logger:`Logger`	the logger to log through.
level:`NamedConstant`	the log level to emit events with.
encoding:`str \| None`	The encoding to expect when receiving bytes via `write()`. If `None`, use `sys.getdefaultencoding()`.