A collection of utility functions and classes, used internally by Trial.
This code is for Trial's internal use. Do NOT use this code if you are writing tests. It is subject to change at the Trial maintainer's whim. There is nothing here in this module for you to use unless you are maintaining Trial.
Any non-Trial Twisted code that uses this module will be shot.
Maintainer: Jonathan Lange
|Variable||DEFAULT_TIMEOUT_DURATION||The default timeout which will be applied to asynchronous (ie, Deferred-returning) test methods, in seconds.|
|Function||acquireAttribute||Go through the list 'objects' sequentially until we find one which has attribute 'attr', then return the value of that attribute. If not found, return 'default' if set, otherwise, raise AttributeError.|
|Function||excInfoOrFailureToExcInfo||Coerce a Failure to an _exc_info, if err is a Failure.|
|Function||suppress||Sets up the .suppress tuple properly, pass options to this method as you would the stdlib warnings.filterwarnings()|
|Class||_Janitor||The guy that cleans up after you.|
|Function||_runSequentially||Run the given callables one after the other. If a callable returns a Deferred, wait until it has finished before running the next callable.|
|Class||_NoTrialMarker||No trial marker file could be found.|
|Function||_removeSafely||Safely remove a path, recursively.|
|Class||_WorkingDirectoryBusy||A working directory was specified to the runner, but another test run is currently using that directory.|
|Function||_unusedTestDirectory||Find an unused directory named similarly to
|Function||_listToPhrase||Produce a string containing each thing in
Go through the list 'objects' sequentially until we find one which has attribute 'attr', then return the value of that attribute. If not found, return 'default' if set, otherwise, raise AttributeError.
Sets up the .suppress tuple properly, pass options to this method as you would the stdlib warnings.filterwarnings()
So, to use this with a .suppress magic attribute you would do the following:
>>> from twisted.trial import unittest, util >>> import warnings >>> >>> class TestFoo(unittest.TestCase): ... def testFooBar(self): ... warnings.warn("i am deprecated", DeprecationWarning) ... testFooBar.suppress = [util.suppress(message='i am deprecated')] ... >>>
Note that as with the todo and timeout attributes: the module level attribute acts as a default for the class attribute which acts as a default for the method attribute. The suppress attribute can be overridden at any level by specifying
.suppress = 
Run the given callables one after the other. If a callable returns a Deferred, wait until it has finished before running the next callable.
|Parameters||callables||An iterable of callables that take no parameters.|
|stopOnFirstError||If True, then stop running callables as soon as one raises an exception or fires an errback. False by default.|
Safely remove a path, recursively.
path does not contain a node named
_NoTrialMarker exception is raised and the path is not removed.
Find an unused directory named similarly to
Once a directory is found, it will be locked and a marker dropped into it to identify it as a trial temporary directory.
|Parameters||base||A template path for the discovery process. If this path exactly cannot be used, a path which varies only in a suffix of the basename will be used instead. (type: |
|Returns||A two-tuple. The first element is a |
Produce a string containing each thing in
things, separated by a
delimiter, with the last couple being separated by
|Parameters||things||The elements of the resulting phrase (type: |
|finalDelimiter||What to put between the last two things (typically 'and' or 'or') (type: |
|delimiter||The separator to use between each thing, not including the last two. Should typically include a trailing space. (type: |
|Returns||The resulting phrase (type: |