summaryrefslogtreecommitdiff
path: root/apidocs/testtools.html
diff options
context:
space:
mode:
Diffstat (limited to 'apidocs/testtools.html')
-rw-r--r--apidocs/testtools.html212
1 files changed, 212 insertions, 0 deletions
diff --git a/apidocs/testtools.html b/apidocs/testtools.html
new file mode 100644
index 0000000..517deb8
--- /dev/null
+++ b/apidocs/testtools.html
@@ -0,0 +1,212 @@
+<?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 : 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="package"><code>testtools</code> <small>package documentation</small></h1>
+
+ <span id="partOf">
+
+
+
+ </span>
+ </div>
+
+ <div class="extrasDocstring">
+
+ </div>
+
+ <div class="moduleDocstring">
+ <div>Extensions to the standard Python unittest library.<table class="fieldTable"></table></div>
+ </div>
+
+ <div id="splitTables">
+ <table class="children sortable" id="id1">
+
+ <tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.assertions.html" class="code">assertions</a></td>
+ <td><span class="undocumented">No module docstring; 1/1 functions documented</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.compat.html" class="code">compat</a></td>
+ <td><span>Compatibility support for python 2 and 3.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.content.html" class="code">content</a></td>
+ <td><span>Content - a MIME-like Content object.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.content_type.html" class="code">content_type</a></td>
+ <td><span>ContentType - a MIME Content Type.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.deferredruntest.html" class="code">deferredruntest</a></td>
+ <td><span>Individual test case execution for tests that return Deferreds.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.distutilscmd.html" class="code">distutilscmd</a></td>
+ <td><span>Extensions to the standard Python unittest library.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.helpers.html" class="code">helpers</a></td>
+ <td><span class="undocumented">No module docstring; 4/4 functions documented</span></td>
+ </tr><tr class="package">
+
+ <td>Package</td>
+ <td><a href="testtools.matchers.html" class="code">matchers</a></td>
+ <td><span>All the matchers.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.monkey.html" class="code">monkey</a></td>
+ <td><span>Helpers for monkey-patching Python code.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.run.html" class="code">run</a></td>
+ <td><span>python -m testtools.run testspec [testspec...]</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.runtest.html" class="code">runtest</a></td>
+ <td><span>Individual test case execution.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.tags.html" class="code">tags</a></td>
+ <td><span>Tag support.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.testcase.html" class="code">testcase</a></td>
+ <td><span>Test case related stuff.</span></td>
+ </tr><tr class="package">
+
+ <td>Package</td>
+ <td><a href="testtools.testresult.html" class="code">testresult</a></td>
+ <td><span>Test result objects.</span></td>
+ </tr><tr class="package">
+
+ <td>Package</td>
+ <td><a href="testtools.tests.html" class="code">tests</a></td>
+ <td><span>Tests for testtools itself.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.testsuite.html" class="code">testsuite</a></td>
+ <td><span>Test suites and related things.</span></td>
+ </tr><tr class="module">
+
+ <td>Module</td>
+ <td><a href="testtools.utils.html" class="code">utils</a></td>
+ <td><span>Utilities for dealing with stuff in unittest.</span></td>
+ </tr><tr class="module private">
+
+ <td>Module</td>
+ <td><a href="testtools._compat2x.html" class="code">_compat2x</a></td>
+ <td><span>Compatibility helpers that are valid syntax in Python 2.x.</span></td>
+ </tr><tr class="module private">
+
+ <td>Module</td>
+ <td><a href="testtools._compat3x.html" class="code">_compat3x</a></td>
+ <td><span>Compatibility helpers that are valid syntax in Python 3.x.</span></td>
+ </tr><tr class="module private">
+
+ <td>Module</td>
+ <td><a href="testtools._spinner.html" class="code">_spinner</a></td>
+ <td><span>Evil reactor-spinning logic for running Twisted tests.</span></td>
+ </tr>
+</table>
+
+
+ <p class="fromInitPy">From the <code>__init__.py</code> module:</p><table class="children sortable" id="id2">
+
+ <tr class="class">
+
+ <td>Class</td>
+ <td><a href="testtools.DecorateTestCaseResult.html" class="code">DecorateTestCaseResult</a></td>
+ <td><span>Decorate a TestCase and permit customisation of the result for runs.</span></td>
+ </tr><tr class="function">
+
+ <td>Function</td>
+ <td><a href="testtools.html#ErrorHolder" class="code">ErrorHolder</a></td>
+ <td><span>Construct an <a href="testtools.html#ErrorHolder"><code>ErrorHolder</code></a>.</span></td>
+ </tr><tr class="class">
+
+ <td>Class</td>
+ <td><a href="testtools.FixtureSuite.html" class="code">FixtureSuite</a></td>
+ <td><span class="undocumented">Undocumented</span></td>
+ </tr><tr class="class">
+
+ <td>Class</td>
+ <td><a href="testtools.PlaceHolder.html" class="code">PlaceHolder</a></td>
+ <td><span>A placeholder test.</span></td>
+ </tr><tr class="class">
+
+ <td>Class</td>
+ <td><a href="testtools.TestCommand.html" class="code">TestCommand</a></td>
+ <td><span>Command to run unit tests with testtools</span></td>
+ </tr>
+</table>
+ </div>
+
+ <div id="childList">
+
+ <div class="function">
+ <a name="testtools.ErrorHolder">
+
+ </a>
+ <a name="ErrorHolder">
+
+ </a>
+ <div class="functionHeader">
+
+ def
+ ErrorHolder(test_id, error, short_description=None, details=None):
+
+ </div>
+ <div class="docstring functionBody">
+
+ <div>Construct an <a href="testtools.html#ErrorHolder"><code>ErrorHolder</code></a>.<table class="fieldTable"><tr class="fieldStart"><td class="fieldName">Parameters</td><td class="fieldArg">test_id</td><td>The id of the test.</td></tr><tr><td></td><td class="fieldArg">error</td><td>The exc info tuple that will be used as the test's error.
+This is inserted into the details as 'traceback' - any existing key
+will be overridden.</td></tr><tr><td></td><td class="fieldArg">short_description</td><td>An optional short description of the test.</td></tr><tr><td></td><td class="fieldArg">details</td><td>Outcome details as accepted by addSuccess etc.</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
View Lorry Controller Status