twisted.python.logfile.LogFile

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	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.

def __init__(self, name, directory, rotateLength=1000000, defaultMode=None, maxRotatedFiles=None):

Create a log file rotating on length.

Parameters	name	file name. (type: `str`)
	directory	path of the log file. (type: `str`)
	rotateLength	size of the log file where it rotates. Default to 1M. (type: `int`)
	defaultMode	mode used to create the file. (type: `int`)
	maxRotatedFiles	if not None, max number of log files the class creates. Warning: it removes all log files above this number. (type: `int`)

def _openFile(self):

Open the log file.

The log file is always opened in binary mode.

def shouldRotate(self):

Rotate when the log file size is larger than rotateLength.

def getLog(self, identifier):

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

def write(self, data):

Write some data to the file.

def rotate(self):

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):

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

def __getstate__(self):

Undocumented

API Documentation for twisted, generated by pydoctor at 2020-03-25 17:34:30.

twisted.python.logfile.LogFile(BaseLogFile) class documentation