twisted.logger.LoggingFile

class documentation

class LoggingFile: (source)

View In Hierarchy

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, level=LogLevel.info, encoding=None): (source)
Parameters
logger:Loggerthe logger to log through.
level:NamedConstantthe log level to emit events with.
encoding:Optional[str]The encoding to expect when receiving bytes via write(). If None, use sys.getdefaultencoding().
def close(self): (source)
Close this file so it can no longer be written to.
def fileno(self): (source)
Returns an invalid file descriptor, since this is not backed by an FD.
Returns
int-1
def flush(self): (source)
No-op; this file does not buffer.
def isatty(self): (source)
A LoggingFile is not a TTY.
Returns
boolFalse
@softspace.setter
def softspace(self, value): (source)

Undocumented

def write(self, message): (source)
Log the given message.
Parameters
message:AnyStrThe message to write.
def writelines(self, lines): (source)
Log each of the given lines as a separate message.
Parameters
lines:Iterable[AnyStr]Data to write.
level = (source)

Undocumented

log = (source)

Undocumented

@property
closed: bool = (source)
Read-only property. Is the file closed?
@property
encoding: str = (source)
Read-only property. File encoding.
@property
mode: str = (source)
Read-only property. File mode.
@property
name: str = (source)
The name of this file; a repr-style string giving information about its namespace.
@property
newlines: None = (source)
Read-only property. Types of newlines encountered.
@deprecatedProperty(Version('Twisted', 21, 2, 0))
softspace = (source)

Undocumented

def _unsupported(self, *args): (source)
Template for unsupported operations.
Parameters
*args:objectArguments.
_buffer = (source)

Undocumented

_closed: bool = (source)

Undocumented

_encoding = (source)

Undocumented

_softspace = (source)

Undocumented