diff options
Diffstat (limited to 'apidocs/testtools.testresult.TestByTestResult.html')
| -rw-r--r-- | apidocs/testtools.testresult.TestByTestResult.html | 363 |
1 files changed, 363 insertions, 0 deletions
diff --git a/apidocs/testtools.testresult.TestByTestResult.html b/apidocs/testtools.testresult.TestByTestResult.html new file mode 100644 index 0000000..cef646c --- /dev/null +++ b/apidocs/testtools.testresult.TestByTestResult.html @@ -0,0 +1,363 @@ +<?xml version="1.0" encoding="utf-8"?> +<!DOCTYPE html PUBLIC "-//W3C//DTD XHTML 1.0 Strict//EN" + "DTD/xhtml1-strict.dtd"> +<html> + <head> + <title>testtools.testresult.TestByTestResult : API documentation</title> + + <meta content="text/html;charset=utf-8" http-equiv="Content-Type" /> + <link href="bootstrap.min.css" type="text/css" rel="stylesheet" /> + <link href="apidocs.css" type="text/css" rel="stylesheet" /> + </head> + <body> + + <nav class="navbar navbar-default"> + <div class="container"> + <div class="navbar-header"> + <a href="index.html" class="navbar-brand"> + <a href="https://github.com/testing-cabal/testtools">testtools</a> API Documentation + </a> + </div> + </div> + </nav> + + <div class="container"> + + <div class="page-header"> + <h1 class="class"><code>testtools.testresult.TestByTestResult(<a href="testtools.testresult.real.TestResult.html" class="code">TestResult</a>)</code> <small>class documentation</small></h1> + + <span id="partOf"> + Part of <code><a href="testtools.html" class="code">testtools</a>.<a href="testtools.testresult.html" class="code">testresult</a></code> + + <a href="classIndex.html#testtools.testresult.TestByTestResult">(View In Hierarchy)</a> + </span> + </div> + + <div class="extrasDocstring"> + + </div> + + <div class="moduleDocstring"> + <div>Call something every time a test completes.<table class="fieldTable"></table></div> + </div> + + <div id="splitTables"> + <table class="children sortable" id="id96"> + + <tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#__init__" class="code">__init__</a></td> + <td><span>Construct a <tt class="rst-docutils literal">TestByTestResult</tt>.</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#startTest" class="code">startTest</a></td> + <td><span class="undocumented">Undocumented</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#stopTest" class="code">stopTest</a></td> + <td><span class="undocumented">Undocumented</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#addSuccess" class="code">addSuccess</a></td> + <td><span>Called when a test succeeded.</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#addFailure" class="code">addFailure</a></td> + <td><span>Called when an error has occurred. 'err' is a tuple of values as returned by sys.exc_info().</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#addError" class="code">addError</a></td> + <td><span>Called when an error has occurred. 'err' is a tuple of values as returned by sys.exc_info().</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#addSkip" class="code">addSkip</a></td> + <td><span>Called when a test has been skipped rather than running.</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#addExpectedFailure" class="code">addExpectedFailure</a></td> + <td><span>Called when a test has failed in an expected manner.</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#addUnexpectedSuccess" class="code">addUnexpectedSuccess</a></td> + <td><span>Called when a test was expected to fail, but succeed.</span></td> + </tr><tr class="method private"> + + <td>Method</td> + <td><a href="testtools.testresult.TestByTestResult.html#_err_to_details" class="code">_err_to_details</a></td> + <td><span class="undocumented">Undocumented</span></td> + </tr> +</table> + + <p class="inheritedFrom"> + Inherited from <a href="testtools.testresult.real.TestResult.html" class="code">TestResult</a>: + </p> + <table class="children sortable" id="id97"> + + <tr class="baseinstancevariable"> + + <td>Instance Variable</td> + <td><a href="testtools.testresult.real.TestResult.html#skip_reasons" class="code">skip_reasons</a></td> + <td>A dict of skip-reasons -> list of tests. See addSkip.</td> + </tr><tr class="basemethod"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#wasSuccessful" class="code">wasSuccessful</a></td> + <td><span>Has this result been successful so far?</span></td> + </tr><tr class="basemethod"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#startTestRun" class="code">startTestRun</a></td> + <td><span>Called before a test run starts.</span></td> + </tr><tr class="basemethod"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#stopTestRun" class="code">stopTestRun</a></td> + <td><span>Called after a test run completes</span></td> + </tr><tr class="basemethod"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#current_tags" class="code">current_tags</a></td> + <td><span>The currently set tags.</span></td> + </tr><tr class="basemethod"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#tags" class="code">tags</a></td> + <td><span>Add and remove tags from the test.</span></td> + </tr><tr class="basemethod"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#time" class="code">time</a></td> + <td><span>Provide a timestamp to represent the current time.</span></td> + </tr><tr class="basemethod"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#done" class="code">done</a></td> + <td><span>Called when the test runner is done.</span></td> + </tr><tr class="basemethod private"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#_err_details_to_string" class="code">_err_details_to_string</a></td> + <td><span>Convert an error in exc_info form or a contents dict to a string.</span></td> + </tr><tr class="basemethod private"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#_exc_info_to_unicode" class="code">_exc_info_to_unicode</a></td> + <td><span class="undocumented">Undocumented</span></td> + </tr><tr class="basemethod private"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#_now" class="code">_now</a></td> + <td><span>Return the current 'test time'.</span></td> + </tr> +</table> + + + + </div> + + <div id="childList"> + + <div class="function"> + <a name="testtools.testresult.TestByTestResult.__init__"> + + </a> + <a name="__init__"> + + </a> + <div class="functionHeader"> + + def + __init__(self, on_test): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#__init__" class="code">testtools.testresult.real.TestResult.__init__</a></div> + <div>Construct a <tt class="rst-docutils literal">TestByTestResult</tt>.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">on_test</td><td>A callable that take a test case, a status (one of +"success", "failure", "error", "skip", or "xfail"), a start time +(a <tt class="rst-docutils literal">datetime</tt> with timezone), a stop time, an iterable of tags, +and a details dict. Is called at the end of each test (i.e. on +<tt class="rst-docutils literal">stopTest</tt>) with the accumulated values for that test.</td></tr></table></div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult.startTest"> + + </a> + <a name="startTest"> + + </a> + <div class="functionHeader"> + + def + startTest(self, test): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#startTest" class="code">testtools.testresult.real.TestResult.startTest</a></div> + <div class="undocumented">Undocumented</div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult.stopTest"> + + </a> + <a name="stopTest"> + + </a> + <div class="functionHeader"> + + def + stopTest(self, test): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#stopTest" class="code">testtools.testresult.real.TestResult.stopTest</a></div> + <div class="undocumented">Undocumented</div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult._err_to_details"> + + </a> + <a name="_err_to_details"> + + </a> + <div class="functionHeader"> + + def + _err_to_details(self, test, err, details): + + </div> + <div class="docstring functionBody"> + + <div class="undocumented">Undocumented</div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult.addSuccess"> + + </a> + <a name="addSuccess"> + + </a> + <div class="functionHeader"> + + def + addSuccess(self, test, details=None): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#addSuccess" class="code">testtools.testresult.real.TestResult.addSuccess</a></div> + <div>Called when a test succeeded.<table class="fieldTable"></table></div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult.addFailure"> + + </a> + <a name="addFailure"> + + </a> + <div class="functionHeader"> + + def + addFailure(self, test, err=None, details=None): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#addFailure" class="code">testtools.testresult.real.TestResult.addFailure</a></div> + <div>Called when an error has occurred. 'err' is a tuple of values as +returned by sys.exc_info().<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">details</td><td>Alternative way to supply details about the outcome. +see the class docstring for more information.</td></tr></table></div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult.addError"> + + </a> + <a name="addError"> + + </a> + <div class="functionHeader"> + + def + addError(self, test, err=None, details=None): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#addError" class="code">testtools.testresult.real.TestResult.addError</a></div> + <div>Called when an error has occurred. 'err' is a tuple of values as +returned by sys.exc_info().<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">details</td><td>Alternative way to supply details about the outcome. +see the class docstring for more information.</td></tr></table></div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult.addSkip"> + + </a> + <a name="addSkip"> + + </a> + <div class="functionHeader"> + + def + addSkip(self, test, reason=None, details=None): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#addSkip" class="code">testtools.testresult.real.TestResult.addSkip</a></div> + <div><p>Called when a test has been skipped rather than running.</p> +<p>Like with addSuccess and addError, testStopped should still be called.</p> +<p>This must be called by the TestCase. 'addError' and 'addFailure' will +not call addSkip, since they have no assumptions about the kind of +errors that a test can raise.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">test</td><td>The test that has been skipped.</td></tr><tr><td></td><td class="fieldArg">reason</td><td>The reason for the test being skipped. For instance, +u"pyGL is not available".</td></tr><tr><td></td><td class="fieldArg">details</td><td>Alternative way to supply details about the outcome. +see the class docstring for more information.</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">None</td></tr></table></div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult.addExpectedFailure"> + + </a> + <a name="addExpectedFailure"> + + </a> + <div class="functionHeader"> + + def + addExpectedFailure(self, test, err=None, details=None): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#addExpectedFailure" class="code">testtools.testresult.real.TestResult.addExpectedFailure</a></div> + <div><p>Called when a test has failed in an expected manner.</p> +<p>Like with addSuccess and addError, testStopped should still be called.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">test</td><td>The test that has been skipped.</td></tr><tr><td></td><td class="fieldArg">err</td><td>The exc_info of the error that was raised.</td></tr><tr class="fieldStart"><td class="fieldName">Returns</td><td colspan="2">None</td></tr></table></div> + </div> +</div><div class="function"> + <a name="testtools.testresult.TestByTestResult.addUnexpectedSuccess"> + + </a> + <a name="addUnexpectedSuccess"> + + </a> + <div class="functionHeader"> + + def + addUnexpectedSuccess(self, test, details=None): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#addUnexpectedSuccess" class="code">testtools.testresult.real.TestResult.addUnexpectedSuccess</a></div> + <div>Called when a test was expected to fail, but succeed.<table class="fieldTable"></table></div> + </div> +</div> + + </div> + <address> + <a href="index.html">API Documentation</a> for <a href="https://github.com/testing-cabal/testtools">testtools</a>, generated by <a href="https://github.com/twisted/pydoctor/">pydoctor</a> at 2015-07-01 16:11:28. + </address> + + </div> + </body> +</html>
\ No newline at end of file |