eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html

branch
eric7
changeset 8983
46eaed7bf3cb
parent 8596
d64760b2da50
child 8985
30e9e592732d
diff -r afec1a04aed9 -r 46eaed7bf3cb eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html
--- a/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Tue Mar 15 17:49:51 2022 +0100
+++ b/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html	Tue Mar 15 17:58:02 2022 +0100
@@ -47,7 +47,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>SearchVersionRole</td></tr><tr><td>ShowProcessClassifiersMode</td></tr><tr><td>ShowProcessEntryPointsMode</td></tr><tr><td>ShowProcessFilesListMode</td></tr><tr><td>ShowProcessGeneralMode</td></tr>
+<tr><td>AvailableVersionColumn</td></tr><tr><td>InstalledVersionColumn</td></tr><tr><td>PackageColumn</td></tr><tr><td>SearchVersionRole</td></tr><tr><td>ShowProcessClassifiersMode</td></tr><tr><td>ShowProcessEntryPointsMode</td></tr><tr><td>ShowProcessFilesListMode</td></tr><tr><td>ShowProcessGeneralMode</td></tr><tr><td>VulnerabilityColumn</td></tr><tr><td>VulnerabilityRole</td></tr>
 </table>
 <h3>Class Methods</h3>
 
@@ -75,6 +75,10 @@
 <td>Private method to get the pip version of the selected environment.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__clearVulnerabilityInfo">__clearVulnerabilityInfo</a></td>
+<td>Private slot to clear the vulnerability info.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__editConfiguration">__editConfiguration</a></td>
 <td>Private method to edit a configuration.</td>
 </tr>
@@ -179,10 +183,18 @@
 <td>Private method to populate the package details dialog.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__showPackageInformation">__showPackageInformation</a></td>
+<td>Private method to show information for a package.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__showSearchedDetails">__showSearchedDetails</a></td>
 <td>Private slot to show details about the selected search result package.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__showVulnerabilityInformation">__showVulnerabilityInformation</a></td>
+<td>Private method to show the detected vulnerability data.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.__uninstallRequirements">__uninstallRequirements</a></td>
 <td>Private slot to uninstall packages as given in a requirements file.</td>
 </tr>
@@ -199,6 +211,14 @@
 <td>Private method to update the state of the search button.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.__updateVulnerabilityData">__updateVulnerabilityData</a></td>
+<td>Private slot to update the shown vulnerability info.</td>
+</tr>
+<tr>
+<td><a href="#PipPackagesWidget.__updateVulnerabilityDbCache">__updateVulnerabilityDbCache</a></td>
+<td>Private slot to initiate an update of the local cache of the vulnerability database.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.executeInstallPackages">executeInstallPackages</a></td>
 <td>Public method to install the given list of packages.</td>
 </tr>
@@ -239,12 +259,12 @@
 <td>Private slot handling the switching of the 'not required' mode.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.on_packagesList_itemActivated">on_packagesList_itemActivated</a></td>
-<td>Private slot reacting on a package item activation.</td>
+<td><a href="#PipPackagesWidget.on_packagesList_itemClicked">on_packagesList_itemClicked</a></td>
+<td>Private slot reacting on a package item click.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.on_packagesList_itemSelectionChanged">on_packagesList_itemSelectionChanged</a></td>
-<td>Private slot handling the selection of a package.</td>
+<td><a href="#PipPackagesWidget.on_packagesList_itemDoubleClicked">on_packagesList_itemDoubleClicked</a></td>
+<td>Private slot reacting on a package item double click.</td>
 </tr>
 <tr>
 <td><a href="#PipPackagesWidget.on_refreshButton_clicked">on_refreshButton_clicked</a></td>
@@ -302,6 +322,10 @@
 <td><a href="#PipPackagesWidget.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="#PipPackagesWidget.on_vulnerabilityCheckBox_clicked">on_vulnerabilityCheckBox_clicked</a></td>
+<td>Private slot handling a change of the automatic vulnerability checks.</td>
+</tr>
 </table>
 <h3>Static Methods</h3>
 
@@ -373,6 +397,13 @@
 tuple of int
 </dd>
 </dl>
