--- a/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.PipPackagesWidget.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,19 +7,17 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.PipInterface.PipPackagesWidget</h1>
-
<p>
Module implementing the pip packages management widget.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#PipPackagesWidget">PipPackagesWidget</a></td>
<td>Class implementing the pip packages management widget.</td>
@@ -29,35 +27,47 @@
<td>Class implementing the parser for the PyPI search result page.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="PipPackagesWidget" ID="PipPackagesWidget"></a>
<h2>PipPackagesWidget</h2>
-
<p>
Class implementing the pip packages management widget.
</p>
+
<h3>Derived from</h3>
QWidget, Ui_PipPackagesWidget
<h3>Class Attributes</h3>
+<table>
+<tr><td>AvailableVersionColumn</td></tr>
+<tr><td>DepInstalledVersionColumn</td></tr>
+<tr><td>DepPackageColumn</td></tr>
+<tr><td>DepRequiredVersionColumn</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>ShowProcessUrlsListMode</td></tr>
+<tr><td>VulnerabilityColumn</td></tr>
+<tr><td>VulnerabilityRole</td></tr>
+</table>
-<table>
-<tr><td>AvailableVersionColumn</td></tr><tr><td>DepInstalledVersionColumn</td></tr><tr><td>DepPackageColumn</td></tr><tr><td>DepRequiredVersionColumn</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>ShowProcessUrlsListMode</td></tr><tr><td>VulnerabilityColumn</td></tr><tr><td>VulnerabilityRole</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PipPackagesWidget.__init__">PipPackagesWidget</a></td>
<td>Constructor</td>
@@ -435,19 +445,20 @@
<td>Public slot to set the enabled state of the vulnerability checks.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PipPackagesWidget.__init__" ID="PipPackagesWidget.__init__"></a>
<h4>PipPackagesWidget (Constructor)</h4>
<b>PipPackagesWidget</b>(<i>pip, parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>pip</i> (Pip)</dt>
@@ -462,17 +473,17 @@
<a NAME="PipPackagesWidget.__aboutToShowPipMenu" ID="PipPackagesWidget.__aboutToShowPipMenu"></a>
<h4>PipPackagesWidget.__aboutToShowPipMenu</h4>
<b>__aboutToShowPipMenu</b>(<i></i>)
-
<p>
Private slot to set the action enabled status.
</p>
+
<a NAME="PipPackagesWidget.__addDependency" ID="PipPackagesWidget.__addDependency"></a>
<h4>PipPackagesWidget.__addDependency</h4>
<b>__addDependency</b>(<i>dependency, parent</i>)
-
<p>
Private method to add a dependency branch to a given parent.
</p>
+
<dl>
<dt><i>dependency</i> (dict)</dt>
@@ -487,10 +498,10 @@
<a NAME="PipPackagesWidget.__allPackageNames" ID="PipPackagesWidget.__allPackageNames"></a>
<h4>PipPackagesWidget.__allPackageNames</h4>
<b>__allPackageNames</b>(<i></i>)
-
<p>
Private method to get a list of all package names.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -506,10 +517,10 @@
<a NAME="PipPackagesWidget.__allUpdateableItems" ID="PipPackagesWidget.__allUpdateableItems"></a>
<h4>PipPackagesWidget.__allUpdateableItems</h4>
<b>__allUpdateableItems</b>(<i></i>)
-
<p>
Private method to get a list of all items that can be updated.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -525,10 +536,10 @@
<a NAME="PipPackagesWidget.__availablePipVersion" ID="PipPackagesWidget.__availablePipVersion"></a>
<h4>PipPackagesWidget.__availablePipVersion</h4>
<b>__availablePipVersion</b>(<i></i>)
-
<p>
Private method to get the pip version of the selected environment.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -545,31 +556,31 @@
<a NAME="PipPackagesWidget.__checkVulnerability" ID="PipPackagesWidget.__checkVulnerability"></a>
<h4>PipPackagesWidget.__checkVulnerability</h4>
<b>__checkVulnerability</b>(<i></i>)
-
<p>
Private slot to update and show the vulnerability data (called from the menu).
</p>
+
<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.__createSBOMFile" ID="PipPackagesWidget.__createSBOMFile"></a>
<h4>PipPackagesWidget.__createSBOMFile</h4>
<b>__createSBOMFile</b>(<i></i>)
-
<p>
Private slot to create a "Software Bill Of Material" file.
</p>
+
<a NAME="PipPackagesWidget.__editConfiguration" ID="PipPackagesWidget.__editConfiguration"></a>
<h4>PipPackagesWidget.__editConfiguration</h4>
<b>__editConfiguration</b>(<i>venvName=""</i>)
-
<p>
Private method to edit a configuration.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -580,90 +591,90 @@
<a NAME="PipPackagesWidget.__editUserConfiguration" ID="PipPackagesWidget.__editUserConfiguration"></a>
<h4>PipPackagesWidget.__editUserConfiguration</h4>
<b>__editUserConfiguration</b>(<i></i>)
-
<p>
Private slot to edit the user configuration.
</p>
+
<a NAME="PipPackagesWidget.__editVirtualenvConfiguration" ID="PipPackagesWidget.__editVirtualenvConfiguration"></a>
<h4>PipPackagesWidget.__editVirtualenvConfiguration</h4>
<b>__editVirtualenvConfiguration</b>(<i></i>)
-
<p>
Private slot to edit the configuration of the selected environment.
</p>
+
<a NAME="PipPackagesWidget.__finishSearch" ID="PipPackagesWidget.__finishSearch"></a>
<h4>PipPackagesWidget.__finishSearch</h4>
<b>__finishSearch</b>(<i></i>)
-
<p>
Private slot performing the search finishing actions.
</p>
+
<a NAME="PipPackagesWidget.__generateConstraints" ID="PipPackagesWidget.__generateConstraints"></a>
<h4>PipPackagesWidget.__generateConstraints</h4>
<b>__generateConstraints</b>(<i></i>)
-
<p>
Private slot to generate the contents for a constraints file.
</p>
+
<a NAME="PipPackagesWidget.__generateRequirements" ID="PipPackagesWidget.__generateRequirements"></a>
<h4>PipPackagesWidget.__generateRequirements</h4>
<b>__generateRequirements</b>(<i></i>)
-
<p>
Private slot to generate the contents for a requirements file.
</p>
+
<a NAME="PipPackagesWidget.__initPipMenu" ID="PipPackagesWidget.__initPipMenu"></a>
<h4>PipPackagesWidget.__initPipMenu</h4>
<b>__initPipMenu</b>(<i></i>)
-
<p>
Private method to create the super menu and attach it to the super
menu button.
</p>
+
<a NAME="PipPackagesWidget.__installLocalPackage" ID="PipPackagesWidget.__installLocalPackage"></a>
<h4>PipPackagesWidget.__installLocalPackage</h4>
<b>__installLocalPackage</b>(<i></i>)
-
<p>
Private slot to install a package available on local storage.
</p>
+
<a NAME="PipPackagesWidget.__installPackages" ID="PipPackagesWidget.__installPackages"></a>
<h4>PipPackagesWidget.__installPackages</h4>
<b>__installPackages</b>(<i></i>)
-
<p>
Private slot to install packages to be given by the user.
</p>
+
<a NAME="PipPackagesWidget.__installPip" ID="PipPackagesWidget.__installPip"></a>
<h4>PipPackagesWidget.__installPip</h4>
<b>__installPip</b>(<i></i>)
-
<p>
Private slot to install pip into the selected environment.
</p>
+
<a NAME="PipPackagesWidget.__installPipUser" ID="PipPackagesWidget.__installPipUser"></a>
<h4>PipPackagesWidget.__installPipUser</h4>
<b>__installPipUser</b>(<i></i>)
-
<p>
Private slot to install pip into the user site for the selected
environment.
</p>
+
<a NAME="PipPackagesWidget.__installRequirements" ID="PipPackagesWidget.__installRequirements"></a>
<h4>PipPackagesWidget.__installRequirements</h4>
<b>__installRequirements</b>(<i></i>)
-
<p>
Private slot to install packages as given in a requirements file.
</p>
+
<a NAME="PipPackagesWidget.__isPipAvailable" ID="PipPackagesWidget.__isPipAvailable"></a>
<h4>PipPackagesWidget.__isPipAvailable</h4>
<b>__isPipAvailable</b>(<i></i>)
-
<p>
Private method to check, if the pip package is available for the
selected environment.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -679,24 +690,24 @@
<a NAME="PipPackagesWidget.__pipConfigure" ID="PipPackagesWidget.__pipConfigure"></a>
<h4>PipPackagesWidget.__pipConfigure</h4>
<b>__pipConfigure</b>(<i></i>)
-
<p>
Private slot to open the configuration page.
</p>
+
<a NAME="PipPackagesWidget.__populateEnvironments" ID="PipPackagesWidget.__populateEnvironments"></a>
<h4>PipPackagesWidget.__populateEnvironments</h4>
<b>__populateEnvironments</b>(<i></i>)
-
<p>
Private method to get a list of environments and populate the selector.
</p>
+
<a NAME="PipPackagesWidget.__projectClosed" ID="PipPackagesWidget.__projectClosed"></a>
<h4>PipPackagesWidget.__projectClosed</h4>
<b>__projectClosed</b>(<i>shutdown</i>)
-
<p>
Private slot to handle the projectClosed signal.
</p>
+
<dl>
<dt><i>shutdown</i> (bool)</dt>
@@ -707,60 +718,60 @@
<a NAME="PipPackagesWidget.__projectOpened" ID="PipPackagesWidget.__projectOpened"></a>
<h4>PipPackagesWidget.__projectOpened</h4>
<b>__projectOpened</b>(<i></i>)
-
<p>
Private slot to handle the projectOpened signal.
</p>
+
<a NAME="PipPackagesWidget.__purgeCache" ID="PipPackagesWidget.__purgeCache"></a>
<h4>PipPackagesWidget.__purgeCache</h4>
<b>__purgeCache</b>(<i></i>)
-
<p>
Private slot to empty the pip cache.
</p>
+
<a NAME="PipPackagesWidget.__refreshDependencyTree" ID="PipPackagesWidget.__refreshDependencyTree"></a>
<h4>PipPackagesWidget.__refreshDependencyTree</h4>
<b>__refreshDependencyTree</b>(<i></i>)
-
<p>
Private method to refresh the dependency tree.
</p>
+
<a NAME="PipPackagesWidget.__refreshPackagesList" ID="PipPackagesWidget.__refreshPackagesList"></a>
<h4>PipPackagesWidget.__refreshPackagesList</h4>
<b>__refreshPackagesList</b>(<i></i>)
-
<p>
Private method to refresh the packages list.
</p>
+
<a NAME="PipPackagesWidget.__reinstallPackages" ID="PipPackagesWidget.__reinstallPackages"></a>
<h4>PipPackagesWidget.__reinstallPackages</h4>
<b>__reinstallPackages</b>(<i></i>)
-
<p>
Private slot to force a re-installation of the selected packages.
</p>
+
<a NAME="PipPackagesWidget.__removeCachedFiles" ID="PipPackagesWidget.__removeCachedFiles"></a>
<h4>PipPackagesWidget.__removeCachedFiles</h4>
<b>__removeCachedFiles</b>(<i></i>)
-
<p>
Private slot to remove files from the pip cache.
</p>
+
<a NAME="PipPackagesWidget.__repairPip" ID="PipPackagesWidget.__repairPip"></a>
<h4>PipPackagesWidget.__repairPip</h4>
<b>__repairPip</b>(<i></i>)
-
<p>
Private slot to repair the pip installation of the selected
environment.
</p>
+
<a NAME="PipPackagesWidget.__search" ID="PipPackagesWidget.__search"></a>
<h4>PipPackagesWidget.__search</h4>
<b>__search</b>(<i>page=1</i>)
-
<p>
Private method to perform the search by calling the PyPI search URL.
</p>
+
<dl>
<dt><i>page</i> (int (optional))</dt>
@@ -771,17 +782,17 @@
<a NAME="PipPackagesWidget.__searchFirst" ID="PipPackagesWidget.__searchFirst"></a>
<h4>PipPackagesWidget.__searchFirst</h4>
<b>__searchFirst</b>(<i></i>)
-
<p>
Private method to perform the search for packages.
</p>
+
<a NAME="PipPackagesWidget.__searchResponse" ID="PipPackagesWidget.__searchResponse"></a>
<h4>PipPackagesWidget.__searchResponse</h4>
<b>__searchResponse</b>(<i>reply</i>)
-
<p>
Private method to extract the search result data from the response.
</p>
+
<dl>
<dt><i>reply</i> (QNetworkReply)</dt>
@@ -792,10 +803,10 @@
<a NAME="PipPackagesWidget.__selectedUpdateableItems" ID="PipPackagesWidget.__selectedUpdateableItems"></a>
<h4>PipPackagesWidget.__selectedUpdateableItems</h4>
<b>__selectedUpdateableItems</b>(<i></i>)
-
<p>
Private method to get a list of selected items that can be updated.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -811,32 +822,32 @@
<a NAME="PipPackagesWidget.__showCacheInfo" ID="PipPackagesWidget.__showCacheInfo"></a>
<h4>PipPackagesWidget.__showCacheInfo</h4>
<b>__showCacheInfo</b>(<i></i>)
-
<p>
Private slot to show information about the cache.
</p>
+
<a NAME="PipPackagesWidget.__showCacheList" ID="PipPackagesWidget.__showCacheList"></a>
<h4>PipPackagesWidget.__showCacheList</h4>
<b>__showCacheList</b>(<i></i>)
-
<p>
Private slot to show a list of cached files.
</p>
+
<a NAME="PipPackagesWidget.__showLicensesDialog" ID="PipPackagesWidget.__showLicensesDialog"></a>
<h4>PipPackagesWidget.__showLicensesDialog</h4>
<b>__showLicensesDialog</b>(<i></i>)
-
<p>
Private slot to show a dialog with the licenses of the selected
environment.
</p>
+
<a NAME="PipPackagesWidget.__showPackageDetails" ID="PipPackagesWidget.__showPackageDetails"></a>
<h4>PipPackagesWidget.__showPackageDetails</h4>
<b>__showPackageDetails</b>(<i>packageName, packageVersion, vulnerabilities=None, upgradable=False, installable=False, </i>)
-
<p>
Private method to populate the package details dialog.
</p>
+
<dl>
<dt><i>packageName</i> (str)</dt>
@@ -865,10 +876,10 @@
<a NAME="PipPackagesWidget.__showPackageInformation" ID="PipPackagesWidget.__showPackageInformation"></a>
<h4>PipPackagesWidget.__showPackageInformation</h4>
<b>__showPackageInformation</b>(<i>packageName, infoWidget</i>)
-
<p>
Private method to show information for a package.
</p>
+
<dl>
<dt><i>packageName</i> (str)</dt>
@@ -883,10 +894,10 @@
<a NAME="PipPackagesWidget.__showSearchedDetails" ID="PipPackagesWidget.__showSearchedDetails"></a>
<h4>PipPackagesWidget.__showSearchedDetails</h4>
<b>__showSearchedDetails</b>(<i>item=None</i>)
-
<p>
Private slot to show details about the selected search result package.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -897,10 +908,10 @@
<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>
@@ -919,31 +930,31 @@
<a NAME="PipPackagesWidget.__uninstallRequirements" ID="PipPackagesWidget.__uninstallRequirements"></a>
<h4>PipPackagesWidget.__uninstallRequirements</h4>
<b>__uninstallRequirements</b>(<i></i>)
-
<p>
Private slot to uninstall packages as given in a requirements file.
</p>
+
<a NAME="PipPackagesWidget.__updateActionButtons" ID="PipPackagesWidget.__updateActionButtons"></a>
<h4>PipPackagesWidget.__updateActionButtons</h4>
<b>__updateActionButtons</b>(<i></i>)
-
<p>
Private method to set the state of the action buttons.
</p>
+
<a NAME="PipPackagesWidget.__updateDepActionButtons" ID="PipPackagesWidget.__updateDepActionButtons"></a>
<h4>PipPackagesWidget.__updateDepActionButtons</h4>
<b>__updateDepActionButtons</b>(<i></i>)
-
<p>
Private method to set the state of the dependency page action buttons.
</p>
+
<a NAME="PipPackagesWidget.__updateOutdatedInfo" ID="PipPackagesWidget.__updateOutdatedInfo"></a>
<h4>PipPackagesWidget.__updateOutdatedInfo</h4>
<b>__updateOutdatedInfo</b>(<i>outdatedPackages</i>)
-
<p>
Private method to process the list of outdated packages.
</p>
+
<dl>
<dt><i>outdatedPackages</i> (list of tuple of (str, str, str))</dt>
@@ -955,24 +966,24 @@
<a NAME="PipPackagesWidget.__updateSearchActionButtons" ID="PipPackagesWidget.__updateSearchActionButtons"></a>
<h4>PipPackagesWidget.__updateSearchActionButtons</h4>
<b>__updateSearchActionButtons</b>(<i></i>)
-
<p>
Private method to update the action button states of the search widget.
</p>
+
<a NAME="PipPackagesWidget.__updateSearchButton" ID="PipPackagesWidget.__updateSearchButton"></a>
<h4>PipPackagesWidget.__updateSearchButton</h4>
<b>__updateSearchButton</b>(<i></i>)
-
<p>
Private method to update the state of the search button.
</p>
+
<a NAME="PipPackagesWidget.__updateSearchMoreButton" ID="PipPackagesWidget.__updateSearchMoreButton"></a>
<h4>PipPackagesWidget.__updateSearchMoreButton</h4>
<b>__updateSearchMoreButton</b>(<i>enable</i>)
-
<p>
Private method to update the state of the search more button.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -983,10 +994,10 @@
<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>
@@ -998,18 +1009,18 @@
<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>)
-
<p>
Public method to install the given list of packages.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -1024,10 +1035,10 @@
<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>
@@ -1038,10 +1049,10 @@
<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>
@@ -1052,10 +1063,10 @@
<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>
@@ -1071,11 +1082,11 @@
<a NAME="PipPackagesWidget.on_dependenciesList_itemActivated" ID="PipPackagesWidget.on_dependenciesList_itemActivated"></a>
<h4>PipPackagesWidget.on_dependenciesList_itemActivated</h4>
<b>on_dependenciesList_itemActivated</b>(<i>item, column</i>)
-
<p>
Private slot reacting on a package item of the dependency tree being
activated.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -1090,11 +1101,11 @@
<a NAME="PipPackagesWidget.on_dependenciesList_itemPressed" ID="PipPackagesWidget.on_dependenciesList_itemPressed"></a>
<h4>PipPackagesWidget.on_dependenciesList_itemPressed</h4>
<b>on_dependenciesList_itemPressed</b>(<i>item, column</i>)
-
<p>
Private slot reacting on a package item of the dependency tree being
pressed.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -1109,32 +1120,32 @@
<a NAME="PipPackagesWidget.on_dependenciesList_itemSelectionChanged" ID="PipPackagesWidget.on_dependenciesList_itemSelectionChanged"></a>
<h4>PipPackagesWidget.on_dependenciesList_itemSelectionChanged</h4>
<b>on_dependenciesList_itemSelectionChanged</b>(<i></i>)
-
<p>
Private slot reacting on a change of selected items of the dependency
tree.
</p>
+
<a NAME="PipPackagesWidget.on_dependencyRepairAllButton_clicked" ID="PipPackagesWidget.on_dependencyRepairAllButton_clicked"></a>
<h4>PipPackagesWidget.on_dependencyRepairAllButton_clicked</h4>
<b>on_dependencyRepairAllButton_clicked</b>(<i></i>)
-
<p>
Private slot to repair all dependencies.
</p>
+
<a NAME="PipPackagesWidget.on_dependencyRepairButton_clicked" ID="PipPackagesWidget.on_dependencyRepairButton_clicked"></a>
<h4>PipPackagesWidget.on_dependencyRepairButton_clicked</h4>
<b>on_dependencyRepairButton_clicked</b>(<i></i>)
-
<p>
Private slot to repair all selected dependencies.
</p>
+
<a NAME="PipPackagesWidget.on_environmentsComboBox_currentTextChanged" ID="PipPackagesWidget.on_environmentsComboBox_currentTextChanged"></a>
<h4>PipPackagesWidget.on_environmentsComboBox_currentTextChanged</h4>
<b>on_environmentsComboBox_currentTextChanged</b>(<i>name</i>)
-
<p>
Private slot handling the selection of a Python environment.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -1145,25 +1156,25 @@
<a NAME="PipPackagesWidget.on_installButton_clicked" ID="PipPackagesWidget.on_installButton_clicked"></a>
<h4>PipPackagesWidget.on_installButton_clicked</h4>
<b>on_installButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle pressing the Install button..
</p>
+
<a NAME="PipPackagesWidget.on_installUserSiteButton_clicked" ID="PipPackagesWidget.on_installUserSiteButton_clicked"></a>
<h4>PipPackagesWidget.on_installUserSiteButton_clicked</h4>
<b>on_installUserSiteButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle pressing the Install to User-Site button..
</p>
+
<a NAME="PipPackagesWidget.on_installedFilesCheckBox_clicked" ID="PipPackagesWidget.on_installedFilesCheckBox_clicked"></a>
<h4>PipPackagesWidget.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>
@@ -1174,31 +1185,31 @@
<a NAME="PipPackagesWidget.on_localCheckBox_clicked" ID="PipPackagesWidget.on_localCheckBox_clicked"></a>
<h4>PipPackagesWidget.on_localCheckBox_clicked</h4>
<b>on_localCheckBox_clicked</b>(<i></i>)
-
<p>
Private slot handling the switching of the local mode.
</p>
+
<a NAME="PipPackagesWidget.on_localDepCheckBox_clicked" ID="PipPackagesWidget.on_localDepCheckBox_clicked"></a>
<h4>PipPackagesWidget.on_localDepCheckBox_clicked</h4>
<b>on_localDepCheckBox_clicked</b>(<i></i>)
-
<p>
Private slot handling the switching of the local mode.
</p>
+
<a NAME="PipPackagesWidget.on_notRequiredCheckBox_clicked" ID="PipPackagesWidget.on_notRequiredCheckBox_clicked"></a>
<h4>PipPackagesWidget.on_notRequiredCheckBox_clicked</h4>
<b>on_notRequiredCheckBox_clicked</b>(<i></i>)
-
<p>
Private slot handling the switching of the 'not required' mode.
</p>
+
<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>)
-
<p>
Private slot reacting on a package item being activated.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -1213,31 +1224,31 @@
<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>)
-
<p>
Private slot reacting on a change of selected items.
</p>
+
<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>)
-
<p>
Private slot to refresh the display.
</p>
+
<a NAME="PipPackagesWidget.on_refreshDependenciesButton_clicked" ID="PipPackagesWidget.on_refreshDependenciesButton_clicked"></a>
<h4>PipPackagesWidget.on_refreshDependenciesButton_clicked</h4>
<b>on_refreshDependenciesButton_clicked</b>(<i></i>)
-
<p>
Private slot to refresh the dependency tree.
</p>
+
<a NAME="PipPackagesWidget.on_requiresButton_toggled" ID="PipPackagesWidget.on_requiresButton_toggled"></a>
<h4>PipPackagesWidget.on_requiresButton_toggled</h4>
<b>on_requiresButton_toggled</b>(<i>checked</i>)
-
<p>
Private slot handling the selection of the view type.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -1248,31 +1259,31 @@
<a NAME="PipPackagesWidget.on_searchButton_clicked" ID="PipPackagesWidget.on_searchButton_clicked"></a>
<h4>PipPackagesWidget.on_searchButton_clicked</h4>
<b>on_searchButton_clicked</b>(<i></i>)
-
<p>
Private slot handling a press of the search button.
</p>
+
<a NAME="PipPackagesWidget.on_searchMoreButton_clicked" ID="PipPackagesWidget.on_searchMoreButton_clicked"></a>
<h4>PipPackagesWidget.on_searchMoreButton_clicked</h4>
<b>on_searchMoreButton_clicked</b>(<i></i>)
-
<p>
Private slot handling a press of the search more button.
</p>
+
<a NAME="PipPackagesWidget.on_searchNameEdit_returnPressed" ID="PipPackagesWidget.on_searchNameEdit_returnPressed"></a>
<h4>PipPackagesWidget.on_searchNameEdit_returnPressed</h4>
<b>on_searchNameEdit_returnPressed</b>(<i></i>)
-
<p>
Private slot initiating a search via a press of the Return key.
</p>
+
<a NAME="PipPackagesWidget.on_searchNameEdit_textChanged" ID="PipPackagesWidget.on_searchNameEdit_textChanged"></a>
<h4>PipPackagesWidget.on_searchNameEdit_textChanged</h4>
<b>on_searchNameEdit_textChanged</b>(<i>txt</i>)
-
<p>
Private slot handling a change of the search term.
</p>
+
<dl>
<dt><i>txt</i> (str)</dt>
@@ -1283,10 +1294,10 @@
<a NAME="PipPackagesWidget.on_searchResultList_itemActivated" ID="PipPackagesWidget.on_searchResultList_itemActivated"></a>
<h4>PipPackagesWidget.on_searchResultList_itemActivated</h4>
<b>on_searchResultList_itemActivated</b>(<i>item, column</i>)
-
<p>
Private slot reacting on an search result item activation.
</p>
+
<dl>
<dt><i>item</i> (QTreeWidgetItem)</dt>
@@ -1301,17 +1312,17 @@
<a NAME="PipPackagesWidget.on_searchResultList_itemSelectionChanged" ID="PipPackagesWidget.on_searchResultList_itemSelectionChanged"></a>
<h4>PipPackagesWidget.on_searchResultList_itemSelectionChanged</h4>
<b>on_searchResultList_itemSelectionChanged</b>(<i></i>)
-
<p>
Private slot handling changes of the search result selection.
</p>
+
<a NAME="PipPackagesWidget.on_searchToggleButton_1_toggled" ID="PipPackagesWidget.on_searchToggleButton_1_toggled"></a>
<h4>PipPackagesWidget.on_searchToggleButton_1_toggled</h4>
<b>on_searchToggleButton_1_toggled</b>(<i>checked</i>)
-
<p>
Private slot to toggle the search widget.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -1322,10 +1333,10 @@
<a NAME="PipPackagesWidget.on_searchToggleButton_2_toggled" ID="PipPackagesWidget.on_searchToggleButton_2_toggled"></a>
<h4>PipPackagesWidget.on_searchToggleButton_2_toggled</h4>
<b>on_searchToggleButton_2_toggled</b>(<i>checked</i>)
-
<p>
Private slot to toggle the search widget.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -1336,68 +1347,68 @@
<a NAME="PipPackagesWidget.on_showDepPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showDepPackageDetailsButton_clicked"></a>
<h4>PipPackagesWidget.on_showDepPackageDetailsButton_clicked</h4>
<b>on_showDepPackageDetailsButton_clicked</b>(<i></i>)
-
<p>
Private slot to show information for the selected package of the
dependency tree.
</p>
+
<a NAME="PipPackagesWidget.on_showDetailsButton_clicked" ID="PipPackagesWidget.on_showDetailsButton_clicked"></a>
<h4>PipPackagesWidget.on_showDetailsButton_clicked</h4>
<b>on_showDetailsButton_clicked</b>(<i></i>)
-
<p>
Private slot to handle pressing the Show Details button.
</p>
+
<a NAME="PipPackagesWidget.on_showPackageDetailsButton_clicked" ID="PipPackagesWidget.on_showPackageDetailsButton_clicked"></a>
<h4>PipPackagesWidget.on_showPackageDetailsButton_clicked</h4>
<b>on_showPackageDetailsButton_clicked</b>(<i></i>)
-
<p>
Private slot to show information for the selected package.
</p>
+
<a NAME="PipPackagesWidget.on_uninstallButton_clicked" ID="PipPackagesWidget.on_uninstallButton_clicked"></a>
<h4>PipPackagesWidget.on_uninstallButton_clicked</h4>
<b>on_uninstallButton_clicked</b>(<i></i>)
-
<p>
Private slot to remove selected packages of the selected environment.
</p>
+
<a NAME="PipPackagesWidget.on_upgradeAllButton_clicked" ID="PipPackagesWidget.on_upgradeAllButton_clicked"></a>
<h4>PipPackagesWidget.on_upgradeAllButton_clicked</h4>
<b>on_upgradeAllButton_clicked</b>(<i></i>)
-
<p>
Private slot to upgrade all packages of the selected environment.
</p>
+
<a NAME="PipPackagesWidget.on_upgradeButton_clicked" ID="PipPackagesWidget.on_upgradeButton_clicked"></a>
<h4>PipPackagesWidget.on_upgradeButton_clicked</h4>
<b>on_upgradeButton_clicked</b>(<i></i>)
-
<p>
Private slot to upgrade selected packages of the selected environment.
</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></i>)
-
<p>
Private slot handling the switching of the 'user-site' mode.
</p>
+
<a NAME="PipPackagesWidget.on_userDepCheckBox_clicked" ID="PipPackagesWidget.on_userDepCheckBox_clicked"></a>
<h4>PipPackagesWidget.on_userDepCheckBox_clicked</h4>
<b>on_userDepCheckBox_clicked</b>(<i></i>)
-
<p>
Private slot handling the switching of the 'user-site' mode.
</p>
+
<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>)
-
<p>
Private slot to handle a change of the verbose package information
checkbox.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -1408,10 +1419,10 @@
<a NAME="PipPackagesWidget.on_viewToggleButton_toggled" ID="PipPackagesWidget.on_viewToggleButton_toggled"></a>
<h4>PipPackagesWidget.on_viewToggleButton_toggled</h4>
<b>on_viewToggleButton_toggled</b>(<i>checked</i>)
-
<p>
Private slot handling the view selection.
</p>
+
<dl>
<dt><i>checked</i> (bool)</dt>
@@ -1422,10 +1433,10 @@
<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>
@@ -1436,17 +1447,17 @@
<a NAME="PipPackagesWidget.preferencesChanged" ID="PipPackagesWidget.preferencesChanged"></a>
<h4>PipPackagesWidget.preferencesChanged</h4>
<b>preferencesChanged</b>(<i></i>)
-
<p>
Public slot to handle a change of preferences.
</p>
+
<a NAME="PipPackagesWidget.setVulnerabilityEnabled" ID="PipPackagesWidget.setVulnerabilityEnabled"></a>
<h4>PipPackagesWidget.setVulnerabilityEnabled</h4>
<b>setVulnerabilityEnabled</b>(<i>enable</i>)
-
<p>
Public slot to set the enabled state of the vulnerability checks.
</p>
+
<dl>
<dt><i>enable</i> (bool)</dt>
@@ -1459,26 +1470,24 @@
<hr />
<a NAME="PypiSearchResultsParser" ID="PypiSearchResultsParser"></a>
<h2>PypiSearchResultsParser</h2>
-
<p>
Class implementing the parser for the PyPI search result page.
</p>
+
<h3>Derived from</h3>
html.parser.HTMLParser
<h3>Class Attributes</h3>
-
<table>
<tr><td>ClassPrefix</td></tr>
</table>
+
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#PypiSearchResultsParser.__init__">PypiSearchResultsParser</a></td>
<td>Constructor</td>
@@ -1508,19 +1517,20 @@
<td>Public method to process the start tag.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="PypiSearchResultsParser.__init__" ID="PypiSearchResultsParser.__init__"></a>
<h4>PypiSearchResultsParser (Constructor)</h4>
<b>PypiSearchResultsParser</b>(<i>data</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>data</i> (str)</dt>
@@ -1531,11 +1541,11 @@
<a NAME="PypiSearchResultsParser.__getClass" ID="PypiSearchResultsParser.__getClass"></a>
<h4>PypiSearchResultsParser.__getClass</h4>
<b>__getClass</b>(<i>attrs</i>)
-
<p>
Private method to extract the class attribute out of the list of
attributes.
</p>
+
<dl>
<dt><i>attrs</i> (list of tuple of (str, str))</dt>
@@ -1558,11 +1568,11 @@
<a NAME="PypiSearchResultsParser.__getDate" ID="PypiSearchResultsParser.__getDate"></a>
<h4>PypiSearchResultsParser.__getDate</h4>
<b>__getDate</b>(<i>attrs</i>)
-
<p>
Private method to extract the datetime attribute out of the list of
attributes and process it.
</p>
+
<dl>
<dt><i>attrs</i> (list of tuple of (str, str))</dt>
@@ -1585,10 +1595,10 @@
<a NAME="PypiSearchResultsParser.getResults" ID="PypiSearchResultsParser.getResults"></a>
<h4>PypiSearchResultsParser.getResults</h4>
<b>getResults</b>(<i></i>)
-
<p>
Public method to get the extracted search results.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -1604,10 +1614,10 @@
<a NAME="PypiSearchResultsParser.handle_data" ID="PypiSearchResultsParser.handle_data"></a>
<h4>PypiSearchResultsParser.handle_data</h4>
<b>handle_data</b>(<i>data</i>)
-
<p>
Public method process arbitrary data.
</p>
+
<dl>
<dt><i>data</i> (str)</dt>
@@ -1618,10 +1628,10 @@
<a NAME="PypiSearchResultsParser.handle_endtag" ID="PypiSearchResultsParser.handle_endtag"></a>
<h4>PypiSearchResultsParser.handle_endtag</h4>
<b>handle_endtag</b>(<i>tag</i>)
-
<p>
Public method to process the end tag.
</p>
+
<dl>
<dt><i>tag</i> (str)</dt>
@@ -1632,10 +1642,10 @@
<a NAME="PypiSearchResultsParser.handle_starttag" ID="PypiSearchResultsParser.handle_starttag"></a>
<h4>PypiSearchResultsParser.handle_starttag</h4>
<b>handle_starttag</b>(<i>tag, attrs</i>)
-
<p>
Public method to process the start tag.
</p>
+
<dl>
<dt><i>tag</i> (str)</dt>
@@ -1649,4 +1659,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
