t.p.l.LogFile(BaseLogFile) : class documentation

Part of twisted.python.logfile View 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.
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 Method fromFullPath Construct a log file from a full file path.
Method __setstate__ Undocumented
Method flush Flush the file.
Method close Close the file.
Method getCurrentLog Return a LogReader for the current log file.
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 )
def _openFile(self): (source)
Open the log file.
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 at 2011-10-27 15:57:47.