twisted.test.test_stdio.StandardIOTestProcessProtocol(protocol.ProcessProtocol) class documentation

Part of twisted.test.test_stdio (View In Hierarchy)

Test helper for collecting output from a child process and notifying something when it exits.

Instance Variable onConnection A defer.Deferred which will be called back with None when the connection to the child process is established.
Instance Variable onCompletion A defer.Deferred which will be errbacked with the failure associated with the child process exiting when it exits.
Instance Variable onDataReceived A defer.Deferred which will be called back with this instance whenever childDataReceived is called, or None to suppress these callbacks.
Instance Variable data A dict mapping file descriptors to strings containing all bytes received from the child process on each file descriptor.
Method __init__ Undocumented
Method connectionMade Called when a connection is made.
Method childDataReceived Record all bytes received from the child process in the data dictionary. Fire onDataReceived if it is not None.
Method processEnded Called when the child process exits and all file descriptors associated with it have been closed.

Inherited from ProcessProtocol:

Method outReceived Some data was received from stdout.
Method errReceived Some data was received from stderr.
Method childConnectionLost Called when a file descriptor associated with the child process is closed.
Method inConnectionLost This will be called when stdin is closed.
Method outConnectionLost This will be called when stdout is closed.
Method errConnectionLost This will be called when stderr is closed.
Method processExited This will be called when the subprocess exits.

Inherited from BaseProtocol (via ProcessProtocol):

Method makeConnection Make a connection to a transport and a server.
onConnection =
A defer.Deferred which will be called back with None when the connection to the child process is established.
onCompletion =
A defer.Deferred which will be errbacked with the failure associated with the child process exiting when it exits.
onDataReceived =
A defer.Deferred which will be called back with this instance whenever childDataReceived is called, or None to suppress these callbacks.
data =
A dict mapping file descriptors to strings containing all bytes received from the child process on each file descriptor.
def __init__(self):
Undocumented
def connectionMade(self):
overrides twisted.internet.protocol.BaseProtocol.connectionMade

Called when a connection is made.

This may be considered the initializer of the protocol, because it is called when the connection is completed. For clients, this is called once the connection to the server has been established; for servers, this is called after an accept() call stops blocking and a socket has been received. If you need to send any greeting or initial message, do it here.

def childDataReceived(self, name, bytes):
from twisted.internet.interfaces.IProcessProtocol
overrides twisted.internet.protocol.ProcessProtocol.childDataReceived

Record all bytes received from the child process in the data dictionary. Fire onDataReceived if it is not None.

def processEnded(self, reason):
from twisted.internet.interfaces.IProcessProtocol
overrides twisted.internet.protocol.ProcessProtocol.processEnded

Called when the child process exits and all file descriptors associated with it have been closed.

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