--- /dev/null Thu Jan 01 00:00:00 1970 +0000 +++ b/eric7/Documentation/Source/eric7.Testing.Interfaces.UnittestExecutor.html Mon May 23 18:15:10 2022 +0200 @@ -0,0 +1,232 @@ +<!DOCTYPE html> +<html><head> +<title>eric7.Testing.Interfaces.UnittestExecutor</title> +<meta charset="UTF-8"> +<link rel="stylesheet" href="styles.css"> +</head> +<body> +<a NAME="top" ID="top"></a> +<h1>eric7.Testing.Interfaces.UnittestExecutor</h1> + +<p> +Module implementing the executor for the standard 'unittest' framework. +</p> +<h3>Global Attributes</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Classes</h3> + +<table> + +<tr> +<td><a href="#UnittestExecutor">UnittestExecutor</a></td> +<td>Class implementing the executor for the standard 'unittest' framework.</td> +</tr> +</table> +<h3>Functions</h3> + +<table> +<tr><td>None</td></tr> +</table> +<hr /> +<hr /> +<a NAME="UnittestExecutor" ID="UnittestExecutor"></a> +<h2>UnittestExecutor</h2> + +<p> + Class implementing the executor for the standard 'unittest' framework. +</p> +<h3>Derived from</h3> +TestExecutorBase +<h3>Class Attributes</h3> + +<table> +<tr><td>module</td></tr><tr><td>name</td></tr><tr><td>runner</td></tr> +</table> +<h3>Class Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> +<h3>Methods</h3> + +<table> + +<tr> +<td><a href="#UnittestExecutor.__init__">UnittestExecutor</a></td> +<td>Constructor</td> +</tr> +<tr> +<td><a href="#UnittestExecutor.__processData">__processData</a></td> +<td>Private slot to process the received data.</td> +</tr> +<tr> +<td><a href="#UnittestExecutor.createArguments">createArguments</a></td> +<td>Public method to create the arguments needed to start the test process.</td> +</tr> +<tr> +<td><a href="#UnittestExecutor.finished">finished</a></td> +<td>Public method handling the unit test process been finished.</td> +</tr> +<tr> +<td><a href="#UnittestExecutor.getVersions">getVersions</a></td> +<td>Public method to get the test framework version and version information of its installed plugins.</td> +</tr> +<tr> +<td><a href="#UnittestExecutor.hasCoverage">hasCoverage</a></td> +<td>Public method to get the test framework version and version information of its installed plugins.</td> +</tr> +<tr> +<td><a href="#UnittestExecutor.start">start</a></td> +<td>Public method to start the testing process.</td> +</tr> +</table> +<h3>Static Methods</h3> + +<table> +<tr><td>None</td></tr> +</table> + +<a NAME="UnittestExecutor.__init__" ID="UnittestExecutor.__init__"></a> +<h4>UnittestExecutor (Constructor)</h4> +<b>UnittestExecutor</b>(<i>testWidget</i>) + +<p> + Constructor +</p> +<dl> + +<dt><i>testWidget</i> (TestingWidget)</dt> +<dd> +reference to the unit test widget +</dd> +</dl> +<a NAME="UnittestExecutor.__processData" ID="UnittestExecutor.__processData"></a> +<h4>UnittestExecutor.__processData</h4> +<b>__processData</b>(<i>data</i>) + +<p> + Private slot to process the received data. +</p> +<dl> + +<dt><i>data</i> (dict)</dt> +<dd> +data object received +</dd> +</dl> +<a NAME="UnittestExecutor.createArguments" ID="UnittestExecutor.createArguments"></a> +<h4>UnittestExecutor.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> +<dd> +configuration for the test execution +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +list of process arguments +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +list of str +</dd> +</dl> +<a NAME="UnittestExecutor.finished" ID="UnittestExecutor.finished"></a> +<h4>UnittestExecutor.finished</h4> +<b>finished</b>(<i></i>) + +<p> + Public method handling the unit test process been finished. +</p> +<p> + This method should read the results (if necessary) and emit the signal + testFinished. +</p> +<a NAME="UnittestExecutor.getVersions" ID="UnittestExecutor.getVersions"></a> +<h4>UnittestExecutor.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> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +dictionary containing the framework name and version and the + list of available plugins with name and version each +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +dict +</dd> +</dl> +<a NAME="UnittestExecutor.hasCoverage" ID="UnittestExecutor.hasCoverage"></a> +<h4>UnittestExecutor.hasCoverage</h4> +<b>hasCoverage</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> +<dd> +interpreter to be used for the test +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating the availability of coverage functionality +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> +<a NAME="UnittestExecutor.start" ID="UnittestExecutor.start"></a> +<h4>UnittestExecutor.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> +<dd> +configuration for the test execution +</dd> +<dt><i>pythonpath</i> (list of str)</dt> +<dd> +list of directories to be added to the Python path +</dd> +</dl> +<div align="right"><a href="#top">Up</a></div> +<hr /> +</body></html> \ No newline at end of file