twisted.python.logfile.BaseLogFile

class documentation

class twisted.python.logfile.BaseLogFile: (source)

Known subclasses: twisted.python.logfile.DailyLogFile, twisted.python.logfile.LogFile

View In Hierarchy

The base class for a log file that can be rotated.

Class Variable synchronized Undocumented
Method __init__ Create a log file.
Instance Variable directory Undocumented
Instance Variable name Undocumented
Instance Variable path Undocumented
Instance Variable defaultMode Undocumented
Class Method fromFullPath Construct a log file from a full file path.
Method shouldRotate Override with a method to that returns true if the log should be rotated.
Instance Variable closed Undocumented
Method write Write some data to the file.
Method flush Flush the file.
Method close Close the file.
Method reopen Reopen the log file. This is mainly useful if you use an external log rotation tool, which moves under your feet.
Method getCurrentLog Return a LogReader for the current log file.
Method _openFile Open the log file.
Instance Variable _file Undocumented
synchronized = (source)

Undocumented

(type: list[str])
def __init__(self, name, directory, defaultMode=None): (source)
overridden in twisted.python.logfile.LogFile

Create a log file.

Parametersnamename of the file (type: str)
directorydirectory holding the file (type: str)
defaultModepermissions used to create the file. Default to current permissions of the file if the file exists. (type: Optional[int])
directory = (source)

Undocumented

name = (source)

Undocumented

path = (source)

Undocumented

defaultMode = (source)

Undocumented

@classmethod
def fromFullPath(cls, filename, *args, **kwargs): (source)

Construct a log file from a full file path.

def shouldRotate(self): (source)
overridden in twisted.python.logfile.DailyLogFile, twisted.python.logfile.LogFile

Override with a method to that returns true if the log should be rotated.

def _openFile(self): (source)
overridden in twisted.python.logfile.DailyLogFile, twisted.python.logfile.LogFile

Open the log file.

The log file is always opened in binary mode.

closed = (source)

Undocumented

(type: bool)
_file = (source)

Undocumented

def write(self, data): (source)
overridden in twisted.python.logfile.DailyLogFile, twisted.python.logfile.LogFile

Write some data to the file.

ParametersdataThe data to write. Text will be encoded as UTF-8. (type: bytes or unicode)
def flush(self): (source)

Flush the file.

def close(self): (source)

Close the file.

The file cannot be used once it has been closed.

def reopen(self): (source)

Reopen the log file. This is mainly useful if you use an external log rotation tool, which moves under your feet.

Note that on Windows you probably need a specific API to rename the file, as it's not supported to simply use os.rename, for example.

def getCurrentLog(self): (source)

Return a LogReader for the current log file.

API Documentation for Twisted, generated by pydoctor 20.12.1 at 2021-02-28 19:53:36.