class documentation

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

View In Hierarchy

A log file that can be rotated.

A rotateLength of None disables automatic log rotation.

Method __init__ Create a log file rotating on length.
Instance Variable rotateLength Undocumented
Instance Variable maxRotatedFiles Undocumented
Instance Variable size Undocumented
Method shouldRotate Rotate when the log file size is larger than rotateLength.
Method getLog Given an integer, return a LogReader for an old log file.
Method write Write some data to the file.
Method rotate Rotate the file and create a new one.
Method listLogs Return sorted list of integers - the old logs' identifiers.
Method __getstate__ Undocumented
Method _openFile Open the log file.

Inherited from BaseLogFile:

Class Variable synchronized Undocumented
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.
Instance Variable closed Undocumented
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.
Instance Variable _file Undocumented
def __init__(self, name, directory, rotateLength=1000000, defaultMode=None, maxRotatedFiles=None): (source)

Create a log file rotating on length.

Parametersnamefile name. (type: str)
directorypath of the log file. (type: str)
rotateLengthsize of the log file where it rotates. Default to 1M. (type: int)
defaultModemode used to create the file. (type: int)
maxRotatedFilesif not None, max number of log files the class creates. Warning: it removes all log files above this number. (type: int)
rotateLength = (source)

Undocumented

maxRotatedFiles = (source)

Undocumented

def _openFile(self): (source)

Open the log file.

The log file is always opened in binary mode.

size = (source)

Undocumented

def shouldRotate(self): (source)

Rotate when the log file size is larger than rotateLength.

def getLog(self, identifier): (source)

Given an integer, return a LogReader for an old log file.

def write(self, data): (source)

Write some data to the file.

def rotate(self): (source)

Rotate the file and create a new one.

If it's not possible to open new logfile, this will fail silently, and continue logging to old logfile.

def listLogs(self): (source)

Return sorted list of integers - the old logs' identifiers.

def __getstate__(self): (source)

Undocumented

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