twisted.python.logfile.LogFile : API documentation

class documentation

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

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.

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