src/eric7/Documentation/Source/eric7.PipInterface.Pip.html

branch
eric7
changeset 9587
6486d40c26f0
parent 9323
6ae7193558ac
child 9850
20c49b517679
diff -r 2750e76fc366 -r 6486d40c26f0 src/eric7/Documentation/Source/eric7.PipInterface.Pip.html
--- a/src/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Wed Dec 07 11:49:36 2022 +0100
+++ b/src/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Wed Dec 07 11:50:29 2022 +0100
@@ -79,8 +79,8 @@
 <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>
+<td><a href="#Pip.checkPackagesOutdated">checkPackagesOutdated</a></td>
+<td>Public method to check, if groups of packages are outdated.</td>
 </tr>
 <tr>
 <td><a href="#Pip.getDependencyTree">getDependencyTree</a></td>
@@ -310,37 +310,41 @@
 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>)
+<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 a group of packages is outdated.
+        Public method to check, if groups of packages are outdated.
 </p>
 <dl>
 
-<dt><i>packageStart</i> (str)</dt>
+<dt><i>packageStarts</i> (str)</dt>
 <dd>
-start string for package names to be checked
+list of start strings 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>
+<dt><i>interpreter</i> (str (optional))</dt>
+<dd>
+path of an interpreter executable. If this is not
+            None, it will override the given environment name (defaults to None)
+</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
+list of tuples containing the package name, installed version
+            and available version of outdated packages
 </dd>
 </dl>
 <dl>
 <dt>Return Type:</dt>
 <dd>
-tuple of (bool, (str, str, str))
+tuple of (str, str, str)
 </dd>
 </dl>
 <a NAME="Pip.getDependencyTree" ID="Pip.getDependencyTree"></a>
@@ -624,7 +628,7 @@
 </dl>
 <a NAME="Pip.getOutdatedPackages" ID="Pip.getOutdatedPackages"></a>
 <h4>Pip.getOutdatedPackages</h4>
-<b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>)
+<b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False, interpreter=None, </i>)
 
 <p>
         Public method to get the list of outdated packages.
@@ -635,19 +639,25 @@
 <dd>
 name of the environment to get the packages for
 </dd>
-<dt><i>localPackages</i> (bool)</dt>
+<dt><i>localPackages</i> (bool (optional))</dt>
 <dd>
 flag indicating to get local packages only
+            (defaults to False)
 </dd>
-<dt><i>notRequired</i> (bool)</dt>
+<dt><i>notRequired</i> (bool (optional))</dt>
 <dd>
 flag indicating to list packages that are not
-            dependencies of installed packages as well
+            dependencies of installed packages as well (defaults to False)
 </dd>
-<dt><i>usersite</i> (bool)</dt>
+<dt><i>usersite</i> (bool (optional))</dt>
 <dd>
 flag indicating to only list packages installed
-            in user-site
+            in user-site (defaults to False)
+</dd>
+<dt><i>interpreter</i> (str (optional))</dt>
+<dd>
+path of an interpreter executable. If this is not
+            None, it will override the given environment name (defaults to None)
 </dd>
 </dl>
 <dl>

eric ide

mercurial