twisted.application.runner._pidfile.PIDFile : API documentation

Undocumented

@staticmethod
def _format(pid): (source)

Format a PID file's content.

Parameters	pid	A process ID. (type: `int`)
Returns	Formatted PID file contents. (type: `bytes`)

def __init__(self, filePath): (source)

Parameters filePath The path to the PID file on disk. (type: FilePath)

filePath = (source)

Undocumented

def read(self): (source)

Read the process ID stored in this PID file.

Returns	The contained process ID. (type: `int`)
Raises	NoPIDFound	If this PID file does not exist.
	EnvironmentError	If this PID file cannot be read.
	ValueError	If this PID file's content is invalid.

def _write(self, pid): (source)

Store a PID in this PID file.

Parameters	pid	A PID to store. (type: `int`)
Raises	EnvironmentError	If this PID file cannot be written.

def writeRunningPID(self): (source)

Store the PID of the current process in this PID file.

Raises EnvironmentError If this PID file cannot be written.

def remove(self): (source)

Remove this PID file.

Raises EnvironmentError If this PID file cannot be removed.

def isRunning(self): (source)

Determine whether there is a running process corresponding to the PID in this PID file.

Returns	True if this PID file contains a PID and a process with that PID is currently running; false otherwise. (type: `bool`)
Raises	EnvironmentError	If this PID file cannot be read.
	InvalidPIDFileError	If this PID file's content is invalid.
	StalePIDFileError	If this PID file's content refers to a PID for which there is no corresponding running process.

@staticmethod
def _pidIsRunningPOSIX(pid): (source)

POSIX implementation for running process check.

Determine whether there is a running process corresponding to the given PID.

Parameters	pid	The PID to check. (type: `int`)
Returns	True if the given PID is currently running; false otherwise. (type: `bool`)
Raises	EnvironmentError	If this PID file cannot be read.
	InvalidPIDFileError	If this PID file's content is invalid.
	StalePIDFileError	If this PID file's content refers to a PID for which there is no corresponding running process.

def __enter__(self): (source)

Enter a context using this PIDFile.

Writes the PID file with the PID of the running process.

Returns	Undocumented (type: `PIDFile`)
Raises	AlreadyRunningError	A process corresponding to the PID in this PID file is already running.

def __exit__(self, excType, excValue, traceback): (source)

Exit a context using this PIDFile.

Removes the PID file.

Parameters	excType	Undocumented (type: `Optional[Type[BaseException]]`)
	excValue	Undocumented (type: `Optional[BaseException]`)
	traceback	Undocumented (type: `Optional[TracebackType]`)

Method	__init__
Instance Variable	filePath	Undocumented
Method	read	Read the process ID stored in this PID file.
Method	writeRunningPID	Store the PID of the current process in this PID file.
Method	remove	Remove this PID file.
Method	isRunning	Determine whether there is a running process corresponding to the PID in this PID file.
Method	__enter__	Enter a context using this PIDFile.
Method	__exit__	Exit a context using this PIDFile.
Class Variable	_log	Undocumented
Static Method	_format	Format a PID file's content.
Method	_write	Store a PID in this PID file.
Static Method	_pidIsRunningPOSIX	POSIX implementation for running process check.