diff -r 0a846d71f27c -r 54816b8f740f eric7/Documentation/Source/eric7.PipInterface.Pip.html --- a/eric7/Documentation/Source/eric7.PipInterface.Pip.html Sat Mar 05 18:10:28 2022 +0100 +++ b/eric7/Documentation/Source/eric7.PipInterface.Pip.html Sun Mar 06 19:53:19 2022 +0100 @@ -59,6 +59,10 @@ <td>Constructor</td> </tr> <tr> +<td><a href="#Pip.__checkUpgradeEric">__checkUpgradeEric</a></td> +<td>Private method to check, if an upgrade of the eric-ide package is attempted.</td> +</tr> +<tr> <td><a href="#Pip.__checkUpgradePyQt">__checkUpgradePyQt</a></td> <td>Private method to check, if an upgrade of PyQt packages is attempted.</td> </tr> @@ -75,6 +79,10 @@ <td>Public method to remove files from the pip cache.</td> </tr> <tr> +<td><a href="#Pip.checkPackageOutdated">checkPackageOutdated</a></td> +<td>Public method to check, if a group of packages is outdated.</td> +</tr> +<tr> <td><a href="#Pip.getIndexUrl">getIndexUrl</a></td> <td>Public method to get the index URL for PyPI.</td> </tr> @@ -179,6 +187,33 @@ reference to the user interface object </dd> </dl> +<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> +<dd> +list of packages to upgrade +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +flag indicating an eric-ide upgrade +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +bool +</dd> +</dl> <a NAME="Pip.__checkUpgradePyQt" ID="Pip.__checkUpgradePyQt"></a> <h4>Pip.__checkUpgradePyQt</h4> <b>__checkUpgradePyQt</b>(<i>packages</i>) @@ -196,7 +231,7 @@ <dl> <dt>Return:</dt> <dd> -flag indicating to abort the upgrade attempt +flag indicating a PyQt upgrade </dd> </dl> <dl> @@ -247,6 +282,39 @@ name of the virtual environment to be used </dd> </dl> +<a NAME="Pip.checkPackageOutdated" ID="Pip.checkPackageOutdated"></a> +<h4>Pip.checkPackageOutdated</h4> +<b>checkPackageOutdated</b>(<i>packageStart, envName</i>) + +<p> + Public method to check, if a group of packages is outdated. +</p> +<dl> + +<dt><i>packageStart</i> (str)</dt> +<dd> +start string for package names to be checked + (case insensitive) +</dd> +<dt><i>envName</i> (str)</dt> +<dd> +name of the environment to get the packages for +</dd> +</dl> +<dl> +<dt>Return:</dt> +<dd> +tuple containing a flag indicating outdated packages and the + list of tuples containing the package name, installed version + and available version +</dd> +</dl> +<dl> +<dt>Return Type:</dt> +<dd> +tuple of (bool, (str, str, str)) +</dd> +</dl> <a NAME="Pip.getIndexUrl" ID="Pip.getIndexUrl"></a> <h4>Pip.getIndexUrl</h4> <b>getIndexUrl</b>(<i></i>)