+<a NAME="PipPackagesWidget.__clearVulnerabilityInfo" ID="PipPackagesWidget.__clearVulnerabilityInfo"></a>
+<h4>PipPackagesWidget.__clearVulnerabilityInfo</h4>
+<b>__clearVulnerabilityInfo</b>(<i></i>)
+
+<p>
+        Private slot to clear the vulnerability info.
+</p>
 <a NAME="PipPackagesWidget.__editConfiguration" ID="PipPackagesWidget.__editConfiguration"></a>
 <h4>PipPackagesWidget.__editConfiguration</h4>
 <b>__editConfiguration</b>(<i>venvName=""</i>)
@@ -625,6 +656,20 @@
             (defaults to False)
 </dd>
 </dl>
+<a NAME="PipPackagesWidget.__showPackageInformation" ID="PipPackagesWidget.__showPackageInformation"></a>
+<h4>PipPackagesWidget.__showPackageInformation</h4>
+<b>__showPackageInformation</b>(<i>packageName</i>)
+
+<p>
+        Private method to show information for a package.
+</p>
+<dl>
+
+<dt><i>packageName</i> (str)</dt>
+<dd>
+name of the package
+</dd>
+</dl>
 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
 <h4>PipPackagesWidget.__showSearchedDetails</h4>
 <b>__showSearchedDetails</b>(<i>item=None</i>)
@@ -639,6 +684,28 @@
 reference to the search result item to show details for
 </dd>
 </dl>
+<a NAME="PipPackagesWidget.__showVulnerabilityInformation" ID="PipPackagesWidget.__showVulnerabilityInformation"></a>
+<h4>PipPackagesWidget.__showVulnerabilityInformation</h4>
+<b>__showVulnerabilityInformation</b>(<i>packageName, packageVersion, vulnerabilities</i>)
+
+<p>
+        Private method to show the detected vulnerability data.
+</p>
+<dl>
+
+<dt><i>packageName</i> (str)</dt>
+<dd>
+name of the package
+</dd>
+<dt><i>packageVersion</i> (str)</dt>
+<dd>
+installed version number
+</dd>
+<dt><i>vulnerabilities</i> (list of Vulnerability)</dt>
+<dd>
+list of vulnerabilities
+</dd>
+</dl>
 <a NAME="PipPackagesWidget.__uninstallRequirements" ID="PipPackagesWidget.__uninstallRequirements"></a>
 <h4>PipPackagesWidget.__uninstallRequirements</h4>
 <b>__uninstallRequirements</b>(<i></i>)
@@ -667,6 +734,29 @@
 <p>
         Private method to update the state of the search button.
 </p>
+<a NAME="PipPackagesWidget.__updateVulnerabilityData" ID="PipPackagesWidget.__updateVulnerabilityData"></a>
+<h4>PipPackagesWidget.__updateVulnerabilityData</h4>
+<b>__updateVulnerabilityData</b>(<i>clearFirst=True</i>)
+
+<p>
+        Private slot to update the shown vulnerability info.
+</p>
+<dl>
+
+<dt><i>clearFirst</i> (bool (optional))</dt>
+<dd>
+flag indicating to clear the vulnerability info first
+            (defaults to True)
+</dd>
+</dl>
+<a NAME="PipPackagesWidget.__updateVulnerabilityDbCache" ID="PipPackagesWidget.__updateVulnerabilityDbCache"></a>
+<h4>PipPackagesWidget.__updateVulnerabilityDbCache</h4>
+<b>__updateVulnerabilityDbCache</b>(<i></i>)
+
+<p>
+        Private slot to initiate an update of the local cache of the
+        vulnerability database.
+</p>
 <a NAME="PipPackagesWidget.executeInstallPackages" ID="PipPackagesWidget.executeInstallPackages"></a>
 <h4>PipPackagesWidget.executeInstallPackages</h4>
 <b>executeInstallPackages</b>(<i>packages, userSite=False</i>)
@@ -777,57 +867,54 @@
 </dl>
 <a NAME="PipPackagesWidget.on_localCheckBox_clicked" ID="PipPackagesWidget.on_localCheckBox_clicked"></a>
 <h4>PipPackagesWidget.on_localCheckBox_clicked</h4>
-<b>on_localCheckBox_clicked</b>(<i>checked</i>)
+<b>on_localCheckBox_clicked</b>(<i></i>)
 
 <p>
         Private slot handling the switching of the local mode.
 </p>
-<dl>
-
-<dt><i>checked</i> (bool)</dt>
-<dd>
-state of the local check box
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.on_notRequiredCheckBox_clicked" ID="PipPackagesWidget.on_notRequiredCheckBox_clicked"></a>
 <h4>PipPackagesWidget.on_notRequiredCheckBox_clicked</h4>
