twisted.trial.unittest.SynchronousTestCase(_Assertions)
class documentationtwisted.trial.unittest
View Source
(View In Hierarchy)
Known subclasses: twisted.trial.unittest.TestCase
A unit test. The atom of the unit testing universe.
This class extends unittest.TestCase
from the standard
library. A number of convenient testing helpers are added, including
logging and warning integration, monkey-patching support, and more.
To write a unit test, subclass SynchronousTestCase
and
define a method (say, 'test_foo') on the subclass. To run the test,
instantiate your subclass with the name of the method, and call run
on the instance, passing a TestResult
object.
The trial
script will automatically find any
SynchronousTestCase
subclasses defined in modules beginning
with 'test_' and construct test cases for all methods beginning with
'test'.
If an error is logged during the test run, the test will fail with an
error. See log.err
.
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:
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. |
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.
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).
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
.
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. Most likely, trial should stop using a set to hold tests, but until it does, this is necessary on Python 2.6. -exarkun
If no methodName
argument is passed to the constructor, run
will treat this method as the thing with the actual test inside.
Run the test case, storing the results in result
.
First runs setUp
on self, then runs the test method
(defined in the constructor), then runs tearDown
. As with the
standard library unittest.TestCase
,
the return value of these methods is disregarded. In particular, returning
a Deferred
has no special additional consequences.
Parameters | result | A TestResult
object. |
Add the given function to a list of functions to be called after the
test has run, but before tearDown
.
Functions will be run in reverse order of being added. This helps ensure that tear down complements set up.
As with all aspects of SynchronousTestCase
,
Deferreds are not supported in cleanup functions.
Monkey patch an object for the duration of the test.
The monkey patch will be reverted at the end of the test using the addCleanup
mechanism.
The monkey.MonkeyPatcher
is returned so that users can restore and re-apply the monkey patch within
their tests.
Parameters | obj | The object to monkey patch. |
attribute | The name of the attribute to change. | |
value | The value to set the attribute to. | |
Returns | A monkey.MonkeyPatcher
object. |
Remove stored errors received from the log.
TestCase
stores each error logged during the run of the
test and reports them as errors during the cleanup phase (after
tearDown
).
Parameters | *errorTypes | If unspecified, flush all errors. Otherwise, only flush errors that match the given types. |
Returns | A list of failures that have been removed. |
Remove stored warnings from the list of captured warnings and return them.
Parameters | offendingFunctions | If None ,
all warnings issued during the currently running test will be flushed.
Otherwise, only warnings which point to a function included in this
list will be flushed. All warnings include a filename and source line
number; if these parts of a warning point to a source line which is part of
a function, then the warning points to that function. (type: None
or list
of functions or methods.) |
Returns | A list , each element of which is a dict giving
information about one warning which was flushed by this call. The keys of
each dict are:
| |
Raises | ValueError | If offendingFunctions is not None
and includes an object which is not a types.FunctionType
or types.MethodType
instance. |
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.
Parameters | version | A 2-sequence of (since, replacement), where since is a the
first version
that f should have been deprecated since, and
replacement is a suggested replacement for the deprecated
functionality, as described by twisted.python.deprecate.deprecated .
If there is no suggested replacement, this parameter may also be simply a
version
by itself. |
f | The deprecated function to call. | |
args | The arguments to pass to f . | |
kwargs | The keyword arguments to pass to f . | |
Returns | Whatever f returns. | |
Raises | Whatever f raises. If any exception is raised by
f , though, no assertions will be made about emitted
deprecations. | |
FailTest | if no warnings were emitted by f , or if the DeprecationWarning
emitted did not produce the canonical please-use-something-else message
that is standard for Twisted deprecations according to the given version
and replacement. |
Create a new path name which can be used for a new file or directory.
The result is a relative path that is guaranteed to be unique within the current working directory. The parent of the path will exist, but the path will not.
For a temporary directory call os.mkdir on the path. For a temporary file just create the file (e.g. by opening the path for writing and then closing it).
Returns | The newly created path (type: str ) |
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.
Returns any empty list (i.e. suppress no warnings) if it cannot find
anything. See TestCase
docstring for more details.
Return the reason to use for skipping a test method.
Parameters | method | The method which produced the skip. |
skip | A unittest.SkipTest
instance raised by method . |
Run a single method, either a test method or fixture.
Parameters | suppress | Any warnings to suppress, as defined by the suppress attribute
on this method, test case, or the module it is defined in. |
todo | Any expected failure or failures, as defined by the todo
attribute on this method, test case, or the module it is defined in. | |
method | The method to run. | |
result | The TestResult instance to which to report results. | |
Returns | True if the method fails and no further method/fixture calls
should be made, False otherwise. |
Run setUp
, a test method, test cleanups, and
tearDown
.
Parameters | result | The TestResult instance to which to report results. |
Synchronously run any cleanups which have been added.