eric6/Documentation/Source/eric6.PipInterface.PipPackagesWidget.html

changeset 8090
c53117374255
parent 8085
f6db8b3ecea9
child 8152
0c740fcffd34
diff -r e43bf8d7baf9 -r c53117374255 eric6/Documentation/Source/eric6.PipInterface.PipPackagesWidget.html
--- a/eric6/Documentation/Source/eric6.PipInterface.PipPackagesWidget.html	Tue Feb 09 11:39:58 2021 +0100
+++ b/eric6/Documentation/Source/eric6.PipInterface.PipPackagesWidget.html	Tue Feb 09 17:51:16 2021 +0100
@@ -61,7 +61,7 @@
 <h3>Class Attributes</h3>
 
 <table>
-<tr><td>SearchUrl</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>SearchVersionRole</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>
 
@@ -101,10 +101,6 @@
 <td>Private slot to edit the configuration of the selected environment.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.__executeUpgradePackages">__executeUpgradePackages</a></td>
-<td>Private method to execute the pip upgrade command.</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.__finishSearch">__finishSearch</a></td>
 <td>Private slot performing the search finishing actions.</td>
 </tr>
@@ -117,10 +113,6 @@
 <td>Private method to create the super menu and attach it to the super menu button.</td>
 </tr>
 <tr>
-<td><a href="#PipPackagesWidget.__install">__install</a></td>
-<td>Private slot to install the selected packages.</td>
-</tr>
-<tr>
 <td><a href="#PipPackagesWidget.__installLocalPackage">__installLocalPackage</a></td>
 <td>Private slot to install a package available on local storage.</td>
 </tr>
@@ -213,6 +205,22 @@
 <td>Private method to update the state of the search button.</td>
 </tr>
 <tr>
+<td><a href="#PipPackagesWidget.executeInstallPackages">executeInstallPackages</a></td>
+<td>Public method to install the given list of packages.</td>
+</tr>
+<tr>
+<td><a href="#PipPackagesWidget.executeUninstallPackages">executeUninstallPackages</a></td>
+<td>Public method to uninstall the given list of packages.</td>
+</tr>
+<tr>
+<td><a href="#PipPackagesWidget.executeUpgradePackages">executeUpgradePackages</a></td>
+<td>Public method to execute the pip upgrade command.</td>
+</tr>
+<tr>
+<td><a href="#PipPackagesWidget.getPip">getPip</a></td>
+<td>Public method to get a reference to the pip interface object.</td>
+</tr>
+<tr>
 <td><a href="#PipPackagesWidget.on_environmentsComboBox_currentIndexChanged">on_environmentsComboBox_currentIndexChanged</a></td>
 <td>Private slot handling the selection of a Python environment.</td>
 </tr>
@@ -399,32 +407,6 @@
 <p>
         Private slot to edit the configuration of the selected environment.
 </p>
-<a NAME="PipPackagesWidget.__executeUpgradePackages" ID="PipPackagesWidget.__executeUpgradePackages"></a>
-<h4>PipPackagesWidget.__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>
-<dl>
-<dt>Return:</dt>
-<dd>
-flag indicating success
-</dd>
-</dl>
-<dl>
-<dt>Return Type:</dt>
-<dd>
-bool
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a>
 <h4>PipPackagesWidget.__finishSearch</h4>
 <b>__finishSearch</b>(<i></i>)
@@ -447,20 +429,6 @@
         Private method to create the super menu and attach it to the super
         menu button.
 </p>
-<a NAME="PipPackagesWidget.__install" ID="PipPackagesWidget.__install"></a>
-<h4>PipPackagesWidget.__install</h4>
-<b>__install</b>(<i>userSite=False</i>)
-
-<p>
-        Private slot to install the selected packages.
-</p>
-<dl>
-
-<dt><i>userSite</i> (bool)</dt>
-<dd>
-flag indicating to install to the user directory
-</dd>
-</dl>
 <a NAME="PipPackagesWidget.__installLocalPackage" ID="PipPackagesWidget.__installLocalPackage"></a>
 <h4>PipPackagesWidget.__installLocalPackage</h4>
 <b>__installLocalPackage</b>(<i></i>)
@@ -616,7 +584,7 @@
 </p>
 <a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a>
 <h4>PipPackagesWidget.__showPackageDetails</h4>
-<b>__showPackageDetails</b>(<i>packageName, packageVersion</i>)
+<b>__showPackageDetails</b>(<i>packageName, packageVersion, upgradable=False, installable=False</i>)
 
 <p>
         Private method to populate the package details dialog.
@@ -631,6 +599,16 @@
 <dd>
 version of the package
 </dd>
+<dt><i>upgradable</i> (bool (optional))</dt>
+<dd>
+flag indicating that the package may be upgraded
+            (defaults to False)
+</dd>
+<dt><i>installable</i> (bool (optional))</dt>
+<dd>
+flag indicating that the package may be installed
+            (defaults to False)
+</dd>
 </dl>
 <a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
 <h4>PipPackagesWidget.__showSearchedDetails</h4>
@@ -674,6 +652,71 @@
 <p>
         Private method to update the state of the search button.
 </p>
+<a NAME="PipPackagesWidget.executeInstallPackages" ID="PipPackagesWidget.executeInstallPackages"></a>
+<h4>PipPackagesWidget.executeInstallPackages</h4>
+<b>executeInstallPackages</b>(<i>packages, userSite=False</i>)
+
+<p>
+        Public method to install the given list of packages.
+</p>
+<dl>
+
+<dt><i>packages</i> (list of str)</dt>
+<dd>
+list of package names to be installed
+</dd>
+<dt><i>userSite</i> (bool)</dt>
+<dd>
+flag indicating to install to the user directory
+</dd>
+</dl>
+<a NAME="PipPackagesWidget.executeUninstallPackages" ID="PipPackagesWidget.executeUninstallPackages"></a>
+<h4>PipPackagesWidget.executeUninstallPackages</h4>
+<b>executeUninstallPackages</b>(<i>packages</i>)
+
+<p>
+        Public method to uninstall the given list of packages.
+</p>
+<dl>
+
+<dt><i>packages</i> (list of str)</dt>
+<dd>
+list of package names to be uninstalled
+</dd>
+</dl>
+<a NAME="PipPackagesWidget.executeUpgradePackages" ID="PipPackagesWidget.executeUpgradePackages"></a>
+<h4>PipPackagesWidget.executeUpgradePackages</h4>
+<b>executeUpgradePackages</b>(<i>packages</i>)
+
+<p>
+        Public 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="PipPackagesWidget.getPip" ID="PipPackagesWidget.getPip"></a>
+<h4>PipPackagesWidget.getPip</h4>
+<b>getPip</b>(<i></i>)
+
+<p>
+        Public method to get a reference to the pip interface object.
+</p>
+<dl>
+<dt>Return:</dt>
+<dd>
+reference to the pip interface object
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+Pip
+</dd>
+</dl>
 <a NAME="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged" ID="PipPackagesWidget.on_environmentsComboBox_currentIndexChanged"></a>
 <h4>PipPackagesWidget.on_environmentsComboBox_currentIndexChanged</h4>
 <b>on_environmentsComboBox_currentIndexChanged</b>(<i>index</i>)

eric ide

mercurial