-<b>on_notRequiredCheckBox_clicked</b>(<i>checked</i>)
+<b>on_notRequiredCheckBox_clicked</b>(<i></i>)
 
 <p>
         Private slot handling the switching of the 'not required' mode.
 </p>
-<dl>
-
-<dt><i>checked</i> (bool)</dt>
-<dd>
-state of the 'not required' check box
-</dd>
-</dl>
-<a NAME="PipPackagesWidget.on_packagesList_itemActivated" ID="PipPackagesWidget.on_packagesList_itemActivated"></a>
-<h4>PipPackagesWidget.on_packagesList_itemActivated</h4>
-<b>on_packagesList_itemActivated</b>(<i>item, column</i>)
+<a NAME="PipPackagesWidget.on_packagesList_itemClicked" ID="PipPackagesWidget.on_packagesList_itemClicked"></a>
+<h4>PipPackagesWidget.on_packagesList_itemClicked</h4>
+<b>on_packagesList_itemClicked</b>(<i>item, column</i>)
 
 <p>
-        Private slot reacting on a package item activation.
+        Private slot reacting on a package item click.
 </p>
 <dl>
 
 <dt><i>item</i> (QTreeWidgetItem)</dt>
 <dd>
-reference to the activated item
+reference to the clicked item
 </dd>
 <dt><i>column</i> (int)</dt>
 <dd>
-activated column
+clicked column
 </dd>
 </dl>
-<a NAME="PipPackagesWidget.on_packagesList_itemSelectionChanged" ID="PipPackagesWidget.on_packagesList_itemSelectionChanged"></a>
-<h4>PipPackagesWidget.on_packagesList_itemSelectionChanged</h4>
-<b>on_packagesList_itemSelectionChanged</b>(<i></i>)
+<a NAME="PipPackagesWidget.on_packagesList_itemDoubleClicked" ID="PipPackagesWidget.on_packagesList_itemDoubleClicked"></a>
+<h4>PipPackagesWidget.on_packagesList_itemDoubleClicked</h4>
+<b>on_packagesList_itemDoubleClicked</b>(<i>item, column</i>)
 
 <p>
-        Private slot handling the selection of a package.
+        Private slot reacting on a package item double click.
 </p>
+<dl>
+
+<dt><i>item</i> (QTreeWidgetItem)</dt>
+<dd>
+reference to the double clicked item
+</dd>
+<dt><i>column</i> (int)</dt>
+<dd>
+double clicked column
+</dd>
+</dl>
 <a NAME="PipPackagesWidget.on_refreshButton_clicked" ID="PipPackagesWidget.on_refreshButton_clicked"></a>
 <h4>PipPackagesWidget.on_refreshButton_clicked</h4>
 <b>on_refreshButton_clicked</b>(<i></i>)
@@ -939,18 +1026,11 @@
 </p>
 <a NAME="PipPackagesWidget.on_userCheckBox_clicked" ID="PipPackagesWidget.on_userCheckBox_clicked"></a>
 <h4>PipPackagesWidget.on_userCheckBox_clicked</h4>
-<b>on_userCheckBox_clicked</b>(<i>checked</i>)
+<b>on_userCheckBox_clicked</b>(<i></i>)
 
 <p>
         Private slot handling the switching of the 'user-site' mode.
 </p>
-<dl>
-
-<dt><i>checked</i> (bool)</dt>
-<dd>
-state of the 'user-site' check box
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.on_verboseCheckBox_clicked" ID="PipPackagesWidget.on_verboseCheckBox_clicked"></a>
 <h4>PipPackagesWidget.on_verboseCheckBox_clicked</h4>
 <b>on_verboseCheckBox_clicked</b>(<i>checked</i>)
@@ -966,6 +1046,20 @@
 state of the checkbox
 </dd>
 </dl>
+<a NAME="PipPackagesWidget.on_vulnerabilityCheckBox_clicked" ID="PipPackagesWidget.on_vulnerabilityCheckBox_clicked"></a>
+<h4>PipPackagesWidget.on_vulnerabilityCheckBox_clicked</h4>
+<b>on_vulnerabilityCheckBox_clicked</b>(<i>checked</i>)
+
+<p>
+        Private slot handling a change of the automatic vulnerability checks.
+</p>
+<dl>
+
+<dt><i>checked</i> (bool)</dt>
+<dd>
+flag indicating the state of the check box
+</dd>
+</dl>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />

eric ide

mercurial