src/eric7/Documentation/Source/eric7.DataViews.PyCoverageDialog.html

<!DOCTYPE html>
<html><head>
<title>eric7.DataViews.PyCoverageDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.DataViews.PyCoverageDialog</h1>
<p>
Module implementing a Python code coverage dialog.
</p>

<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>

<h3>Classes</h3>
<table>
<tr>
<td><a href="#PyCoverageDialog">PyCoverageDialog</a></td>
<td>Class implementing a dialog to display the collected code coverage data.</td>
</tr>
</table>

<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>

<hr />
<hr />
<a NAME="PyCoverageDialog" ID="PyCoverageDialog"></a>
<h2>PyCoverageDialog</h2>
<p>
    Class implementing a dialog to display the collected code coverage data.
</p>

<h3>Signals</h3>
<dl>

<dt>openFile(str)</dt>
<dd>
emitted to open the given file in an editor
</dd>
</dl>
<h3>Derived from</h3>
QDialog, Ui_PyCoverageDialog
<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="#PyCoverageDialog.__init__">PyCoverageDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__createResultItem">__createResultItem</a></td>
<td>Private method to create an entry in the result list.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__erase">__erase</a></td>
<td>Private slot to handle the erase context menu action.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__finish">__finish</a></td>
<td>Private slot called when the action finished or the user pressed the button.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__format_lines">__format_lines</a></td>
<td>Private method to format a list of integers into string by coalescing groups.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__htmlReport">__htmlReport</a></td>
<td>Private slot to generate a HTML report of the shown data.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__jsonReport">__jsonReport</a></td>
<td>Private slot to generate a JSON report of the shown data.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__lcovReport">__lcovReport</a></td>
<td>Private slot to generate a LCOV report of the shown data.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__openFile">__openFile</a></td>
<td>Private slot to open the selected file.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__prepareReportGeneration">__prepareReportGeneration</a></td>
<td>Private method to prepare a report generation.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.__showContextMenu">__showContextMenu</a></td>
<td>Private slot to show the context menu of the listview.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.closeEvent">closeEvent</a></td>
<td>Protected method to handle the close event.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.on_buttonBox_clicked">on_buttonBox_clicked</a></td>
<td>Private slot called by a button of the button box clicked.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.on_reloadButton_clicked">on_reloadButton_clicked</a></td>
<td>Private slot to reload the coverage info.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
<td>Private slot to handle the activation of an item.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.start">start</a></td>
<td>Public slot to start the coverage data evaluation.</td>
</tr>
<tr>
<td><a href="#PyCoverageDialog.stringify">stringify</a></td>
<td>Private helper function to generate a string representation of a pair.</td>
</tr>
</table>

<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>


<a NAME="PyCoverageDialog.__init__" ID="PyCoverageDialog.__init__"></a>
<h4>PyCoverageDialog (Constructor)</h4>
<b>PyCoverageDialog</b>(<i>parent=None</i>)
<p>
        Constructor
</p>

<dl>

<dt><i>parent</i> (QWidget)</dt>
<dd>
parent widget
</dd>
</dl>
<a NAME="PyCoverageDialog.__createResultItem" ID="PyCoverageDialog.__createResultItem"></a>
<h4>PyCoverageDialog.__createResultItem</h4>
<b>__createResultItem</b>(<i>file, statements, executed, coverage, excluded, missing</i>)
<p>
        Private method to create an entry in the result list.
</p>

<dl>

<dt><i>file</i> (str)</dt>
<dd>
filename of file
</dd>
<dt><i>statements</i> (int)</dt>
<dd>
number of statements
</dd>
<dt><i>executed</i> (int)</dt>
<dd>
number of executed statements
</dd>
<dt><i>coverage</i> (int)</dt>
<dd>
percent of coverage
</dd>
<dt><i>excluded</i> (list of int)</dt>
<dd>
list of excluded lines
</dd>
<dt><i>missing</i> (str)</dt>
<dd>
list of lines without coverage
</dd>
</dl>
<a NAME="PyCoverageDialog.__erase" ID="PyCoverageDialog.__erase"></a>
<h4>PyCoverageDialog.__erase</h4>
<b>__erase</b>(<i></i>)
<p>
        Private slot to handle the erase context menu action.
</p>
<p>
        This method erases the collected coverage data that is
        stored in the .coverage file.
</p>

<a NAME="PyCoverageDialog.__finish" ID="PyCoverageDialog.__finish"></a>
<h4>PyCoverageDialog.__finish</h4>
<b>__finish</b>(<i></i>)
<p>
        Private slot called when the action finished or the user pressed the
        button.
</p>

<a NAME="PyCoverageDialog.__format_lines" ID="PyCoverageDialog.__format_lines"></a>
<h4>PyCoverageDialog.__format_lines</h4>
<b>__format_lines</b>(<i>lines</i>)
<p>
        Private method to format a list of integers into string by coalescing
        groups.
</p>

<dl>

