diff options
Diffstat (limited to 'apidocs/testtools.tests.helpers.LoggingResult.html')
| -rw-r--r-- | apidocs/testtools.tests.helpers.LoggingResult.html | 420 |
1 files changed, 420 insertions, 0 deletions
diff --git a/apidocs/testtools.tests.helpers.LoggingResult.html b/apidocs/testtools.tests.helpers.LoggingResult.html new file mode 100644 index 0000000..8158620 --- /dev/null +++ b/apidocs/testtools.tests.helpers.LoggingResult.html @@ -0,0 +1,420 @@ +<?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.tests.helpers.LoggingResult : 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.tests.helpers.LoggingResult(<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.tests.html" class="code">tests</a>.<a href="testtools.tests.helpers.html" class="code">helpers</a></code> + + <a href="classIndex.html#testtools.tests.helpers.LoggingResult">(View In Hierarchy)</a> + </span> + </div> + + <div class="extrasDocstring"> + + </div> + + <div class="moduleDocstring"> + <div>TestResult that logs its event to a list.<table class="fieldTable"></table></div> + </div> + + <div id="splitTables"> + <table class="children sortable" id="id338"> + + <tr class="method"> + + <td>Method</td> + <td><a href="testtools.tests.helpers.LoggingResult.html#__init__" class="code">__init__</a></td> + <td><span class="undocumented">Undocumented</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.tests.helpers.LoggingResult.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.tests.helpers.LoggingResult.html#stop" class="code">stop</a></td> + <td><span class="undocumented">Undocumented</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.tests.helpers.LoggingResult.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.tests.helpers.LoggingResult.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.tests.helpers.LoggingResult.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.tests.helpers.LoggingResult.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.tests.helpers.LoggingResult.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.tests.helpers.LoggingResult.html#startTestRun" class="code">startTestRun</a></td> + <td><span>Called before a test run starts.</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.tests.helpers.LoggingResult.html#stopTestRun" class="code">stopTestRun</a></td> + <td><span>Called after a test run completes</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.tests.helpers.LoggingResult.html#done" class="code">done</a></td> + <td><span>Called when the test runner is done.</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.tests.helpers.LoggingResult.html#tags" class="code">tags</a></td> + <td><span>Add and remove tags from the test.</span></td> + </tr><tr class="method"> + + <td>Method</td> + <td><a href="testtools.tests.helpers.LoggingResult.html#time" class="code">time</a></td> + <td><span>Provide a timestamp to represent the current time.</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="id339"> + + <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#addExpectedFailure" class="code">addExpectedFailure</a></td> + <td><span>Called when a test has failed in an expected manner.</span></td> + </tr><tr class="basemethod"> + + <td>Method</td> + <td><a href="testtools.testresult.real.TestResult.html#addUnexpectedSuccess" class="code">addUnexpectedSuccess</a></td> + <td><span>Called when a test was expected to fail, but succeed.</span></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#current_tags" class="code">current_tags</a></td> + <td><span>The currently set tags.</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.tests.helpers.LoggingResult.__init__"> + + </a> + <a name="__init__"> + + </a> + <div class="functionHeader"> + + def + __init__(self, log): + + </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 class="undocumented">Undocumented</div> + </div> +</div><div class="function"> + <a name="testtools.tests.helpers.LoggingResult.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.tests.helpers.LoggingResult.stop"> + + </a> + <a name="stop"> + + </a> + <div class="functionHeader"> + + def + stop(self): + + </div> + <div class="docstring functionBody"> + + <div class="undocumented">Undocumented</div> + </div> +</div><div class="function"> + <a name="testtools.tests.helpers.LoggingResult.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.tests.helpers.LoggingResult.addFailure"> + + </a> + <a name="addFailure"> + + </a> + <div class="functionHeader"> + + def + addFailure(self, test, error): + + </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.tests.helpers.LoggingResult.addError"> + + </a> + <a name="addError"> + + </a> + <div class="functionHeader"> + + def + addError(self, test, error): + + </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.tests.helpers.LoggingResult.addSkip"> + + </a> + <a name="addSkip"> + + </a> + <div class="functionHeader"> + + def + addSkip(self, test, reason): + + </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.tests.helpers.LoggingResult.addSuccess"> + + </a> + <a name="addSuccess"> + + </a> + <div class="functionHeader"> + + def + addSuccess(self, test): + + </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.tests.helpers.LoggingResult.startTestRun"> + + </a> + <a name="startTestRun"> + + </a> + <div class="functionHeader"> + + def + startTestRun(self): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#startTestRun" class="code">testtools.testresult.real.TestResult.startTestRun</a></div> + <div><p>Called before a test run starts.</p> +<p>New in Python 2.7. The testtools version resets the result to a +pristine condition ready for use in another test run. Note that this +is different from Python 2.7's startTestRun, which does nothing.</p><table class="fieldTable"></table></div> + </div> +</div><div class="function"> + <a name="testtools.tests.helpers.LoggingResult.stopTestRun"> + + </a> + <a name="stopTestRun"> + + </a> + <div class="functionHeader"> + + def + stopTestRun(self): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#stopTestRun" class="code">testtools.testresult.real.TestResult.stopTestRun</a></div> + <div><p>Called after a test run completes</p> +<p>New in python 2.7</p><table class="fieldTable"></table></div> + </div> +</div><div class="function"> + <a name="testtools.tests.helpers.LoggingResult.done"> + + </a> + <a name="done"> + + </a> + <div class="functionHeader"> + + def + done(self): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#done" class="code">testtools.testresult.real.TestResult.done</a></div> + <div><p>Called when the test runner is done.</p> +<p>deprecated in favour of stopTestRun.</p><table class="fieldTable"></table></div> + </div> +</div><div class="function"> + <a name="testtools.tests.helpers.LoggingResult.tags"> + + </a> + <a name="tags"> + + </a> + <div class="functionHeader"> + + def + tags(self, new_tags, gone_tags): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#tags" class="code">testtools.testresult.real.TestResult.tags</a></div> + <div>Add and remove tags from the test.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">new_tags</td><td>A set of tags to be added to the stream.</td></tr><tr><td></td><td class="fieldArg">gone_tags</td><td>A set of tags to be removed from the stream.</td></tr></table></div> + </div> +</div><div class="function"> + <a name="testtools.tests.helpers.LoggingResult.time"> + + </a> + <a name="time"> + + </a> + <div class="functionHeader"> + + def + time(self, a_datetime): + + </div> + <div class="docstring functionBody"> + <div class="interfaceinfo">overrides <a href="testtools.testresult.real.TestResult.html#time" class="code">testtools.testresult.real.TestResult.time</a></div> + <div><p>Provide a timestamp to represent the current time.</p> +<p>This is useful when test activity is time delayed, or happening +concurrently and getting the system time between API calls will not +accurately represent the duration of tests (or the whole run).</p> +<p>Calling time() sets the datetime used by the TestResult object. +Time is permitted to go backwards when using this call.</p><table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">a_datetime</td><td>A datetime.datetime object with TZ information or +None to reset the TestResult to gathering time from the system.</td></tr></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 |