PyrightChecker/Documentation/Source/Plugin_Checker_Pyright.PyrightChecker.PyrightCheckerDialog.html

<!DOCTYPE html>
<html><head>
<title>Plugin_Checker_Pyright.PyrightChecker.PyrightCheckerDialog</title>
<meta charset="UTF-8">
<link rel="stylesheet" href="styles.css">
</head>
<body>
<a NAME="top" ID="top"></a>
<h1>Plugin_Checker_Pyright.PyrightChecker.PyrightCheckerDialog</h1>

<p>
Module implementing the pyright type checker dialog.
</p>
<h3>Global Attributes</h3>

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

<table>

<tr>
<td><a href="#PyrightCheckerDialog">PyrightCheckerDialog</a></td>
<td>Class documentation goes here.</td>
</tr>
</table>
<h3>Functions</h3>

<table>
<tr><td>None</td></tr>
</table>
<hr />
<hr />
<a NAME="PyrightCheckerDialog" ID="PyrightCheckerDialog"></a>
<h2>PyrightCheckerDialog</h2>

<p>
    Class documentation goes here.
</p>
<h3>Derived from</h3>
QDialog, Ui_PyrightCheckerDialog
<h3>Class Attributes</h3>

<table>
<tr><td>endRole</td></tr><tr><td>filenameRole</td></tr><tr><td>severityRole</td></tr><tr><td>startRole</td></tr>
</table>
<h3>Class Methods</h3>

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

<table>

<tr>
<td><a href="#PyrightCheckerDialog.__init__">PyrightCheckerDialog</a></td>
<td>Constructor</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__clear">__clear</a></td>
<td>Private method to clear the dialog.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__clearEditorErrors">__clearEditorErrors</a></td>
<td>Private method to clear all warning markers of an editor.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__clearErrors">__clearErrors</a></td>
<td>Private method to clear all warning markers of open editors to be checked.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__createResultItem">__createResultItem</a></td>
<td>Private method to create an entry in the result list.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__getConfigurationDict">__getConfigurationDict</a></td>
<td>Private method to assemble and return a dictionary containing the entered non-default configuration parameters.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__processResult">__processResult</a></td>
<td>Private method to process the pyright result.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__pyrightProcessFinished">__pyrightProcessFinished</a></td>
<td>Private slot to process the pyright result.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__readError">__readError</a></td>
<td>Private slot to get the output of the error channel and show it to the user.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__resort">__resort</a></td>
<td>Private method to resort the tree.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.__updateSummary">__updateSummary</a></td>
<td>Private method to update the summary data of the dialog.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.getDefaults">getDefaults</a></td>
<td>Public method to get a dictionary containing the default values.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.on_loadDefaultButton_clicked">on_loadDefaultButton_clicked</a></td>
<td>Private slot to load the default configuration values.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.on_resetDefaultButton_clicked">on_resetDefaultButton_clicked</a></td>
<td>Private slot to reset the configuration values to their default values.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.on_restartButton_clicked">on_restartButton_clicked</a></td>
<td>Private slot to restart the configured check.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.on_resultList_itemActivated">on_resultList_itemActivated</a></td>
<td>Private slot to handle the activation of an item.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.on_showButton_clicked">on_showButton_clicked</a></td>
<td>Private slot to handle the "Show" button press.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.on_startButton_clicked">on_startButton_clicked</a></td>
<td>Private slot to start the pyright type checking run.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.on_storeDefaultButton_clicked">on_storeDefaultButton_clicked</a></td>
<td>Private slot to store the current configuration values as default values.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.on_tomlButton_clicked">on_tomlButton_clicked</a></td>
<td>Private slot to generate a TOML snippet of the current configuration.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.prepare">prepare</a></td>
<td>Public method to prepare the dialog with a list of filenames.</td>
</tr>
<tr>
<td><a href="#PyrightCheckerDialog.start">start</a></td>
<td>Public method to start a pyright type checking run.</td>
</tr>
</table>
<h3>Static Methods</h3>

<table>
<tr><td>None</td></tr>
</table>

<a NAME="PyrightCheckerDialog.__init__" ID="PyrightCheckerDialog.__init__"></a>
<h4>PyrightCheckerDialog (Constructor)</h4>
<b>PyrightCheckerDialog</b>(<i>plugin, parent=None</i>)

<p>
        Constructor
</p>
<dl>

