--- a/src/eric7/Documentation/Source/eric7.PipInterface.Pip.html Thu Jan 04 17:16:15 2024 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.Pip.html Thu Jan 04 18:02:25 2024 +0100
@@ -7,53 +7,53 @@
<body>
<a NAME="top" ID="top"></a>
<h1>eric7.PipInterface.Pip</h1>
-
<p>
Package implementing the pip GUI logic.
</p>
+
<h3>Global Attributes</h3>
-
<table>
<tr><td>SSL_AVAILABLE</td></tr>
</table>
+
<h3>Classes</h3>
-
<table>
-
<tr>
<td><a href="#Pip">Pip</a></td>
<td>Class implementing the pip GUI logic.</td>
</tr>
</table>
+
<h3>Functions</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<hr />
<hr />
<a NAME="Pip" ID="Pip"></a>
<h2>Pip</h2>
-
<p>
Class implementing the pip GUI logic.
</p>
+
<h3>Derived from</h3>
QObject
<h3>Class Attributes</h3>
+<table>
+<tr><td>DefaultIndexUrlPypi</td></tr>
+<tr><td>DefaultIndexUrlSearch</td></tr>
+<tr><td>DefaultIndexUrlSimple</td></tr>
+<tr><td>DefaultPyPiUrl</td></tr>
+</table>
-<table>
-<tr><td>DefaultIndexUrlPypi</td></tr><tr><td>DefaultIndexUrlSearch</td></tr><tr><td>DefaultIndexUrlSimple</td></tr><tr><td>DefaultPyPiUrl</td></tr>
-</table>
<h3>Class Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<h3>Methods</h3>
-
<table>
-
<tr>
<td><a href="#Pip.__init__">Pip</a></td>
<td>Constructor</td>
@@ -203,19 +203,20 @@
<td>Public method to upgrade the given list of packages.</td>
</tr>
</table>
+
<h3>Static Methods</h3>
-
<table>
<tr><td>None</td></tr>
</table>
+
<a NAME="Pip.__init__" ID="Pip.__init__"></a>
<h4>Pip (Constructor)</h4>
<b>Pip</b>(<i>parent=None</i>)
-
<p>
Constructor
</p>
+
<dl>
<dt><i>parent</i> (QObject)</dt>
@@ -226,11 +227,11 @@
<a NAME="Pip.__checkUpgradeEric" ID="Pip.__checkUpgradeEric"></a>
<h4>Pip.__checkUpgradeEric</h4>
<b>__checkUpgradeEric</b>(<i>packages</i>)
-
<p>
Private method to check, if an upgrade of the eric-ide package is
attempted.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -253,10 +254,10 @@
<a NAME="Pip.__checkUpgradePyQt" ID="Pip.__checkUpgradePyQt"></a>
<h4>Pip.__checkUpgradePyQt</h4>
<b>__checkUpgradePyQt</b>(<i>packages</i>)
-
<p>
Private method to check, if an upgrade of PyQt packages is attempted.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -279,10 +280,10 @@
<a NAME="Pip.__extractOutdatedPackages" ID="Pip.__extractOutdatedPackages"></a>
<h4>Pip.__extractOutdatedPackages</h4>
<b>__extractOutdatedPackages</b>(<i>proc</i>)
-
<p>
Private method to extract the outdated packages list out of the process output.
</p>
+
<dl>
<dt><i>proc</i> (QProcess)</dt>
@@ -306,11 +307,11 @@
<a NAME="Pip.__filterUpgradePackages" ID="Pip.__filterUpgradePackages"></a>
<h4>Pip.__filterUpgradePackages</h4>
<b>__filterUpgradePackages</b>(<i>packages</i>)
-
<p>
Private method to filter out the packages that cannot be upgraded without
stopping eric first.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -333,10 +334,10 @@
<a NAME="Pip.__outdatedFinished" ID="Pip.__outdatedFinished"></a>
<h4>Pip.__outdatedFinished</h4>
<b>__outdatedFinished</b>(<i>callback, proc, exitCode, exitStatus</i>)
-
<p>
Private method to handle the process finished signal.
</p>
+
<dl>
<dt><i>callback</i> (function)</dt>
@@ -360,10 +361,10 @@
<a NAME="Pip.cacheList" ID="Pip.cacheList"></a>
<h4>Pip.cacheList</h4>
<b>cacheList</b>(<i>venvName</i>)
-
<p>
Public method to list files contained in the pip cache.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -374,10 +375,10 @@
<a NAME="Pip.cachePurge" ID="Pip.cachePurge"></a>
<h4>Pip.cachePurge</h4>
<b>cachePurge</b>(<i>venvName</i>)
-
<p>
Public method to remove all files from the pip cache.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -388,10 +389,10 @@
<a NAME="Pip.cacheRemove" ID="Pip.cacheRemove"></a>
<h4>Pip.cacheRemove</h4>
<b>cacheRemove</b>(<i>venvName</i>)
-
<p>
Public method to remove files from the pip cache.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -402,10 +403,10 @@
<a NAME="Pip.checkPackagesOutdated" ID="Pip.checkPackagesOutdated"></a>
<h4>Pip.checkPackagesOutdated</h4>
<b>checkPackagesOutdated</b>(<i>packageStarts, envName, interpreter=None</i>)
-
<p>
Public method to check, if groups of packages are outdated.
</p>
+
<dl>
<dt><i>packageStarts</i> (str)</dt>
@@ -439,10 +440,10 @@
<a NAME="Pip.getDependencyTree" ID="Pip.getDependencyTree"></a>
<h4>Pip.getDependencyTree</h4>
<b>getDependencyTree</b>(<i>envName, localPackages=True, usersite=False, reverse=False</i>)
-
<p>
Public method to get the dependency tree of installed packages.
</p>
+
<dl>
<dt><i>envName</i> (str)</dt>
@@ -481,10 +482,10 @@
<a NAME="Pip.getFrozenPackages" ID="Pip.getFrozenPackages"></a>
<h4>Pip.getFrozenPackages</h4>
<b>getFrozenPackages</b>(<i>envName, localPackages=True, usersite=False, requirement=None</i>)
-
<p>
Public method to get the list of package specifiers to freeze them.
</p>
+
<dl>
<dt><i>envName</i> (str)</dt>
@@ -522,10 +523,10 @@
<a NAME="Pip.getIndexUrl" ID="Pip.getIndexUrl"></a>
<h4>Pip.getIndexUrl</h4>
<b>getIndexUrl</b>(<i></i>)
-
<p>
Public method to get the index URL for PyPI.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -541,10 +542,10 @@
<a NAME="Pip.getIndexUrlPypi" ID="Pip.getIndexUrlPypi"></a>
<h4>Pip.getIndexUrlPypi</h4>
<b>getIndexUrlPypi</b>(<i></i>)
-
<p>
Public method to get the index URL for PyPI API calls.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -560,10 +561,10 @@
<a NAME="Pip.getIndexUrlSearch" ID="Pip.getIndexUrlSearch"></a>
<h4>Pip.getIndexUrlSearch</h4>
<b>getIndexUrlSearch</b>(<i></i>)
-
<p>
Public method to get the index URL for PyPI API calls.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -579,10 +580,10 @@
<a NAME="Pip.getInstalledPackages" ID="Pip.getInstalledPackages"></a>
<h4>Pip.getInstalledPackages</h4>
<b>getInstalledPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>)
-
<p>
Public method to get the list of installed packages.
</p>
+
<dl>
<dt><i>envName</i> (str)</dt>
@@ -619,10 +620,10 @@
<a NAME="Pip.getLicenses" ID="Pip.getLicenses"></a>
<h4>Pip.getLicenses</h4>
<b>getLicenses</b>(<i>envName</i>)
-
<p>
Public method to get the licenses per package for a given environment.
</p>
+
<dl>
<dt><i>envName</i> (str)</dt>
@@ -646,10 +647,10 @@
<a NAME="Pip.getNetworkAccessManager" ID="Pip.getNetworkAccessManager"></a>
<h4>Pip.getNetworkAccessManager</h4>
<b>getNetworkAccessManager</b>(<i></i>)
-
<p>
Public method to get a reference to the network access manager object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -665,10 +666,10 @@
<a NAME="Pip.getOutdatedPackages" ID="Pip.getOutdatedPackages"></a>
<h4>Pip.getOutdatedPackages</h4>
<b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False, interpreter=None, callback=None, </i>)
-
<p>
Public method to get the list of outdated packages.
</p>
+
<dl>
<dt><i>envName</i> (str)</dt>
@@ -717,10 +718,10 @@
<a NAME="Pip.getPackageDetails" ID="Pip.getPackageDetails"></a>
<h4>Pip.getPackageDetails</h4>
<b>getPackageDetails</b>(<i>name, version</i>)
-
<p>
Public method to get package details using the PyPI JSON interface.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -747,11 +748,11 @@
<a NAME="Pip.getPackageVersions" ID="Pip.getPackageVersions"></a>
<h4>Pip.getPackageVersions</h4>
<b>getPackageVersions</b>(<i>name</i>)
-
<p>
Public method to get a list of versions available for the given
package.
</p>
+
<dl>
<dt><i>name</i> (str)</dt>
@@ -774,10 +775,10 @@
<a NAME="Pip.getProjectEnvironmentString" ID="Pip.getProjectEnvironmentString"></a>
<h4>Pip.getProjectEnvironmentString</h4>
<b>getProjectEnvironmentString</b>(<i></i>)
-
<p>
Public method to get the string for the project environment.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -793,10 +794,10 @@
<a NAME="Pip.getUserConfig" ID="Pip.getUserConfig"></a>
<h4>Pip.getUserConfig</h4>
<b>getUserConfig</b>(<i></i>)
-
<p>
Public method to get the name of the user configuration file.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -812,10 +813,10 @@
<a NAME="Pip.getVirtualenvConfig" ID="Pip.getVirtualenvConfig"></a>
<h4>Pip.getVirtualenvConfig</h4>
<b>getVirtualenvConfig</b>(<i>venvName</i>)
-
<p>
Public method to get the name of the virtualenv configuration file.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -838,10 +839,10 @@
<a NAME="Pip.getVirtualenvInterpreter" ID="Pip.getVirtualenvInterpreter"></a>
<h4>Pip.getVirtualenvInterpreter</h4>
<b>getVirtualenvInterpreter</b>(<i>venvName</i>)
-
<p>
Public method to get the interpreter for a virtual environment.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -864,10 +865,10 @@
<a NAME="Pip.getVirtualenvNames" ID="Pip.getVirtualenvNames"></a>
<h4>Pip.getVirtualenvNames</h4>
<b>getVirtualenvNames</b>(<i>noRemote=False, noConda=False</i>)
-
<p>
Public method to get a sorted list of virtual environment names.
</p>
+
<dl>
<dt><i>noRemote</i> (bool)</dt>
@@ -895,10 +896,10 @@
<a NAME="Pip.getVulnerabilityChecker" ID="Pip.getVulnerabilityChecker"></a>
<h4>Pip.getVulnerabilityChecker</h4>
<b>getVulnerabilityChecker</b>(<i></i>)
-
<p>
Public method to get a reference to the vulnerability checker object.
</p>
+
<dl>
<dt>Return:</dt>
<dd>
@@ -914,10 +915,10 @@
<a NAME="Pip.installEditableProject" ID="Pip.installEditableProject"></a>
<h4>Pip.installEditableProject</h4>
<b>installEditableProject</b>(<i>interpreter, projectPath</i>)
-
<p>
Public method to install a project in development mode.
</p>
+
<dl>
<dt><i>interpreter</i> (str)</dt>
@@ -932,10 +933,10 @@
<a NAME="Pip.installPackages" ID="Pip.installPackages"></a>
<h4>Pip.installPackages</h4>
<b>installPackages</b>(<i>packages, venvName="", userSite=False, interpreter="", forceReinstall=False, </i>)
-
<p>
Public method to install the given list of packages.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -964,10 +965,10 @@
<a NAME="Pip.installPip" ID="Pip.installPip"></a>
<h4>Pip.installPip</h4>
<b>installPip</b>(<i>venvName, userSite=False</i>)
-
<p>
Public method to install pip.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -983,10 +984,10 @@
<a NAME="Pip.installRequirements" ID="Pip.installRequirements"></a>
<h4>Pip.installRequirements</h4>
<b>installRequirements</b>(<i>venvName</i>)
-
<p>
Public method to install packages as given in a requirements file.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -997,10 +998,10 @@
<a NAME="Pip.repairPip" ID="Pip.repairPip"></a>
<h4>Pip.repairPip</h4>
<b>repairPip</b>(<i>venvName</i>)
-
<p>
Public method to repair the pip installation.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -1011,7 +1012,6 @@
<a NAME="Pip.runProcess" ID="Pip.runProcess"></a>
<h4>Pip.runProcess</h4>
<b>runProcess</b>(<i>args, interpreter</i>)
-
<p>
Public method to execute the current pip with the given arguments.
</p>
@@ -1019,6 +1019,7 @@
The selected pip executable is called with the given arguments and
waited for its end.
</p>
+
<dl>
<dt><i>args</i> (list of str)</dt>
@@ -1046,10 +1047,10 @@
<a NAME="Pip.showCacheInfo" ID="Pip.showCacheInfo"></a>
<h4>Pip.showCacheInfo</h4>
<b>showCacheInfo</b>(<i>venvName</i>)
-
<p>
Public method to show some information about the pip cache.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -1060,10 +1061,10 @@
<a NAME="Pip.uninstallPackages" ID="Pip.uninstallPackages"></a>
<h4>Pip.uninstallPackages</h4>
<b>uninstallPackages</b>(<i>packages, venvName</i>)
-
<p>
Public method to uninstall the given list of packages.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -1090,10 +1091,10 @@
<a NAME="Pip.uninstallRequirements" ID="Pip.uninstallRequirements"></a>
<h4>Pip.uninstallRequirements</h4>
<b>uninstallRequirements</b>(<i>venvName</i>)
-
<p>
Public method to uninstall packages as given in a requirements file.
</p>
+
<dl>
<dt><i>venvName</i> (str)</dt>
@@ -1104,10 +1105,10 @@
<a NAME="Pip.upgradePackages" ID="Pip.upgradePackages"></a>
<h4>Pip.upgradePackages</h4>
<b>upgradePackages</b>(<i>packages, venvName, userSite=False</i>)
-
<p>
Public method to upgrade the given list of packages.
</p>
+
<dl>
<dt><i>packages</i> (list of str)</dt>
@@ -1138,4 +1139,4 @@
</dl>
<div align="right"><a href="#top">Up</a></div>
<hr />
-</body></html>
\ No newline at end of file
+</body></html>