<dt><i>lines</i> (list of int)</dt>
<dd>
list of integers
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
string representing the list
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<a NAME="PyCoverageDialog.__htmlReport" ID="PyCoverageDialog.__htmlReport"></a>
<h4>PyCoverageDialog.__htmlReport</h4>
<b>__htmlReport</b>(<i></i>)
<p>
        Private slot to generate a HTML report of the shown data.
</p>

<a NAME="PyCoverageDialog.__jsonReport" ID="PyCoverageDialog.__jsonReport"></a>
<h4>PyCoverageDialog.__jsonReport</h4>
<b>__jsonReport</b>(<i></i>)
<p>
        Private slot to generate a JSON report of the shown data.
</p>

<a NAME="PyCoverageDialog.__lcovReport" ID="PyCoverageDialog.__lcovReport"></a>
<h4>PyCoverageDialog.__lcovReport</h4>
<b>__lcovReport</b>(<i></i>)
<p>
        Private slot to generate a LCOV report of the shown data.
</p>

<a NAME="PyCoverageDialog.__openFile" ID="PyCoverageDialog.__openFile"></a>
<h4>PyCoverageDialog.__openFile</h4>
<b>__openFile</b>(<i>itm=None</i>)
<p>
        Private slot to open the selected file.
</p>

<dl>

<dt><i>itm</i> (QTreeWidgetItem)</dt>
<dd>
reference to the item to be opened
</dd>
</dl>
<a NAME="PyCoverageDialog.__prepareReportGeneration" ID="PyCoverageDialog.__prepareReportGeneration"></a>
<h4>PyCoverageDialog.__prepareReportGeneration</h4>
<b>__prepareReportGeneration</b>(<i></i>)
<p>
        Private method to prepare a report generation.
</p>

<dl>
<dt>Return:</dt>
<dd>
tuple containing a reference to the Coverage object and the
            list of files to report
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
tuple of (Coverage, list of str)
</dd>
</dl>
<a NAME="PyCoverageDialog.__showContextMenu" ID="PyCoverageDialog.__showContextMenu"></a>
<h4>PyCoverageDialog.__showContextMenu</h4>
<b>__showContextMenu</b>(<i>coord</i>)
<p>
        Private slot to show the context menu of the listview.
</p>

<dl>

<dt><i>coord</i> (QPoint)</dt>
<dd>
position of the mouse pointer
</dd>
</dl>
<a NAME="PyCoverageDialog.closeEvent" ID="PyCoverageDialog.closeEvent"></a>
<h4>PyCoverageDialog.closeEvent</h4>
<b>closeEvent</b>(<i>_evt</i>)
<p>
        Protected method to handle the close event.
</p>

<dl>

<dt><i>_evt</i> (QCloseEvent)</dt>
<dd>
reference to the close event (unused)
</dd>
</dl>
<a NAME="PyCoverageDialog.on_buttonBox_clicked" ID="PyCoverageDialog.on_buttonBox_clicked"></a>
<h4>PyCoverageDialog.on_buttonBox_clicked</h4>
<b>on_buttonBox_clicked</b>(<i>button</i>)
<p>
        Private slot called by a button of the button box clicked.
</p>

<dl>

<dt><i>button</i> (QAbstractButton)</dt>
<dd>
button that was clicked
</dd>
</dl>
<a NAME="PyCoverageDialog.on_reloadButton_clicked" ID="PyCoverageDialog.on_reloadButton_clicked"></a>
<h4>PyCoverageDialog.on_reloadButton_clicked</h4>
<b>on_reloadButton_clicked</b>(<i></i>)
<p>
        Private slot to reload the coverage info.
</p>

<a NAME="PyCoverageDialog.on_resultList_itemActivated" ID="PyCoverageDialog.on_resultList_itemActivated"></a>
<h4>PyCoverageDialog.on_resultList_itemActivated</h4>
<b>on_resultList_itemActivated</b>(<i>item, _column</i>)
<p>
        Private slot to handle the activation of an item.
</p>

<dl>

<dt><i>item</i> (QTreeWidgetItem)</dt>
<dd>
reference to the activated item
</dd>
<dt><i>_column</i> (int)</dt>
<dd>
column the item was activated in (unused)
</dd>
</dl>
<a NAME="PyCoverageDialog.start" ID="PyCoverageDialog.start"></a>
<h4>PyCoverageDialog.start</h4>
<b>start</b>(<i>cfn, fn</i>)
<p>
        Public slot to start the coverage data evaluation.
</p>

<dl>

<dt><i>cfn</i> (str)</dt>
<dd>
basename of the coverage file
</dd>
<dt><i>fn</i> (str or list of str)</dt>
<dd>
file or list of files or directory to be checked
</dd>
</dl>
<a NAME="PyCoverageDialog.stringify" ID="PyCoverageDialog.stringify"></a>
<h4>PyCoverageDialog.stringify</h4>
<b>stringify</b>(<i></i>)
<p>
            Private helper function to generate a string representation of a
            pair.
</p>

<dl>

<dt><i>pair</i> (tuple of (int, int)</dt>
<dd>
pair of integers
</dd>
</dl>
<dl>
<dt>Return:</dt>
<dd>
representation of the pair
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
str
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>