--- a/src/eric7/Documentation/Source/eric7.Testing.Interfaces.TestExecutorBase.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.Testing.Interfaces.TestExecutorBase.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,20 +7,18 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.Testing.Interfaces.TestExecutorBase</h1>
-
<p>
Module implementing the executor base class for the various testing frameworks
and supporting classes.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#TestConfig">TestConfig</a></td>
<td>Class containing the test run configuration.</td>
@@ -38,51 +36,66 @@
<td>Class defining the supported result categories.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="TestConfig" ID="TestConfig"></a>
<h2>TestConfig</h2>
-
<p>
Class containing the test run configuration.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>collectCoverage</td></tr>
+<tr><td>coverageFile</td></tr>
+<tr><td>discover</td></tr>
+<tr><td>discoverOnly</td></tr>
+<tr><td>discoveryStart</td></tr>
+<tr><td>eraseCoverage</td></tr>
+<tr><td>failFast</td></tr>
+<tr><td>failedOnly</td></tr>
+<tr><td>interpreter</td></tr>
+<tr><td>testCases</td></tr>
+<tr><td>testFilename</td></tr>
+<tr><td>testMarkerExpression</td></tr>
+<tr><td>testName</td></tr>
+<tr><td>testNamePattern</td></tr>
+<tr><td>venvName</td></tr>
+</table>
-<table>
-<tr><td>collectCoverage</td></tr><tr><td>coverageFile</td></tr><tr><td>discover</td></tr><tr><td>discoverOnly</td></tr><tr><td>discoveryStart</td></tr><tr><td>eraseCoverage</td></tr><tr><td>failFast</td></tr><tr><td>failedOnly</td></tr><tr><td>interpreter</td></tr><tr><td>testCases</td></tr><tr><td>testFilename</td></tr><tr><td>testMarkerExpression</td></tr><tr><td>testName</td></tr><tr><td>testNamePattern</td></tr><tr><td>venvName</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="TestExecutorBase" ID="TestExecutorBase"></a>
<h2>TestExecutorBase</h2>
-
<p>
Base class for test framework specific implementations.
</p>
+
<h3>Signals</h3>
<dl>
@@ -147,23 +160,22 @@
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
-
<table>
-<tr><td>module</td></tr><tr><td>name</td></tr><tr><td>runner</td></tr>
+<tr><td>module</td></tr>
+<tr><td>name</td></tr>
+<tr><td>runner</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
-
<tr>
<td><a href="#TestExecutorBase.isInstalled">isInstalled</a></td>
<td>Class method to check whether a test framework is installed.</td>
</tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#TestExecutorBase.__init__">TestExecutorBase</a></td>
<td>Constructor</td>
@@ -221,22 +233,23 @@
<td>Public method to indicate the support for test filtering using test name patterns or a test name pattern expression.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="TestExecutorBase.isInstalled" ID="TestExecutorBase.isInstalled"></a>
<h4>TestExecutorBase.isInstalled (class method)</h4>
<b>isInstalled</b>(<i>interpreter</i>)
-
<p>
Class method to check whether a test framework is installed.
</p>
<p>
The test is performed by checking, if a module loader can found.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -259,10 +272,10 @@
<a NAME="TestExecutorBase.__init__" ID="TestExecutorBase.__init__"></a>
<h4>TestExecutorBase (Constructor)</h4>
<b>TestExecutorBase</b>(<i>testWidget</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>testWidget</i> (TestingWidget)</dt>
@@ -273,10 +286,10 @@
<a NAME="TestExecutorBase._prepareProcess" ID="TestExecutorBase._prepareProcess"></a>
<h4>TestExecutorBase._prepareProcess</h4>
<b>_prepareProcess</b>(<i>workDir, pythonpath</i>)
-
<p>
Protected method to prepare a process object to be started.
</p>
+
<dl>
<dt><i>workDir</i> (str)</dt>
@@ -303,10 +316,10 @@
<a NAME="TestExecutorBase.createArguments" ID="TestExecutorBase.createArguments"></a>
<h4>TestExecutorBase.createArguments</h4>
<b>createArguments</b>(<i>config</i>)
-
<p>
Public method to create the arguments needed to start the test process.
</p>
+
<dl>
<dt><i>config</i> (TestConfig)</dt>
@@ -337,10 +350,10 @@
<a NAME="TestExecutorBase.discover" ID="TestExecutorBase.discover"></a>
<h4>TestExecutorBase.discover</h4>
<b>discover</b>(<i>config, pythonpath</i>)
-
<p>
Public method to start the test discovery process.
</p>
+
<dl>
<dt><i>config</i> (TestConfig)</dt>
@@ -367,7 +380,6 @@
<a NAME="TestExecutorBase.finished" ID="TestExecutorBase.finished"></a>
<h4>TestExecutorBase.finished</h4>
<b>finished</b>(<i></i>)
-
<p>
Public method handling the unit test process been finished.
</p>
@@ -375,13 +387,14 @@
This method should read the results (if necessary) and emit the signal
testFinished.
</p>
+
<a NAME="TestExecutorBase.getMarkers" ID="TestExecutorBase.getMarkers"></a>
<h4>TestExecutorBase.getMarkers</h4>
<b>getMarkers</b>(<i>interpreter, workdir</i>)
-
<p>
Public method to get the list of defined markers.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -409,11 +422,11 @@
<a NAME="TestExecutorBase.getVersions" ID="TestExecutorBase.getVersions"></a>
<h4>TestExecutorBase.getVersions</h4>
<b>getVersions</b>(<i>interpreter</i>)
-
<p>
Public method to get the test framework version and version information
of its installed plugins.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -437,10 +450,10 @@
<a NAME="TestExecutorBase.hasCoverage" ID="TestExecutorBase.hasCoverage"></a>
<h4>TestExecutorBase.hasCoverage</h4>
<b>hasCoverage</b>(<i>interpreter</i>)
-
<p>
Public method to check, if the collection of coverage data is available.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -463,10 +476,10 @@
<a NAME="TestExecutorBase.readAllOutput" ID="TestExecutorBase.readAllOutput"></a>
<h4>TestExecutorBase.readAllOutput</h4>
<b>readAllOutput</b>(<i>process=None</i>)
-
<p>
Public method to read all output of the test process.
</p>
+
<dl>
<dt><i>process</i> (QProcess)</dt>
@@ -489,10 +502,10 @@
<a NAME="TestExecutorBase.start" ID="TestExecutorBase.start"></a>
<h4>TestExecutorBase.start</h4>
<b>start</b>(<i>config, pythonpath</i>)
-
<p>
Public method to start the testing process.
</p>
+
<dl>
<dt><i>config</i> (TestConfig)</dt>
@@ -514,10 +527,10 @@
<a NAME="TestExecutorBase.startDebug" ID="TestExecutorBase.startDebug"></a>
<h4>TestExecutorBase.startDebug</h4>
<b>startDebug</b>(<i>config, pythonpath, debugger</i>)
-
<p>
Public method to start the test run with debugger support.
</p>
+
<dl>
<dt><i>config</i> (TestConfig)</dt>
@@ -536,18 +549,18 @@
<a NAME="TestExecutorBase.stopIfRunning" ID="TestExecutorBase.stopIfRunning"></a>
<h4>TestExecutorBase.stopIfRunning</h4>
<b>stopIfRunning</b>(<i></i>)
-
<p>
Public method to stop the testing process, if it is running.
</p>
+
<a NAME="TestExecutorBase.supportsMarkers" ID="TestExecutorBase.supportsMarkers"></a>
<h4>TestExecutorBase.supportsMarkers</h4>
<b>supportsMarkers</b>(<i>interpreter</i>)
-
<p>
Public method to indicate the support for test filtering using markers and/or
marker expressions.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -570,11 +583,11 @@
<a NAME="TestExecutorBase.supportsPatterns" ID="TestExecutorBase.supportsPatterns"></a>
<h4>TestExecutorBase.supportsPatterns</h4>
<b>supportsPatterns</b>(<i>interpreter</i>)
-
<p>
Public method to indicate the support for test filtering using test name
patterns or a test name pattern expression.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -599,65 +612,79 @@
<hr />
<a NAME="TestResult" ID="TestResult"></a>
<h2>TestResult</h2>
-
<p>
Class containing the test result data.
</p>
+
<h3>Derived from</h3>
None
<h3>Class Attributes</h3>
+<table>
+<tr><td>category</td></tr>
+<tr><td>description</td></tr>
+<tr><td>duration</td></tr>
+<tr><td>extra</td></tr>
+<tr><td>filename</td></tr>
+<tr><td>id</td></tr>
+<tr><td>lineno</td></tr>
+<tr><td>message</td></tr>
+<tr><td>name</td></tr>
+<tr><td>status</td></tr>
+<tr><td>subtestResult</td></tr>
+</table>
-<table>
-<tr><td>category</td></tr><tr><td>description</td></tr><tr><td>duration</td></tr><tr><td>extra</td></tr><tr><td>filename</td></tr><tr><td>id</td></tr><tr><td>lineno</td></tr><tr><td>message</td></tr><tr><td>name</td></tr><tr><td>status</td></tr><tr><td>subtestResult</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<div align="right"><a href="#top">Up</a></div>
<hr />
<hr />
<a NAME="TestResultCategory" ID="TestResultCategory"></a>
<h2>TestResultCategory</h2>
-
<p>
Class defining the supported result categories.
</p>
+
<h3>Derived from</h3>
IntEnum
<h3>Class Attributes</h3>
-
<table>
-<tr><td>FAIL</td></tr><tr><td>OK</td></tr><tr><td>PENDING</td></tr><tr><td>RUNNING</td></tr><tr><td>SKIP</td></tr>
+<tr><td>FAIL</td></tr>
+<tr><td>OK</td></tr>
+<tr><td>PENDING</td></tr>
+<tr><td>RUNNING</td></tr>
+<tr><td>SKIP</td></tr>
</table>
-<h3>Class Methods</h3>
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Methods</h3>
-
-<table>
-<tr><td>None</td></tr>
-</table>
-<h3>Static Methods</h3>
-
+<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
+<h3>Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+<h3>Static Methods</h3>
+<table>
+<tr><td>None</td></tr>
+</table>
+
+
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
