twisted.trial.unittest : API documentation

Class	SkipTest	Raise this (with a reason) to skip the current test. You may also set method.skip to a reason string to skip it, or set class.skip to skip the entire TestCase.
Class	FailTest	Raised to indicate the current test has failed to pass.
Class	Todo	No summary
Function	makeTodo	Return a `Todo` object built from `value`.
Class	TestCase	A unit test. The atom of the unit testing universe.
Class	UnsupportedTrialFeature	A feature of twisted.trial was used that pyunit cannot support.
Class	PyUnitResultAdapter	No summary
Class	TestDecorator	Decorator for test cases.
Function	decorate	Decorate all test cases in `test` with `decorator`.
Function	__iter__	Undocumented
Class	_Warning	No summary
Function	_collectWarnings	Call `f` with `args` positional arguments and `kwargs` keyword arguments and collect all warnings which are emitted as a result in a list.
Class	_Assertions	Replaces many of the built-in TestCase assertions. In general, these assertions provide better error messages and are easier to use in callbacks. Also provides new assertions such as `failUnlessFailure`.
Class	_LogObserver	Observes the Twisted logs and catches any errors.
Function	_clearSuite	Clear all tests from `suite`.
Class	_PyUnitTestCaseAdapter	Adapt from pyunit.TestCase to ITestCase.
Class	_BrokenIDTestCaseAdapter	Adapter for pyunit-style `TestCase` subclasses that have undesirable id() methods. That is `pyunit.FunctionTestCase` and `pyunit.DocTestCase`.
Class	_ForceGarbageCollectionDecorator	Forces garbage collection to be run before and after the test. Any errors logged during the post-test collection are added to the test result as errors.
Function	_iterateTests	Iterate through all of the test cases in `testSuiteOrCase`.
Class	_SubTestCase	Undocumented
Function	_deprecate	Internal method used to deprecate top-level assertions. Do not use this.

def makeTodo(value): (source)

Return a Todo object built from value.

If value is a string, return a Todo that expects any exception with value as a reason. If value is a tuple, the second element is used as the reason and the first element as the excepted error(s).

Parameters	value	A string or a tuple of `(errors, reason)`, where `errors` is either a single exception class or an iterable of exception classes.
Returns	A `Todo` object.

def _collectWarnings(observeWarning, f, *args, **kwargs): (source)

Call f with args positional arguments and kwargs keyword arguments and collect all warnings which are emitted as a result in a list.

Parameters	observeWarning	A callable which will be invoked with a `_Warning` instance each time a warning is emitted.
Returns	The return value of `f(args, *kwargs)`.

def decorate(test, decorator): (source)

Decorate all test cases in test with decorator.

test can be a test case or a test suite. If it is a test suite, then the structure of the suite is preserved.

decorate tries to preserve the class of the test suites it finds, but assumes the presence of the _tests attribute on the suite.

Parameters	test	The `TestCase` or `TestSuite` to decorate.
	decorator	A unary callable used to decorate `TestCase`s.
Returns	A decorated `TestCase` or a `TestSuite` containing decorated `TestCase`s.

t.t.unittest : module documentation