77 <tr> |
77 <tr> |
78 <td><a href="#Pip.cacheRemove">cacheRemove</a></td> |
78 <td><a href="#Pip.cacheRemove">cacheRemove</a></td> |
79 <td>Public method to remove files from the pip cache.</td> |
79 <td>Public method to remove files from the pip cache.</td> |
80 </tr> |
80 </tr> |
81 <tr> |
81 <tr> |
82 <td><a href="#Pip.checkPackageOutdated">checkPackageOutdated</a></td> |
82 <td><a href="#Pip.checkPackagesOutdated">checkPackagesOutdated</a></td> |
83 <td>Public method to check, if a group of packages is outdated.</td> |
83 <td>Public method to check, if groups of packages are outdated.</td> |
84 </tr> |
84 </tr> |
85 <tr> |
85 <tr> |
86 <td><a href="#Pip.getDependencyTree">getDependencyTree</a></td> |
86 <td><a href="#Pip.getDependencyTree">getDependencyTree</a></td> |
87 <td>Public method to get the dependency tree of installed packages.</td> |
87 <td>Public method to get the dependency tree of installed packages.</td> |
88 </tr> |
88 </tr> |
308 <dt><i>venvName</i> (str)</dt> |
308 <dt><i>venvName</i> (str)</dt> |
309 <dd> |
309 <dd> |
310 name of the virtual environment to be used |
310 name of the virtual environment to be used |
311 </dd> |
311 </dd> |
312 </dl> |
312 </dl> |
313 <a NAME="Pip.checkPackageOutdated" ID="Pip.checkPackageOutdated"></a> |
313 <a NAME="Pip.checkPackagesOutdated" ID="Pip.checkPackagesOutdated"></a> |
314 <h4>Pip.checkPackageOutdated</h4> |
314 <h4>Pip.checkPackagesOutdated</h4> |
315 <b>checkPackageOutdated</b>(<i>packageStart, envName</i>) |
315 <b>checkPackagesOutdated</b>(<i>packageStarts, envName, interpreter=None</i>) |
316 |
316 |
317 <p> |
317 <p> |
318 Public method to check, if a group of packages is outdated. |
318 Public method to check, if groups of packages are outdated. |
319 </p> |
319 </p> |
320 <dl> |
320 <dl> |
321 |
321 |
322 <dt><i>packageStart</i> (str)</dt> |
322 <dt><i>packageStarts</i> (str)</dt> |
323 <dd> |
323 <dd> |
324 start string for package names to be checked |
324 list of start strings for package names to be checked |
325 (case insensitive) |
325 (case insensitive) |
326 </dd> |
326 </dd> |
327 <dt><i>envName</i> (str)</dt> |
327 <dt><i>envName</i> (str)</dt> |
328 <dd> |
328 <dd> |
329 name of the environment to get the packages for |
329 name of the environment to get the packages for |
330 </dd> |
330 </dd> |
331 </dl> |
331 <dt><i>interpreter</i> (str (optional))</dt> |
332 <dl> |
332 <dd> |
333 <dt>Return:</dt> |
333 path of an interpreter executable. If this is not |
334 <dd> |
334 None, it will override the given environment name (defaults to None) |
335 tuple containing a flag indicating outdated packages and the |
335 </dd> |
336 list of tuples containing the package name, installed version |
336 </dl> |
337 and available version |
337 <dl> |
338 </dd> |
338 <dt>Return:</dt> |
339 </dl> |
339 <dd> |
340 <dl> |
340 list of tuples containing the package name, installed version |
341 <dt>Return Type:</dt> |
341 and available version of outdated packages |
342 <dd> |
342 </dd> |
343 tuple of (bool, (str, str, str)) |
343 </dl> |
|
344 <dl> |
|
345 <dt>Return Type:</dt> |
|
346 <dd> |
|
347 tuple of (str, str, str) |
344 </dd> |
348 </dd> |
345 </dl> |
349 </dl> |
346 <a NAME="Pip.getDependencyTree" ID="Pip.getDependencyTree"></a> |
350 <a NAME="Pip.getDependencyTree" ID="Pip.getDependencyTree"></a> |
347 <h4>Pip.getDependencyTree</h4> |
351 <h4>Pip.getDependencyTree</h4> |
348 <b>getDependencyTree</b>(<i>envName, localPackages=True, usersite=False, reverse=False</i>) |
352 <b>getDependencyTree</b>(<i>envName, localPackages=True, usersite=False, reverse=False</i>) |
622 QNetworkAccessManager |
626 QNetworkAccessManager |
623 </dd> |
627 </dd> |
624 </dl> |
628 </dl> |
625 <a NAME="Pip.getOutdatedPackages" ID="Pip.getOutdatedPackages"></a> |
629 <a NAME="Pip.getOutdatedPackages" ID="Pip.getOutdatedPackages"></a> |
626 <h4>Pip.getOutdatedPackages</h4> |
630 <h4>Pip.getOutdatedPackages</h4> |
627 <b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False</i>) |
631 <b>getOutdatedPackages</b>(<i>envName, localPackages=True, notRequired=False, usersite=False, interpreter=None, </i>) |
628 |
632 |
629 <p> |
633 <p> |
630 Public method to get the list of outdated packages. |
634 Public method to get the list of outdated packages. |
631 </p> |
635 </p> |
632 <dl> |
636 <dl> |
633 |
637 |
634 <dt><i>envName</i> (str)</dt> |
638 <dt><i>envName</i> (str)</dt> |
635 <dd> |
639 <dd> |
636 name of the environment to get the packages for |
640 name of the environment to get the packages for |
637 </dd> |
641 </dd> |
638 <dt><i>localPackages</i> (bool)</dt> |
642 <dt><i>localPackages</i> (bool (optional))</dt> |
639 <dd> |
643 <dd> |
640 flag indicating to get local packages only |
644 flag indicating to get local packages only |
641 </dd> |
645 (defaults to False) |
642 <dt><i>notRequired</i> (bool)</dt> |
646 </dd> |
|
647 <dt><i>notRequired</i> (bool (optional))</dt> |
643 <dd> |
648 <dd> |
644 flag indicating to list packages that are not |
649 flag indicating to list packages that are not |
645 dependencies of installed packages as well |
650 dependencies of installed packages as well (defaults to False) |
646 </dd> |
651 </dd> |
647 <dt><i>usersite</i> (bool)</dt> |
652 <dt><i>usersite</i> (bool (optional))</dt> |
648 <dd> |
653 <dd> |
649 flag indicating to only list packages installed |
654 flag indicating to only list packages installed |
650 in user-site |
655 in user-site (defaults to False) |
|
656 </dd> |
|
657 <dt><i>interpreter</i> (str (optional))</dt> |
|
658 <dd> |
|
659 path of an interpreter executable. If this is not |
|
660 None, it will override the given environment name (defaults to None) |
651 </dd> |
661 </dd> |
652 </dl> |
662 </dl> |
653 <dl> |
663 <dl> |
654 <dt>Return:</dt> |
664 <dt>Return:</dt> |
655 <dd> |
665 <dd> |