Documentation/Source/eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog.html

<!DOCTYPE html>
<html><head>
<title>eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog</title>
<meta charset="UTF-8">
<style>
body {
    background: #EDECE6;
    margin: 0em 1em 10em 1em;
    color: black;
}

h1 { color: white; background: #85774A; }
h2 { color: white; background: #85774A; }
h3 { color: white; background: #9D936E; }
h4 { color: white; background: #9D936E; }
    
a { color: #BA6D36; }

</style>
</head>
<body><a NAME="top" ID="top"></a>
<h1>eric6.Plugins.UiExtensionPlugins.PipInterface.PipListDialog</h1>
<p>
Module implementing a dialog to list installed packages.
</p>
<h3>Global Attributes</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Classes</h3>
<table>
<tr>
<td><a href="#PipListDialog">PipListDialog</a></td>
<td>Class implementing a dialog to list installed packages.</td>
</tr>
</table>
<h3>Functions</h3>
<table>
<tr><td>None</td></tr>
</table>
<hr /><hr />
<a NAME="PipListDialog" ID="PipListDialog"></a>
<h2>PipListDialog</h2>
<p>
    Class implementing a dialog to list installed packages.
</p>
<h3>Derived from</h3>
QDialog, Ui_PipListDialog
<h3>Class Attributes</h3>
<table>
<tr><td>CommandArguments</td></tr><tr><td>ShowProcessClassifiersMode</td></tr><tr><td>ShowProcessEntryPointsMode</td></tr><tr><td>ShowProcessFilesListMode</td></tr><tr><td>ShowProcessGeneralMode</td></tr>
</table>
<h3>Class Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<h3>Methods</h3>
<table>
<tr>
<td><a href="#PipListDialog.__init__">PipListDialog</a></td>
<td>Constructor</td>
</tr><tr>
<td><a href="#PipListDialog.__executeUpgradePackages">__executeUpgradePackages</a></td>
<td>Private method to execute the pip upgrade command.</td>
</tr><tr>
<td><a href="#PipListDialog.__finish">__finish</a></td>
<td>Private slot called when the process finished or the user pressed the cancel button.</td>
</tr><tr>
<td><a href="#PipListDialog.__procFinished">__procFinished</a></td>
<td>Private slot connected to the finished signal.</td>
</tr><tr>
<td><a href="#PipListDialog.__processOutput">__processOutput</a></td>
<td>Private method to process the captured output.</td>
</tr><tr>
<td><a href="#PipListDialog.__readStderr">__readStderr</a></td>
<td>Private slot to handle the readyReadStandardError signal.</td>
</tr><tr>
<td><a href="#PipListDialog.__readStdout">__readStdout</a></td>
<td>Private slot to handle the readyReadStandardOutput signal.</td>
</tr><tr>
<td><a href="#PipListDialog.__refresh">__refresh</a></td>
<td>Private slot to refresh the displayed list.</td>
</tr><tr>
<td><a href="#PipListDialog.__stopProcess">__stopProcess</a></td>
<td>Private slot to stop the running process.</td>
</tr><tr>
<td><a href="#PipListDialog.__uninstallPackages">__uninstallPackages</a></td>
<td>Private slot to uninstall the selected packages.</td>
</tr><tr>
<td><a href="#PipListDialog.__upgradeAllPackages">__upgradeAllPackages</a></td>
<td>Private slot to upgrade all listed packages.</td>
</tr><tr>
<td><a href="#PipListDialog.__upgradePackages">__upgradePackages</a></td>
<td>Private slot to upgrade the selected packages.</td>
</tr><tr>
<td><a href="#PipListDialog.__upgradePip">__upgradePip</a></td>
<td>Private slot to upgrade pip itself.</td>
</tr><tr>
<td><a href="#PipListDialog.closeEvent">closeEvent</a></td>
<td>Protected slot implementing a close event handler.</td>
</tr><tr>
<td><a href="#PipListDialog.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="#PipListDialog.on_installedFilesCheckBox_clicked">on_installedFilesCheckBox_clicked</a></td>
<td>Private slot to handle a change of the installed files information checkbox.</td>
</tr><tr>
<td><a href="#PipListDialog.on_localCheckBox_clicked">on_localCheckBox_clicked</a></td>
<td>Private slot handling the switching of the local mode.</td>
</tr><tr>
<td><a href="#PipListDialog.on_notRequiredCheckBox_clicked">on_notRequiredCheckBox_clicked</a></td>
<td>Private slot handling the switching of the 'not required' mode.</td>
</tr><tr>
<td><a href="#PipListDialog.on_packageList_itemSelectionChanged">on_packageList_itemSelectionChanged</a></td>
<td>Private slot handling the selection of a package.</td>
</tr><tr>
<td><a href="#PipListDialog.on_pipComboBox_activated">on_pipComboBox_activated</a></td>
<td>Private slot handling the selection of a pip executable.</td>
</tr><tr>
<td><a href="#PipListDialog.on_verboseCheckBox_clicked">on_verboseCheckBox_clicked</a></td>
<td>Private slot to handle a change of the verbose package information checkbox.</td>
</tr><tr>
<td><a href="#PipListDialog.start">start</a></td>
<td>Public method to start the command.</td>
</tr>
</table>
<h3>Static Methods</h3>
<table>
<tr><td>None</td></tr>
</table>
<a NAME="PipListDialog.__init__" ID="PipListDialog.__init__"></a>
<h4>PipListDialog (Constructor)</h4>
<b>PipListDialog</b>(<i>pip, mode, plugin, title, parent=None</i>)
<p>
        Constructor
</p><dl>
<dt><i>pip</i></dt>
<dd>
reference to the master object (Pip)
</dd><dt><i>mode</i></dt>
<dd>
list command mode (string; one of 'list',
            'uptodate', 'outdated')
</dd><dt><i>plugin</i></dt>
<dd>
reference to the plugin object (ToolPipPlugin)
</dd><dt><i>title</i></dt>
<dd>
title of the dialog (string)
</dd><dt><i>parent</i></dt>
<dd>
reference to the parent widget (QWidget)
</dd>
</dl><a NAME="PipListDialog.__executeUpgradePackages" ID="PipListDialog.__executeUpgradePackages"></a>
<h4>PipListDialog.__executeUpgradePackages</h4>
<b>__executeUpgradePackages</b>(<i>packages</i>)
<p>
        Private method to execute the pip upgrade command.
</p><dl>
<dt><i>packages</i> (list of str)</dt>
<dd>
list of package names to be upgraded
</dd>
</dl><a NAME="PipListDialog.__finish" ID="PipListDialog.__finish"></a>
<h4>PipListDialog.__finish</h4>
<b>__finish</b>(<i></i>)
<p>
        Private slot called when the process finished or the user pressed
        the cancel button.
</p><a NAME="PipListDialog.__procFinished" ID="PipListDialog.__procFinished"></a>
<h4>PipListDialog.__procFinished</h4>
<b>__procFinished</b>(<i>exitCode, exitStatus</i>)
<p>
        Private slot connected to the finished signal.
</p><dl>
<dt><i>exitCode</i></dt>
<dd>
exit code of the process (integer)
</dd><dt><i>exitStatus</i></dt>
<dd>
exit status of the process (QProcess.ExitStatus)
</dd>
</dl><a NAME="PipListDialog.__processOutput" ID="PipListDialog.__processOutput"></a>
<h4>PipListDialog.__processOutput</h4>
<b>__processOutput</b>(<i></i>)
<p>
        Private method to process the captured output.
</p><a NAME="PipListDialog.__readStderr" ID="PipListDialog.__readStderr"></a>
<h4>PipListDialog.__readStderr</h4>
<b>__readStderr</b>(<i></i>)
<p>
        Private slot to handle the readyReadStandardError signal.
</p><p>
        It reads the error output of the process and inserts it into the
        error pane.
</p><a NAME="PipListDialog.__readStdout" ID="PipListDialog.__readStdout"></a>
<h4>PipListDialog.__readStdout</h4>
<b>__readStdout</b>(<i></i>)
<p>
        Private slot to handle the readyReadStandardOutput signal.
</p><p>
        It reads the output of the process, formats it and inserts it into
        the contents pane.
</p><a NAME="PipListDialog.__refresh" ID="PipListDialog.__refresh"></a>
<h4>PipListDialog.__refresh</h4>
<b>__refresh</b>(<i></i>)
<p>
        Private slot to refresh the displayed list.
</p><a NAME="PipListDialog.__stopProcess" ID="PipListDialog.__stopProcess"></a>
<h4>PipListDialog.__stopProcess</h4>
<b>__stopProcess</b>(<i></i>)
<p>
        Private slot to stop the running process.
</p><a NAME="PipListDialog.__uninstallPackages" ID="PipListDialog.__uninstallPackages"></a>
<h4>PipListDialog.__uninstallPackages</h4>
<b>__uninstallPackages</b>(<i></i>)
<p>
        Private slot to uninstall the selected packages.
</p><a NAME="PipListDialog.__upgradeAllPackages" ID="PipListDialog.__upgradeAllPackages"></a>
<h4>PipListDialog.__upgradeAllPackages</h4>
<b>__upgradeAllPackages</b>(<i></i>)
<p>
        Private slot to upgrade all listed packages.
</p><a NAME="PipListDialog.__upgradePackages" ID="PipListDialog.__upgradePackages"></a>
<h4>PipListDialog.__upgradePackages</h4>
<b>__upgradePackages</b>(<i></i>)
<p>
        Private slot to upgrade the selected packages.
</p><a NAME="PipListDialog.__upgradePip" ID="PipListDialog.__upgradePip"></a>
<h4>PipListDialog.__upgradePip</h4>
<b>__upgradePip</b>(<i></i>)
<p>
        Private slot to upgrade pip itself.
</p><a NAME="PipListDialog.closeEvent" ID="PipListDialog.closeEvent"></a>
<h4>PipListDialog.closeEvent</h4>
<b>closeEvent</b>(<i>e</i>)
<p>
        Protected slot implementing a close event handler.
</p><dl>
<dt><i>e</i></dt>
<dd>
close event (QCloseEvent)
</dd>
</dl><a NAME="PipListDialog.on_buttonBox_clicked" ID="PipListDialog.on_buttonBox_clicked"></a>
<h4>PipListDialog.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></dt>
<dd>
button that was clicked (QAbstractButton)
</dd>
</dl><a NAME="PipListDialog.on_installedFilesCheckBox_clicked" ID="PipListDialog.on_installedFilesCheckBox_clicked"></a>
<h4>PipListDialog.on_installedFilesCheckBox_clicked</h4>
<b>on_installedFilesCheckBox_clicked</b>(<i>checked</i>)
<p>
        Private slot to handle a change of the installed files information
        checkbox.
</p><dl>
<dt><i>checked</i> (bool)</dt>
<dd>
state of the checkbox
</dd>
</dl><a NAME="PipListDialog.on_localCheckBox_clicked" ID="PipListDialog.on_localCheckBox_clicked"></a>
<h4>PipListDialog.on_localCheckBox_clicked</h4>
<b>on_localCheckBox_clicked</b>(<i>checked</i>)
<p>
        Private slot handling the switching of the local mode.
</p><dl>
<dt><i>checked</i></dt>
<dd>
state of the local check box (boolean)
</dd>
</dl><a NAME="PipListDialog.on_notRequiredCheckBox_clicked" ID="PipListDialog.on_notRequiredCheckBox_clicked"></a>
<h4>PipListDialog.on_notRequiredCheckBox_clicked</h4>
<b>on_notRequiredCheckBox_clicked</b>(<i>checked</i>)
<p>
        Private slot handling the switching of the 'not required' mode.
</p><dl>
<dt><i>checked</i></dt>
<dd>
state of the 'not required' check box (boolean)
</dd>
</dl><a NAME="PipListDialog.on_packageList_itemSelectionChanged" ID="PipListDialog.on_packageList_itemSelectionChanged"></a>
<h4>PipListDialog.on_packageList_itemSelectionChanged</h4>
<b>on_packageList_itemSelectionChanged</b>(<i></i>)
<p>
        Private slot handling the selection of a package.
</p><a NAME="PipListDialog.on_pipComboBox_activated" ID="PipListDialog.on_pipComboBox_activated"></a>
<h4>PipListDialog.on_pipComboBox_activated</h4>
<b>on_pipComboBox_activated</b>(<i>txt</i>)
<p>
        Private slot handling the selection of a pip executable.
</p><dl>
<dt><i>txt</i></dt>
<dd>
path of the pip executable (string)
</dd>
</dl><a NAME="PipListDialog.on_verboseCheckBox_clicked" ID="PipListDialog.on_verboseCheckBox_clicked"></a>
<h4>PipListDialog.on_verboseCheckBox_clicked</h4>
<b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
<p>
        Private slot to handle a change of the verbose package information
        checkbox.
</p><dl>
<dt><i>checked</i> (bool)</dt>
<dd>
state of the checkbox
</dd>
</dl><a NAME="PipListDialog.start" ID="PipListDialog.start"></a>
<h4>PipListDialog.start</h4>
<b>start</b>(<i></i>)
<p>
        Public method to start the command.
</p>
<div align="right"><a href="#top">Up</a></div>
<hr />
</body></html>