<dt><i>plugin</i> (PyrightPlugin)</dt>
<dd>
reference to the plugin object
</dd>
<dt><i>parent</i> (QWidget (optional))</dt>
<dd>
reference to the parent widget (defaults to None)
</dd>
</dl>
<a NAME="PyrightCheckerDialog.__clear" ID="PyrightCheckerDialog.__clear"></a>
<h4>PyrightCheckerDialog.__clear</h4>
<b>__clear</b>(<i></i>)

<p>
        Private method to clear the dialog.
</p>
<a NAME="PyrightCheckerDialog.__clearEditorErrors" ID="PyrightCheckerDialog.__clearEditorErrors"></a>
<h4>PyrightCheckerDialog.__clearEditorErrors</h4>
<b>__clearEditorErrors</b>(<i>editor</i>)

<p>
        Private method to clear all warning markers of an editor.
</p>
<dl>

<dt><i>editor</i> (Editor)</dt>
<dd>
reference to the editor to be cleared
</dd>
</dl>
<a NAME="PyrightCheckerDialog.__clearErrors" ID="PyrightCheckerDialog.__clearErrors"></a>
<h4>PyrightCheckerDialog.__clearErrors</h4>
<b>__clearErrors</b>(<i>files=None</i>)

<p>
        Private method to clear all warning markers of open editors to be
        checked.
</p>
<dl>

