twisted.internet.test.test_fdset.ReactorFDSetTestsBuilder

class documentation

class ReactorFDSetTestsBuilder(ReactorBuilder, PretendTestCase):

Constructor: ReactorFDSetTestsBuilder(methodName)

View In Hierarchy

Builder defining tests relating to IReactorFDSet.

Method test_addReader reactor.addReader() accepts an IReadDescriptor provider and calls its doRead method when there may be data available on its fileno.
Method test_addWriter reactor.addWriter() accepts an IWriteDescriptor provider and calls its doWrite method when it may be possible to write to its fileno.
Method test_connectionLostOnShutdown Any file descriptors added to the reactor have their connectionLost called when reactor.stop is called.
Method test_getReaders IReactorFDSet.getReaders reflects the additions and removals made with IReactorFDSet.addReader and IReactorFDSet.removeReader.
Method test_getWriters IReactorFDSet.getWriters reflects the additions and removals made with IReactorFDSet.addWriter and IReactorFDSet.removeWriter.
Method test_lostFileDescriptor The file descriptor underlying a FileDescriptor may be closed and replaced by another at some point. Bytes which arrive on the new descriptor must not be delivered to the FileDescriptor which was originally registered with the original descriptor of the same number.
Method test_negativeOneFileDescriptor If FileDescriptor.fileno returns -1, the descriptor is removed from the reactor.
Method test_removeAll reactor.removeAll() removes all registered IReadDescriptor providers and all registered IWriteDescriptor providers and returns them.
Method test_removedFromReactor A descriptor's fileno method should not be called after the descriptor has been removed from the reactor.
Method test_removeReader reactor.removeReader() accepts an IReadDescriptor provider previously passed to reactor.addReader() and causes it to no longer be monitored for input events.
Method test_removeWriter reactor.removeWriter() accepts an IWriteDescriptor provider previously passed to reactor.addWriter() and causes it to no longer be monitored for outputability.
Class Variable requiredInterfaces Undocumented
Method _connectedPair Return the two sockets which make up a new TCP connection.
Method _getFDTest Helper for getReaders and getWriters tests.
Method _simpleSetup Undocumented

Inherited from ReactorBuilder:

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.
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.
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.
Instance Variable _reactors A list of FQPN strings giving the reactors for which SynchronousTestCases will be created.

Inherited from SynchronousTestCase (via ReactorBuilder):

