twisted.internet.test.reactormixins.ReactorBuilder

class documentation

class ReactorBuilder: (source)

View In Hierarchy

SynchronousTestCase mixin which provides a reactor-creation API. This mixin defines setUp and tearDown, so mix it in before SynchronousTestCase or call its methods from the overridden ones in the subclass.

Class Method	`makeTestCaseClasses`	Create a `SynchronousTestCase` subclass which mixes in `cls` for each known reactor and return a dict mapping their names to them.
Method	`buildReactor`	Create and return a reactor using `self.reactorFactory`.
Method	`getTimeout`	Determine how long to run the test before considering it failed.
Method	`runReactor`	Run the reactor for at most the given amount of time.
Method	`setUp`	Clear the SIGCHLD handler, if there is one, to ensure an environment like the one which exists prior to a call to `reactor.run`.
Method	`tearDown`	Restore the original SIGCHLD handler and reap processes as long as there seem to be any remaining.
Method	`unbuildReactor`	Clean up any resources which may have been allocated for the given reactor by its creation or by a test which used it.
Class Variable	`requiredInterfaces`	A `list` of interfaces which the reactor must provide or these tests will be skipped. The default, `None`, means that no interfaces are required.
Class Variable	`skippedReactors`	A dict mapping FQPN strings of reactors for which the tests defined by this class will be skipped to strings giving the skip message.
Instance Variable	`originalHandler`	The SIGCHLD handler which was installed when setUp ran and which will be re-installed when tearDown runs.
Instance Variable	`reactorFactory`	A no-argument callable which returns the reactor to use for testing.
Instance Variable	`_reactors`	A list of FQPN strings giving the reactors for which `SynchronousTestCase`s will be created.

@classmethod
def makeTestCaseClasses(cls): (source) ¶

Create a SynchronousTestCase subclass which mixes in cls for each known reactor and return a dict mapping their names to them.

Returns
`Dict[str, Union[Type[ReactorBuilder], Type[SynchronousTestCase]]]`	Undocumented

def buildReactor(self): (source) ¶

overridden in twisted.internet.test.test_tls.AbortSSLConnectionTests

Create and return a reactor using self.reactorFactory.

def getTimeout(self): (source) ¶

Determine how long to run the test before considering it failed.

Returns
A `int` or `float` giving a number of seconds.

def runReactor(self, reactor, timeout=None): (source) ¶

overridden in twisted.internet.test.test_gireactor.GApplicationRegistrationTests

Run the reactor for at most the given amount of time.

Parameters
reactor	The reactor to run.
timeout:`int` or `float`	The maximum amount of time, specified in seconds, to allow the reactor to run. If the reactor is still running after this much time has elapsed, it will be stopped and an exception raised. If `None`, the default test method timeout imposed by Trial will be used. This depends on the `IReactorTime` implementation of `reactor` for correct operation.
Raises
`TestTimeoutError`	If the reactor is still running after `timeout` seconds.

def setUp(self): (source) ¶

overridden in twisted.internet.test.test_stdio.StdioFilesTests, twisted.internet.test.test_tcp.TCP6ClientTestsBuilder, twisted.internet.test.test_tcp.TCP6ConnectorTestsBuilder, twisted.internet.test.test_tls.AbortSSLConnectionTests

Clear the SIGCHLD handler, if there is one, to ensure an environment like the one which exists prior to a call to reactor.run.

def tearDown(self): (source) ¶

Restore the original SIGCHLD handler and reap processes as long as there seem to be any remaining.

def unbuildReactor(self, reactor): (source) ¶

Clean up any resources which may have been allocated for the given reactor by its creation or by a test which used it.

requiredInterfaces: Optional[Sequence[Type[Interface]]] = (source) ¶

overridden in twisted.internet.test.test_fdset.ReactorFDSetTestsBuilder, twisted.internet.test.test_process.ProcessTestsBuilderBase, twisted.internet.test.test_socket.AdoptDatagramPortErrorsTestsBuilder, twisted.internet.test.test_socket.AdoptStreamConnectionErrorsTestsBuilder, twisted.internet.test.test_socket.AdoptStreamPortErrorsTestsBuilder, twisted.internet.test.test_socket.IReactorSocketVerificationTestsBuilder, twisted.internet.test.test_tcp.AbortConnectionTests, twisted.internet.test.test_tcp.AdoptStreamConnectionTestsBuilder, twisted.internet.test.test_tcp.TCPClientTestsBase, twisted.internet.test.test_tcp.TCPConnectionTestsBuilder, twisted.internet.test.test_tcp.TCPConnectorTestsBuilder, twisted.internet.test.test_threads.ThreadTestsBuilder, twisted.internet.test.test_time.GlibTimeTestsBuilder, twisted.internet.test.test_time.TimeTestsBuilder, twisted.internet.test.test_tls.AbortSSLConnectionTests, twisted.internet.test.test_udp.UDPFDServerTestsBuilder, twisted.internet.test.test_udp.UDPServerTestsBuilder, twisted.internet.test.test_unix.UNIXAdoptStreamConnectionTestsBuilder, twisted.internet.test.test_unix.UnixClientTestsBuilder, twisted.internet.test.test_unix.UNIXDatagramTestsBuilder, twisted.internet.test.test_unix.UNIXTestsBuilder, twisted.internet.test.test_win32events.Win32EventsTestsBuilder

A list of interfaces which the reactor must provide or these tests will be skipped. The default, None, means that no interfaces are required.

skippedReactors: Dict[str, str] = (source) ¶

A dict mapping FQPN strings of reactors for which the tests defined by this class will be skipped to strings giving the skip message.

originalHandler = (source) ¶

The SIGCHLD handler which was installed when setUp ran and which will be re-installed when tearDown runs.

reactorFactory = (source) ¶

A no-argument callable which returns the reactor to use for testing.

_reactors: list[str] = (source) ¶

overridden in twisted.internet.test.test_time.GlibTimeTestsBuilder

A list of FQPN strings giving the reactors for which SynchronousTestCases will be created.