twisted.trial.test.test_warning.FlushWarningsTests(SynchronousTestCase) class documentation

Part of twisted.trial.test.test_warning (View In Hierarchy)

Tests for flushWarnings, an API for examining the warnings emitted so far in a test.

Method assertDictSubset Assert that all the keys present in subset are also present in set and that the corresponding values are equal.
Method assertDictSubsets For each pair of corresponding elements in sets and subsets, assert that the element from subsets is a subset of the element from sets.
Method test_none If no warnings are emitted by a test, flushWarnings returns an empty list.
Method test_several If several warnings are emitted by a test, flushWarnings returns a list containing all of them.
Method test_repeated The same warning triggered twice from the same place is included twice in the list returned by flushWarnings.
Method test_cleared After a particular warning event has been returned by flushWarnings, it is not returned by subsequent calls.
Method test_unflushed Any warnings emitted by a test which are not flushed are emitted to the Python warning system.
Method test_flushed Any warnings emitted by a test which are flushed are not emitted to the Python warning system.
Method test_warningsConfiguredAsErrors If a warnings filter has been installed which turns warnings into exceptions, tests have an error added to the reporter for them for each unflushed warning.
Method test_flushedWarningsConfiguredAsErrors If a warnings filter has been installed which turns warnings into exceptions, tests which emit those warnings but flush them do not have an error added to the reporter.
Method test_multipleFlushes Any warnings emitted after a call to flushWarnings can be flushed by another call to flushWarnings.
Method test_filterOnOffendingFunction The list returned by flushWarnings includes only those warnings which refer to the source of the function passed as the value for offendingFunction, if a value is passed for that parameter.
Method test_functionBoundaries Verify that warnings emitted at the very edges of a function are still determined to be emitted from that function.
Method test_invalidFilter If an object which is neither a function nor a method is included in the offendingFunctions list, flushWarnings raises ValueError. Such a call flushes no warnings.
Method test_missingSource Warnings emitted by a function the source code of which is not available can still be flushed.
Method test_renamedSource Warnings emitted by a function defined in a file which has been renamed since it was initially compiled can still be flushed.

Inherited from SynchronousTestCase:

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 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.
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.
Method __init__ Undocumented
Method __eq__ No summary
Method __ne__ Undocumented
Method __hash__ Undocumented
Method shortDescription Undocumented
Method getSkip No summary
Method getTodo No summary
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 run Run the test case, storing the results in result.
Method addCleanup Add the given function to a list of functions to be called after the test has run, but before tearDown.
Method patch Monkey patch an object for the duration of the test.
Method flushLoggedErrors Remove stored errors received from the log.
Method flushWarnings Remove stored warnings from the list of captured warnings and return them.
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 mktemp Create a new path name which can be used for a new file or directory.
Method _getSuppress No summary
Method _getSkipReason Return the reason to use for skipping a test method.
Method _run Run a single method, either a test method or fixture.
Method _runFixturesAndTest Run setUp, a test method, test cleanups, and tearDown.
Method _runCleanups Synchronously run any cleanups which have been added.
Method _installObserver Undocumented
Method _removeObserver Undocumented

Inherited from _Assertions (via SynchronousTestCase):

Method fail Absolutely fail the test. Do not pass go, do not collect $200.
Method assertFalse Fail the test if condition evaluates to True.
Method assertTrue Fail the test if condition evaluates to False.
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 assertEqual Fail the test if first and second are not equal.
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 assertIsNot Fail the test if first is second. This is an obect-identity-equality test, not an object equality (i.e. __eq__) test.
Method assertNotEqual Fail the test if first == second.
Method assertIn Fail the test if containee is not found in container.
Method assertNotIn Fail the test if containee is found in container.
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 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 assertSubstring Fail if substring does not exist within astring.
Method assertNotSubstring Fail if astring contains substring.
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 assertIsInstance Fail if instance is not an instance of the given class or of one of the given classes.
Method assertNotIsInstance Fail if instance is an instance of the given class or of one of the given classes.
Method successResultOf Return the current success result of deferred or raise self.failureException.
Method failureResultOf Return the current failure result of deferred or raise self.failureException.
Method assertNoResult Assert that deferred does not have a result at this point.
Method assertRegex Fail the test if a regexp search of text fails.
def assertDictSubset(self, set, subset):

Assert that all the keys present in subset are also present in set and that the corresponding values are equal.

def assertDictSubsets(self, sets, subsets):

For each pair of corresponding elements in sets and subsets, assert that the element from subsets is a subset of the element from sets.

def test_none(self):

If no warnings are emitted by a test, flushWarnings returns an empty list.

def test_several(self):

If several warnings are emitted by a test, flushWarnings returns a list containing all of them.

def test_repeated(self):

The same warning triggered twice from the same place is included twice in the list returned by flushWarnings.

def test_cleared(self):

After a particular warning event has been returned by flushWarnings, it is not returned by subsequent calls.

def test_unflushed(self):

Any warnings emitted by a test which are not flushed are emitted to the Python warning system.

def test_flushed(self):

Any warnings emitted by a test which are flushed are not emitted to the Python warning system.

def test_warningsConfiguredAsErrors(self):

If a warnings filter has been installed which turns warnings into exceptions, tests have an error added to the reporter for them for each unflushed warning.

def test_flushedWarningsConfiguredAsErrors(self):

If a warnings filter has been installed which turns warnings into exceptions, tests which emit those warnings but flush them do not have an error added to the reporter.

def test_multipleFlushes(self):

Any warnings emitted after a call to flushWarnings can be flushed by another call to flushWarnings.

def test_filterOnOffendingFunction(self):

The list returned by flushWarnings includes only those warnings which refer to the source of the function passed as the value for offendingFunction, if a value is passed for that parameter.

def test_functionBoundaries(self):

Verify that warnings emitted at the very edges of a function are still determined to be emitted from that function.

def test_invalidFilter(self):

If an object which is neither a function nor a method is included in the offendingFunctions list, flushWarnings raises ValueError. Such a call flushes no warnings.

def test_missingSource(self):

Warnings emitted by a function the source code of which is not available can still be flushed.

def test_renamedSource(self):

Warnings emitted by a function defined in a file which has been renamed since it was initially compiled can still be flushed.

This is testing the code which specifically supports working around the unfortunate behavior of CPython to write a .py source file name into the .pyc files it generates and then trust that it is correct in various places. If source files are renamed, .pyc files may not be regenerated, but they will contain incorrect filenames.

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