Method __eq__ Override the comparison defined by the base TestCase which considers instances of the same class with the same _testMethodName to be equal. Since trial puts TestCase instances into a set, that definition of comparison makes it impossible to run the same test method twice...
Method __hash__ Undocumented
Method __init__ Undocumented
Method addCleanup Add the given function to a list of functions to be called after the test has run, but before tearDown.
Method callDeprecated Call a function that should have been deprecated at a specific version and in favor of a specific alternative, and assert that it was thusly deprecated.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
Method getDeprecatedModuleAttribute Retrieve a module attribute which should have been deprecated, and assert that we saw the appropriate deprecation warning.
Method getSkip Return the skip reason set on this test, if any is set. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a skip attribute, returns that in a tuple (...
Method getTodo Return a Todo object if the test is marked todo. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a todo attribute, returns that. Returns ...
Method mktemp Create a new path name which can be used for a new file or directory.
Method patch Monkey patch an object for the duration of the test.
Method run Run the test case, storing the results in result.
Method runTest If no methodName argument is passed to the constructor, run will treat this method as the thing with the actual test inside.
Method shortDescription Undocumented
Instance Variable failureException An exception class, defaulting to FailTest. If the test method raises this exception, it will be reported as a failure, rather than an exception. All of the assertion methods raise this if the assertion fails.
Instance Variable skip None or a string explaining why this test is to be skipped. If defined, the test will not be run. Instead, it will be reported to the result object as 'skipped' (if the TestResult supports skipping).
Instance Variable suppress None or a list of tuples of (args, kwargs) to be passed to warnings.filterwarnings. Use these to suppress warnings raised in a test. Useful for testing deprecated code. See also util.suppress.
Instance Variable todo None, a string or a tuple of (errors, reason) where errors is either an exception class or an iterable of exception classes, and reason is a string. See Todo or makeTodo for more information.
Method _getSkipReason Return the reason to use for skipping a test method.
Method _getSuppress Returns any warning suppressions set for this test. Checks on the instance first, then the class, then the module, then packages. As soon as it finds something with a suppress attribute, returns that. ...
Method _installObserver Undocumented
Method _removeObserver Undocumented
Method _run Run a single method, either a test method or fixture.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _runFixturesAndTest Run setUp, a test method, test cleanups, and tearDown.
Instance Variable _cleanups Undocumented
Instance Variable _observer Undocumented
Instance Variable _parents Undocumented
Instance Variable _passed Undocumented
Instance Variable _testMethodName Undocumented
Instance Variable _warnings Undocumented

Inherited from _Assertions (via ReactorBuilder, SynchronousTestCase):

Method assertAlmostEqual Fail if the two objects are unequal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertApproximates Fail if first - second > tolerance
Method assertEqual Fail the test if first and second are not equal.
Method assertFalse Fail the test if condition evaluates to True.
Method assertIn Fail the test if containee is not found in container.
Method assertIs Fail the test if first is not second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertNotAlmostEqual Fail if the two objects are equal as determined by their difference rounded to the given number of decimal places (default 7) and comparing to zero.
Method assertNotEqual Fail the test if first == second.
Method assertNotIn Fail the test if containee is found in container.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method assertNotSubstring Fail if astring contains substring.
Method assertRaises Fail the test unless calling the function f with the given args and kwargs raises exception. The failure will report the traceback and call stack of the unexpected exception.
Method assertSubstring Fail if substring does not exist within astring.
Method assertTrue Fail the test if condition evaluates to False.
Method assertWarns Fail if the given function doesn't generate the specified warning when called. It calls the function, checks the warning, and forwards the result of the function if everything is fine.
Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method successResultOf Return the current success result of deferred or raise self.failureException.
def test_addReader(self):

reactor.addReader() accepts an IReadDescriptor provider and calls its doRead method when there may be data available on its fileno.

def test_addWriter(self):

reactor.addWriter() accepts an IWriteDescriptor provider and calls its doWrite method when it may be possible to write to its fileno.

def test_connectionLostOnShutdown(self):

Any file descriptors added to the reactor have their connectionLost called when reactor.stop is called.

def test_getReaders(self):

IReactorFDSet.getReaders reflects the additions and removals made with IReactorFDSet.addReader and IReactorFDSet.removeReader.

def test_getWriters(self):

IReactorFDSet.getWriters reflects the additions and removals made with IReactorFDSet.addWriter and IReactorFDSet.removeWriter.

@skipIf(platform.isWindows(), 'Cannot duplicate socket filenos on Windows')
def test_lostFileDescriptor(self):

The file descriptor underlying a FileDescriptor may be closed and replaced by another at some point. Bytes which arrive on the new descriptor must not be delivered to the FileDescriptor which was originally registered with the original descriptor of the same number.

Practically speaking, this is difficult or impossible to detect. The implementation relies on fileno raising an exception if the original descriptor has gone away. If fileno continues to return the original file descriptor value, the reactor may deliver events from that descriptor. This is a best effort attempt to ease certain debugging situations. Applications should not rely on it intentionally.

def test_negativeOneFileDescriptor(self):

If FileDescriptor.fileno returns -1, the descriptor is removed from the reactor.

def test_removeAll(self):

reactor.removeAll() removes all registered IReadDescriptor providers and all registered IWriteDescriptor providers and returns them.

def test_removedFromReactor(self):

A descriptor's fileno method should not be called after the descriptor has been removed from the reactor.

def test_removeReader(self):

reactor.removeReader() accepts an IReadDescriptor provider previously passed to reactor.addReader() and causes it to no longer be monitored for input events.

def test_removeWriter(self):

reactor.removeWriter() accepts an IWriteDescriptor provider previously passed to reactor.addWriter() and causes it to no longer be monitored for outputability.

requiredInterfaces =
overrides twisted.internet.test.reactormixins.ReactorBuilder.requiredInterfaces

Undocumented

def _connectedPair(self):

Return the two sockets which make up a new TCP connection.

def _getFDTest(self, kind):

Helper for getReaders and getWriters tests.

def _simpleSetup(self):

Undocumented