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

branch
eric7
changeset 8997
d8946c2a22b5
parent 8983
46eaed7bf3cb
child 9007
01b73d9ef09e
diff -r 62bd225b489f -r d8946c2a22b5 eric7/Documentation/Source/eric7.PipInterface.Pip.html
--- a/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Tue Mar 22 19:31:29 2022 +0100
+++ b/eric7/Documentation/Source/eric7.PipInterface.Pip.html	Wed Mar 23 20:21:42 2022 +0100
@@ -83,6 +83,10 @@
 <td>Public method to check, if a group of packages is outdated.</td>
 </tr>
 <tr>
+<td><a href="#Pip.getDependecyTree">getDependecyTree</a></td>
+<td>Public method to get the dependency tree of installed packages.</td>
+</tr>
+<tr>
 <td><a href="#Pip.getFrozenPackages">getFrozenPackages</a></td>
 <td>Public method to get the list of package specifiers to freeze them.</td>
 </tr>
@@ -327,6 +331,48 @@
 tuple of (bool, (str, str, str))
 </dd>
 </dl>
+<a NAME="Pip.getDependecyTree" ID="Pip.getDependecyTree"></a>
+<h4>Pip.getDependecyTree</h4>
+<b>getDependecyTree</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>
+<dd>
+name of the environment to get the packages for
+</dd>
+<dt><i>localPackages</i> (bool)</dt>
+<dd>
+flag indicating to get the tree for local
+            packages only
+</dd>
+<dt><i>usersite</i> (bool)</dt>
+<dd>
+flag indicating to get the tree for packages
+            installed in user-site directory only
+</dd>
+<dt><i>reverse</i> (bool)</dt>
+<dd>
+flag indicating to get the dependency tree in
+            reverse order (i.e. list packages needed by other)
+</dd>
+</dl>
+<dl>
+<dt>Return:</dt>
+<dd>
+list of nested dictionaries resembling the requested
+            dependency tree
+</dd>
+</dl>
+<dl>
+<dt>Return Type:</dt>
+<dd>
+list of dict
+</dd>
+</dl>
 <a NAME="Pip.getFrozenPackages" ID="Pip.getFrozenPackages"></a>
 <h4>Pip.getFrozenPackages</h4>
 <b>getFrozenPackages</b>(<i>envName, localPackages=True, usersite=False, requirement=None</i>)

eric ide

mercurial