<dt><i>files</i> (list of str (optional)</dt>
<dd>
list of files to be checked (defaults to None
</dd>
</dl>
<a NAME="PyrightCheckerDialog.__createResultItem" ID="PyrightCheckerDialog.__createResultItem"></a>
<h4>PyrightCheckerDialog.__createResultItem</h4>
<b>__createResultItem</b>(<i>result</i>)

<p>
        Private method to create an entry in the result list.
</p>
<dl>

<dt><i>result</i> (dict)</dt>
<dd>
dictionary containing check result data
</dd>
</dl>
<a NAME="PyrightCheckerDialog.__getConfigurationDict" ID="PyrightCheckerDialog.__getConfigurationDict"></a>
<h4>PyrightCheckerDialog.__getConfigurationDict</h4>
<b>__getConfigurationDict</b>(<i></i>)

<p>
        Private method to assemble and return a dictionary containing the entered
        non-default configuration parameters.
</p>
<p>
        The configuration dictionary is amended with some common parameters not
        accessible via the configuration tab.
</p>
<dl>
<dt>Return:</dt>
<dd>
dictionary containing the non-default configuration parameters
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="PyrightCheckerDialog.__processResult" ID="PyrightCheckerDialog.__processResult"></a>
<h4>PyrightCheckerDialog.__processResult</h4>
<b>__processResult</b>(<i>result</i>)

<p>
        Private method to process the pyright result.
</p>
<dl>

<dt><i>result</i> (dict)</dt>
<dd>
dictionary containing the type checking result.
</dd>
</dl>
<a NAME="PyrightCheckerDialog.__pyrightProcessFinished" ID="PyrightCheckerDialog.__pyrightProcessFinished"></a>
<h4>PyrightCheckerDialog.__pyrightProcessFinished</h4>
<b>__pyrightProcessFinished</b>(<i>exitCode, exitStatus</i>)

<p>
        Private slot to process the pyright result.
</p>
<dl>

<dt><i>exitCode</i> (int)</dt>
<dd>
exit code of the pyright process
</dd>
<dt><i>exitStatus</i> (QProcess.ExitStatus)</dt>
<dd>
exit status
</dd>
</dl>
<a NAME="PyrightCheckerDialog.__readError" ID="PyrightCheckerDialog.__readError"></a>
<h4>PyrightCheckerDialog.__readError</h4>
<b>__readError</b>(<i></i>)

<p>
        Private slot to get the output of the error channel and show it to the user.
</p>
<a NAME="PyrightCheckerDialog.__resort" ID="PyrightCheckerDialog.__resort"></a>
<h4>PyrightCheckerDialog.__resort</h4>
<b>__resort</b>(<i></i>)

<p>
        Private method to resort the tree.
</p>
<a NAME="PyrightCheckerDialog.__updateSummary" ID="PyrightCheckerDialog.__updateSummary"></a>
<h4>PyrightCheckerDialog.__updateSummary</h4>
<b>__updateSummary</b>(<i>summary</i>)

<p>
        Private method to update the summary data of the dialog.
</p>
<dl>

<dt><i>summary</i> (dict)</dt>
<dd>
dictionary containing the summary data
</dd>
</dl>
<a NAME="PyrightCheckerDialog.getDefaults" ID="PyrightCheckerDialog.getDefaults"></a>
<h4>PyrightCheckerDialog.getDefaults</h4>
<b>getDefaults</b>(<i></i>)

<p>
        Public method to get a dictionary containing the default values.
</p>
<dl>
<dt>Return:</dt>
<dd>
dictionary containing the default values
</dd>
</dl>
<dl>
<dt>Return Type:</dt>
<dd>
dict
</dd>
</dl>
<a NAME="PyrightCheckerDialog.on_loadDefaultButton_clicked" ID="PyrightCheckerDialog.on_loadDefaultButton_clicked"></a>
<h4>PyrightCheckerDialog.on_loadDefaultButton_clicked</h4>
<b>on_loadDefaultButton_clicked</b>(<i></i>)

<p>
        Private slot to load the default configuration values.
</p>
<a NAME="PyrightCheckerDialog.on_resetDefaultButton_clicked" ID="PyrightCheckerDialog.on_resetDefaultButton_clicked"></a>
<h4>PyrightCheckerDialog.on_resetDefaultButton_clicked</h4>
<b>on_resetDefaultButton_clicked</b>(<i></i>)

<p>
        Private slot to reset the configuration values to their default values.
</p>
<a NAME="PyrightCheckerDialog.on_restartButton_clicked" ID="PyrightCheckerDialog.on_restartButton_clicked"></a>
<h4>PyrightCheckerDialog.on_restartButton_clicked</h4>
<b>on_restartButton_clicked</b>(<i></i>)

<p>
        Private slot to restart the configured check.
</p>
<a NAME="PyrightCheckerDialog.on_resultList_itemActivated" ID="PyrightCheckerDialog.on_resultList_itemActivated"></a>
<h4>PyrightCheckerDialog.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
</dd>
</dl>
<a NAME="PyrightCheckerDialog.on_showButton_clicked" ID="PyrightCheckerDialog.on_showButton_clicked"></a>
<h4>PyrightCheckerDialog.on_showButton_clicked</h4>
<b>on_showButton_clicked</b>(<i></i>)

<p>
        Private slot to handle the "Show" button press.
</p>
<a NAME="PyrightCheckerDialog.on_startButton_clicked" ID="PyrightCheckerDialog.on_startButton_clicked"></a>
<h4>PyrightCheckerDialog.on_startButton_clicked</h4>
<b>on_startButton_clicked</b>(<i></i>)

<p>
        Private slot to start the pyright type checking run.
</p>
<a NAME="PyrightCheckerDialog.on_storeDefaultButton_clicked" ID="PyrightCheckerDialog.on_storeDefaultButton_clicked"></a>
<h4>PyrightCheckerDialog.on_storeDefaultButton_clicked</h4>
<b>on_storeDefaultButton_clicked</b>(<i></i>)

<p>
        Private slot to store the current configuration values as
        default values.
</p>
<a NAME="PyrightCheckerDialog.on_tomlButton_clicked" ID="PyrightCheckerDialog.on_tomlButton_clicked"></a>
<h4>PyrightCheckerDialog.on_tomlButton_clicked</h4>
<b>on_tomlButton_clicked</b>(<i></i>)

<p>
        Private slot to generate a TOML snippet of the current configuration.
</p>
<p>
        Note: Only non-default values are included in this snippet.
</p>
<p>
        The code snippet is copied to the clipboard and may be placed inside the
        'pyproject.toml' file.
</p>
<a NAME="PyrightCheckerDialog.prepare" ID="PyrightCheckerDialog.prepare"></a>
<h4>PyrightCheckerDialog.prepare</h4>
<b>prepare</b>(<i>project</i>)

<p>
        Public method to prepare the dialog with a list of filenames.
</p>
<dl>

<dt><i>project</i> (Project)</dt>
<dd>
reference to the project object
</dd>
</dl>
<a NAME="PyrightCheckerDialog.start" ID="PyrightCheckerDialog.start"></a>
<h4>PyrightCheckerDialog.start</h4>
<b>start</b>(<i>files=None, save=False</i>)

<p>
        Public method to start a pyright type checking run.
</p>
<dl>

<dt><i>files</i> (list of str (optional))</dt>
<dd>
list of files to be checked (defaults to None)
</dd>
<dt><i>save</i> (bool)</dt>
<dd>
flag indicating to save the given file/file list/directory
</dd>
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>