diff -r de9106c55c3d -r 856476537696 src/eric7/Documentation/Source/eric7.Testing.Interfaces.PytestRunner.html --- a/src/eric7/Documentation/Source/eric7.Testing.Interfaces.PytestRunner.html Thu Jan 04 17:16:15 2024 +0100 +++ b/src/eric7/Documentation/Source/eric7.Testing.Interfaces.PytestRunner.html Thu Jan 04 18:02:25 2024 +0100 @@ -7,19 +7,18 @@ <body> <a NAME="top" ID="top"></a> <h1>eric7.Testing.Interfaces.PytestRunner</h1> - <p> Module implementing the test runner script for the 'pytest' framework. </p> + <h3>Global Attributes</h3> - <table> -<tr><td>command</td></tr><tr><td>writer</td></tr> +<tr><td>command</td></tr> +<tr><td>writer</td></tr> </table> + <h3>Classes</h3> - <table> - <tr> <td><a href="#EricPlugin">EricPlugin</a></td> <td>Class implementing a pytest plugin which reports the data in a format suitable for the PytestExecutor.</td> @@ -33,10 +32,9 @@ <td>Class implementing a pytest plugin to extract the version info of all installed plugins.</td> </tr> </table> + <h3>Functions</h3> - <table> - <tr> <td><a href="#getMarkers">getMarkers</a></td> <td>Function to determine the defined markers and their descriptions.</td> @@ -46,31 +44,30 @@ <td>Function to determine the framework version and versions of all available plugins.</td> </tr> </table> + <hr /> <hr /> <a NAME="EricPlugin" ID="EricPlugin"></a> <h2>EricPlugin</h2> - <p> Class implementing a pytest plugin which reports the data in a format suitable for the PytestExecutor. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#EricPlugin.__init__">EricPlugin</a></td> <td>Constructor</td> @@ -112,19 +109,20 @@ <td>Public method called by pytest before performing collection and entering the run test loop.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="EricPlugin.__init__" ID="EricPlugin.__init__"></a> <h4>EricPlugin (Constructor)</h4> <b>EricPlugin</b>(<i>writer</i>) - <p> Constructor </p> + <dl> <dt><i>writer</i> (EricJsonWriter)</dt> @@ -135,17 +133,17 @@ <a NAME="EricPlugin.__initializeReportData" ID="EricPlugin.__initializeReportData"></a> <h4>EricPlugin.__initializeReportData</h4> <b>__initializeReportData</b>(<i></i>) - <p> Private method to initialize attributes for data collection. </p> + <a NAME="EricPlugin.pytest_collectreport" ID="EricPlugin.pytest_collectreport"></a> <h4>EricPlugin.pytest_collectreport</h4> <b>pytest_collectreport</b>(<i>report</i>) - <p> Public method called by pytest after the tests have been collected. </p> + <dl> <dt><i>report</i> (CollectReport)</dt> @@ -156,10 +154,10 @@ <a NAME="EricPlugin.pytest_itemcollected" ID="EricPlugin.pytest_itemcollected"></a> <h4>EricPlugin.pytest_itemcollected</h4> <b>pytest_itemcollected</b>(<i>item</i>) - <p> Public malled by pytest after a test item has been collected. </p> + <dl> <dt><i>item</i> (Item)</dt> @@ -170,10 +168,10 @@ <a NAME="EricPlugin.pytest_report_header" ID="EricPlugin.pytest_report_header"></a> <h4>EricPlugin.pytest_report_header</h4> <b>pytest_report_header</b>(<i>config, startdir</i>) - <p> Public method called by pytest before any reporting. </p> + <dl> <dt><i>config</i> (Config)</dt> @@ -188,10 +186,10 @@ <a NAME="EricPlugin.pytest_runtest_logfinish" ID="EricPlugin.pytest_runtest_logfinish"></a> <h4>EricPlugin.pytest_runtest_logfinish</h4> <b>pytest_runtest_logfinish</b>(<i>nodeid, location</i>) - <p> Public method called by pytest after a test has been completed. </p> + <dl> <dt><i>nodeid</i> (str)</dt> @@ -207,11 +205,11 @@ <a NAME="EricPlugin.pytest_runtest_logreport" ID="EricPlugin.pytest_runtest_logreport"></a> <h4>EricPlugin.pytest_runtest_logreport</h4> <b>pytest_runtest_logreport</b>(<i>report</i>) - <p> Public method called by pytest when a test phase (setup, call and teardown) has been completed. </p> + <dl> <dt><i>report</i> (TestReport)</dt> @@ -222,10 +220,10 @@ <a NAME="EricPlugin.pytest_runtest_logstart" ID="EricPlugin.pytest_runtest_logstart"></a> <h4>EricPlugin.pytest_runtest_logstart</h4> <b>pytest_runtest_logstart</b>(<i>nodeid, location</i>) - <p> Public method called by pytest before running a test. </p> + <dl> <dt><i>nodeid</i> (str)</dt> @@ -241,10 +239,10 @@ <a NAME="EricPlugin.pytest_sessionfinish" ID="EricPlugin.pytest_sessionfinish"></a> <h4>EricPlugin.pytest_sessionfinish</h4> <b>pytest_sessionfinish</b>(<i>session, exitstatus</i>) - <p> Public method called by pytest after the whole test run finished. </p> + <dl> <dt><i>session</i> (Session)</dt> @@ -259,11 +257,11 @@ <a NAME="EricPlugin.pytest_sessionstart" ID="EricPlugin.pytest_sessionstart"></a> <h4>EricPlugin.pytest_sessionstart</h4> <b>pytest_sessionstart</b>(<i>session</i>) - <p> Public method called by pytest before performing collection and entering the run test loop. </p> + <dl> <dt><i>session</i> (Session)</dt> @@ -276,26 +274,24 @@ <hr /> <a NAME="GetMarkersPlugin" ID="GetMarkersPlugin"></a> <h2>GetMarkersPlugin</h2> - <p> Class implementing a pytest plugin to extract the list of all defined markers. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#GetMarkersPlugin.__init__">GetMarkersPlugin</a></td> <td>Constructor</td> @@ -309,26 +305,27 @@ <td>Public method called for performing the main command line action.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="GetMarkersPlugin.__init__" ID="GetMarkersPlugin.__init__"></a> <h4>GetMarkersPlugin (Constructor)</h4> <b>GetMarkersPlugin</b>(<i></i>) - <p> Constructor </p> + <a NAME="GetMarkersPlugin.getMarkers" ID="GetMarkersPlugin.getMarkers"></a> <h4>GetMarkersPlugin.getMarkers</h4> <b>getMarkers</b>(<i></i>) - <p> Public method to get the assembled list of markers. </p> + <dl> <dt>Return:</dt> <dd> @@ -344,10 +341,10 @@ <a NAME="GetMarkersPlugin.pytest_cmdline_main" ID="GetMarkersPlugin.pytest_cmdline_main"></a> <h4>GetMarkersPlugin.pytest_cmdline_main</h4> <b>pytest_cmdline_main</b>(<i>config</i>) - <p> Public method called for performing the main command line action. </p> + <dl> <dt><i>config</i> (Config)</dt> @@ -360,27 +357,25 @@ <hr /> <a NAME="GetPluginVersionsPlugin" ID="GetPluginVersionsPlugin"></a> <h2>GetPluginVersionsPlugin</h2> - <p> Class implementing a pytest plugin to extract the version info of all installed plugins. </p> + <h3>Derived from</h3> None <h3>Class Attributes</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Class Methods</h3> - <table> <tr><td>None</td></tr> </table> + <h3>Methods</h3> - <table> - <tr> <td><a href="#GetPluginVersionsPlugin.__init__">GetPluginVersionsPlugin</a></td> <td>Constructor</td> @@ -394,26 +389,27 @@ <td>Public method called for performing the main command line action.</td> </tr> </table> + <h3>Static Methods</h3> - <table> <tr><td>None</td></tr> </table> + <a NAME="GetPluginVersionsPlugin.__init__" ID="GetPluginVersionsPlugin.__init__"></a> <h4>GetPluginVersionsPlugin (Constructor)</h4> <b>GetPluginVersionsPlugin</b>(<i></i>) - <p> Constructor </p> + <a NAME="GetPluginVersionsPlugin.getVersions" ID="GetPluginVersionsPlugin.getVersions"></a> <h4>GetPluginVersionsPlugin.getVersions</h4> <b>getVersions</b>(<i></i>) - <p> Public method to get the assembled list of plugin versions. </p> + <dl> <dt>Return:</dt> <dd> @@ -429,10 +425,10 @@ <a NAME="GetPluginVersionsPlugin.pytest_cmdline_main" ID="GetPluginVersionsPlugin.pytest_cmdline_main"></a> <h4>GetPluginVersionsPlugin.pytest_cmdline_main</h4> <b>pytest_cmdline_main</b>(<i>config</i>) - <p> Public method called for performing the main command line action. </p> + <dl> <dt><i>config</i> (Config)</dt> @@ -446,21 +442,21 @@ <a NAME="getMarkers" ID="getMarkers"></a> <h2>getMarkers</h2> <b>getMarkers</b>(<i></i>) - <p> Function to determine the defined markers and their descriptions. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> <hr /> <a NAME="getVersions" ID="getVersions"></a> <h2>getVersions</h2> <b>getVersions</b>(<i></i>) - <p> Function to determine the framework version and versions of all available plugins. </p> + <div align="right"><a href="#top">Up</a></div> <hr /> -</body></html> \ No newline at end of file +</body></html>