eric: comparison src/eric7/Documentation/Source/eric7.PipInterface.pipdeptree.html

-:2bd590c40309
+:397f385b95d8
 <body>
 <a NAME="top" ID="top"></a>
 <h1>eric7.PipInterface.pipdeptree</h1>
 <p>
-Copyright (c) 2015 Vineet Naik (naikvin@gmail.com)
+Copyright (c) The pipdeptree developers
 </p>
 <p>
 Permission is hereby granted, free of charge, to any person obtaining
 a copy of this software and associated documentation files (the
 "Software"), to deal in the Software without restriction, including
 <td><a href="#render_text">render_text</a></td>
 <td>Print tree as text on console</td>
 </tr>
 <tr>
 <td><a href="#sorted_tree">sorted_tree</a></td>
-<td>Sorts the dict representation of the tree</td>
+<td>Sorts the dict representation of the tree.</td>
 </tr>
 </table>
 <hr />
 <hr />
 <a NAME="DistPackage" ID="DistPackage"></a>
 <h2>DistPackage</h2>
 <p>
 Wrapper class for pkg_resources.Distribution instances
 </p>
 <p>
 :param obj: pkg_resources.Distribution to wrap over
-:param req: optional ReqPackage object to associate this
+:param req: optional ReqPackage object to associate this DistPackage with. This is useful for displaying the tree
-DistPackage with. This is useful for displaying the
+in reverse
-tree in reverse
 </p>
 <h3>Derived from</h3>
 Package
 <h3>Class Attributes</h3>
 <td><a href="#DistPackage.as_dict">as_dict</a></td>
 <td></td>
 </tr>
 <tr>
 <td><a href="#DistPackage.as_parent_of">as_parent_of</a></td>
-<td>Return a DistPackage instance associated to a requirement</td>
+<td>Return a DistPackage instance associated to a requirement.</td>
 </tr>
 <tr>
 <td><a href="#DistPackage.as_requirement">as_requirement</a></td>
 <td>Return a ReqPackage representation of this DistPackage</td>
 </tr>
 <a NAME="DistPackage.as_parent_of" ID="DistPackage.as_parent_of"></a>
 <h4>DistPackage.as_parent_of</h4>
 <b>as_parent_of</b>(<i>req</i>)
 <p>
-Return a DistPackage instance associated to a requirement
+Return a DistPackage instance associated to a requirement. This association is necessary for reversing the
-</p>
+PackageDAG.
-<p>
+</p>
-This association is necessary for reversing the PackageDAG.
+<p>
-</p>
+If `req` is None, and the `req` attribute of the current instance is also None, then the same instance will be
-<p>
-If `req` is None, and the `req` attribute of the current
-instance is also None, then the same instance will be
 returned.
 </p>
 <p>
 :param ReqPackage req: the requirement to associate with
 :returns: DistPackage instance
-</p>
-<p>
 </p>
 <a NAME="DistPackage.as_requirement" ID="DistPackage.as_requirement"></a>
 <h4>DistPackage.as_requirement</h4>
 <b>as_requirement</b>(<i></i>)
 <hr />
 <a NAME="Package" ID="Package"></a>
 <h2>Package</h2>
 <p>
-Abstract class for wrappers around objects that pip returns.
+Abstract class for wrappers around objects that pip returns. This class needs to be subclassed with implementations
-</p>
+for `render_as_root` and `render_as_branch` methods.
-<p>
-This class needs to be subclassed with implementations for
-`render_as_root` and `render_as_branch` methods.
-</p>
-<p>
 </p>
 <h3>Derived from</h3>
-object
+None
 <h3>Class Attributes</h3>
 <table>
 <tr><td>None</td></tr>
 </table>
 <hr />
 <a NAME="PackageDAG" ID="PackageDAG"></a>
 <h2>PackageDAG</h2>
 <p>
-Representation of Package dependencies as directed acyclic graph
+Representation of Package dependencies as directed acyclic graph using a dict (Mapping) as the underlying
-using a dict (Mapping) as the underlying datastructure.
+datastructure.
 </p>
 <p>
-The nodes and their relationships (edges) are internally
+The nodes and their relationships (edges) are internally stored using a map as follows,
-stored using a map as follows,
 </p>
 <p>
 {a: [b, c],
 b: [d],
 c: [d, e],
 e: [],
 f: [b],
 g: [e, f]}
 </p>
 <p>
-Here, node `a` has 2 children nodes `b` and `c`. Consider edge
+Here, node `a` has 2 children nodes `b` and `c`. Consider edge direction from `a` -> `b` and `a` -> `c`
-direction from `a` -> `b` and `a` -> `c` respectively.
+respectively.
 </p>
 <p>
-A node is expected to be an instance of a subclass of
+A node is expected to be an instance of a subclass of `Package`. The keys are must be of class `DistPackage` and
-`Package`. The keys are must be of class `DistPackage` and each
+each item in values must be of class `ReqPackage`. (See also ReversedPackageDAG where the key and value types are
-item in values must be of class `ReqPackage`. (See also
-ReversedPackageDAG where the key and value types are
 interchanged).
-</p>
-<p>
 </p>
 <h3>Derived from</h3>
 Mapping
 <h3>Class Attributes</h3>
 <td><a href="#PackageDAG.filter">filter</a></td>
 <td>Filters nodes in a graph by given parameters</td>
 </tr>
 <tr>
 <td><a href="#PackageDAG.get_children">get_children</a></td>
-<td>Get child nodes for a node by it's key</td>
+<td>Get child nodes for a node by its key</td>
 </tr>
 <tr>
 <td><a href="#PackageDAG.get_node_as_parent">get_node_as_parent</a></td>
 <td>Get the node from the keys of the dict representing the DAG.</td>
 </tr>
 <tr>
 <td><a href="#PackageDAG.reverse">reverse</a></td>
-<td>Reverse the DAG, or turn it upside-down</td>
+<td>Reverse the DAG, or turn it upside-down.</td>
 </tr>
 <tr>
 <td><a href="#PackageDAG.sort">sort</a></td>
-<td>Return sorted tree in which the underlying _obj dict is an OrderedDict, sorted alphabetically by the keys</td>
+<td>Return sorted tree in which the underlying _obj dict is an dict, sorted alphabetically by the keys.</td>
 </tr>
 </table>
 <h3>Static Methods</h3>
 <table>
 <a NAME="PackageDAG.filter" ID="PackageDAG.filter"></a>
 <h4>PackageDAG.filter</h4>
 <b>filter</b>(<i>include, exclude</i>)
 <p>
 Filters nodes in a graph by given parameters
 </p>
 <p>
-If a node is included, then all it's children are also
+If a node is included, then all it's children are also included.
-included.
 </p>
 <p>
 :param set include: set of node keys to include (or None)
 :param set exclude: set of node keys to exclude (or None)
 :returns: filtered version of the graph
 :rtype: PackageDAG
 </p>
-<p>
-</p>
 <a NAME="PackageDAG.get_children" ID="PackageDAG.get_children"></a>
 <h4>PackageDAG.get_children</h4>
 <b>get_children</b>(<i>node_key</i>)
 <p>
-Get child nodes for a node by it's key
+Get child nodes for a node by its key
 </p>
 <p>
 :param str node_key: key of the node to get children of
 :returns: list of child nodes
 :rtype: ReqPackage[]
 </p>
-<p>
-</p>
 <a NAME="PackageDAG.get_node_as_parent" ID="PackageDAG.get_node_as_parent"></a>
 <h4>PackageDAG.get_node_as_parent</h4>
 <b>get_node_as_parent</b>(<i>node_key</i>)
 <p>
 Get the node from the keys of the dict representing the DAG.
 </p>
 <p>
-This method is useful if the dict representing the DAG
+This method is useful if the dict representing the DAG contains different kind of objects in keys and values.
-contains different kind of objects in keys and values. Use
+Use this method to look up a node obj as a parent (from the keys of the dict) given a node key.
-this method to lookup a node obj as a parent (from the keys of
-the dict) given a node key.
 </p>
 <p>
 :param node_key: identifier corresponding to key attr of node obj
 :returns: node obj (as present in the keys of the dict)
 :rtype: Object
 </p>
-<p>
-</p>
 <a NAME="PackageDAG.reverse" ID="PackageDAG.reverse"></a>
 <h4>PackageDAG.reverse</h4>
 <b>reverse</b>(<i></i>)
 <p>
-Reverse the DAG, or turn it upside-down
+Reverse the DAG, or turn it upside-down.
 </p>
 <p>
-In other words, the directions of edges of the nodes in the
+In other words, the directions of edges of the nodes in the DAG will be reversed.
-DAG will be reversed.
+</p>
-</p>
+<p>
-<p>
+Note that this function purely works on the nodes in the graph. This implies that to perform a combination of
-Note that this function purely works on the nodes in the
+filtering and reversing, the order in which `filter` and `reverse` methods should be applied is important. For
-graph. This implies that to perform a combination of filtering
+e.g., if reverse is called on a filtered graph, then only the filtered nodes and it's children will be
-and reversing, the order in which `filter` and `reverse`
+considered when reversing. On the other hand, if filter is called on reversed DAG, then the definition of
-methods should be applied is important. For eg. if reverse is
+"child" nodes is as per the reversed DAG.
-called on a filtered graph, then only the filtered nodes and
-it's children will be considered when reversing. On the other
-hand, if filter is called on reversed DAG, then the definition
-of "child" nodes is as per the reversed DAG.
 </p>
 <p>
 :returns: DAG in the reversed form
 :rtype: ReversedPackageDAG
-</p>
-<p>
 </p>
 <a NAME="PackageDAG.sort" ID="PackageDAG.sort"></a>
 <h4>PackageDAG.sort</h4>
 <b>sort</b>(<i></i>)
 <p>
-Return sorted tree in which the underlying _obj dict is an
+Return sorted tree in which the underlying _obj dict is an dict, sorted alphabetically by the keys.
-OrderedDict, sorted alphabetically by the keys
+</p>
-</p>
+<p>
-<p>
+:returns: Instance of same class with dict
-:returns: Instance of same class with OrderedDict
-</p>
-<p>
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="ReqPackage" ID="ReqPackage"></a>
 <h2>ReqPackage</h2>
 <p>
 Wrapper class for Requirements instance
 </p>
 <p>
 :param obj: The `Requirements` instance to wrap over
-:param dist: optional `pkg_resources.Distribution` instance for
+:param dist: optional `pkg_resources.Distribution` instance for this requirement
-this requirement
 </p>
 <h3>Derived from</h3>
 Package
 <h3>Class Attributes</h3>
 <hr />
 <a NAME="ReversedPackageDAG" ID="ReversedPackageDAG"></a>
 <h2>ReversedPackageDAG</h2>
 <p>
-Representation of Package dependencies in the reverse
+Representation of Package dependencies in the reverse order.
-order.
+</p>
-</p>
+<p>
-<p>
+Similar to it's super class `PackageDAG`, the underlying datastructure is a dict, but here the keys are expected to
-Similar to it's super class `PackageDAG`, the underlying
+be of type `ReqPackage` and each item in the values of type `DistPackage`.
-datastructure is a dict, but here the keys are expected to be of
+</p>
-type `ReqPackage` and each item in the values of type
+<p>
-`DistPackage`.
+Typically, this object will be obtained by calling `PackageDAG.reverse`.
-</p>
-<p>
-Typically, this object will be obtained by calling
-`PackageDAG.reverse`.
-</p>
-<p>
 </p>
 <h3>Derived from</h3>
 PackageDAG
 <h3>Class Attributes</h3>
 <a NAME="ReversedPackageDAG.reverse" ID="ReversedPackageDAG.reverse"></a>
 <h4>ReversedPackageDAG.reverse</h4>
 <b>reverse</b>(<i></i>)
 <p>
 Reverse the already reversed DAG to get the PackageDAG again
 </p>
 <p>
 :returns: reverse of the reversed DAG
 :rtype: PackageDAG
-</p>
-<p>
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="_get_args" ID="_get_args"></a>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="aux" ID="aux"></a>
 <h2>aux</h2>
-<b>aux</b>(<i>node, parent=None, indent=0, chain=None</i>)
+<b>aux</b>(<i>node, parent=None, indent=0, cur_chain=None</i>)
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="aux_1" ID="aux_1"></a>
 <h2>aux</h2>
-<b>aux</b>(<i>node, parent=None, chain=None</i>)
+<b>aux</b>(<i>node, parent=None, cur_chain=None</i>)
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="conflicting_deps" ID="conflicting_deps"></a>
 <h2>conflicting_deps</h2>
 <b>conflicting_deps</b>(<i>tree</i>)
 <p>
-Returns dependencies which are not present or conflict with the
+Returns dependencies which are not present or conflict with the requirements of other packages.
-requirements of other packages.
 </p>
 <p>
 e.g. will warn if pkg1 requires pkg2==2.0 and pkg2==1.0 is installed
 </p>
 <p>
 :param tree: the requirements tree (dict)
 :returns: dict of DistPackage -> list of unsatisfied/unknown ReqPackage
 :rtype: dict
 </p>
-<p>
-</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="cyclic_deps" ID="cyclic_deps"></a>
 <h2>cyclic_deps</h2>
 <b>cyclic_deps</b>(<i>tree</i>)
 <p>
 Return cyclic dependencies as list of tuples
 </p>
 <p>
-:param PackageDAG pkgs: package tree/dag
+:param PackageDAG tree: package tree/dag
 :returns: list of tuples representing cyclic dependencies
 :rtype: list
 </p>
-<p>
-</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="dump_graphviz" ID="dump_graphviz"></a>
 <h2>dump_graphviz</h2>
-<b>dump_graphviz</b>(<i>tree, output_format='dot', is_reverse=False</i>)
+<b>dump_graphviz</b>(<i>tree, output_format="dot", is_reverse=False</i>)
 <p>
 Output dependency graph as one of the supported GraphViz output formats.
 </p>
 <p>
 :param dict tree: dependency graph
 :param string output_format: output format
+:param bool is_reverse: reverse or not
 :returns: representation of tree in the specified output format
 :rtype: str or binary representation depending on the output format
 </p>
 <p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="guess_version" ID="guess_version"></a>
 <h2>guess_version</h2>
-<b>guess_version</b>(<i>pkg_key, default='?'</i>)
+<b>guess_version</b>(<i>pkg_key, default="?"</i>)
 <p>
 Guess the version of a pkg when pip doesn't provide it
 </p>
 <p>
 :param str pkg_key: key of the package
 :param str default: default version to return if unable to find
 :returns: version
 :rtype: string
 </p>
-<p>
-</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="handle_non_host_target" ID="handle_non_host_target"></a>
 <h2>handle_non_host_target</h2>
 <a NAME="print_graphviz" ID="print_graphviz"></a>
 <h2>print_graphviz</h2>
 <b>print_graphviz</b>(<i>dump_output</i>)
 <p>
 Dump the data generated by GraphViz to stdout.
 </p>
 <p>
 :param dump_output: The output from dump_graphviz
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <a NAME="render_json" ID="render_json"></a>
 <h2>render_json</h2>
 <b>render_json</b>(<i>tree, indent</i>)
 <p>
 Converts the tree into a flat json representation.
 </p>
 <p>
 The json repr will be a list of hashes, each hash having 2 fields:
 - package
 - dependencies: list of dependencies
 :param dict tree: dependency tree
 :param int indent: no. of spaces to indent json
 :returns: json representation of the tree
 :rtype: str
 </p>
-<p>
-</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="render_json_tree" ID="render_json_tree"></a>
 <h2>render_json_tree</h2>
 <b>render_json_tree</b>(<i>tree, indent</i>)
 <p>
 Converts the tree into a nested json representation.
 </p>
 <p>
 The json repr will be a list of hashes, each hash having the following fields:
+</p>
+<p>
 - package_name
 - key
 - required_version
 - installed_version
 - dependencies: list of dependencies
 :param dict tree: dependency tree
 :param int indent: no. of spaces to indent json
 :returns: json representation of the tree
 :rtype: str
 </p>
-<p>
-</p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 <hr />
 <a NAME="render_text" ID="render_text"></a>
 <h2>render_text</h2>
 <p>
 Print tree as text on console
 </p>
 <p>
 :param dict tree: the package tree
-:param bool list_all: whether to list all the pgks at the root
+:param bool list_all: whether to list all the pgks at the root level or only those that are the sub-dependencies
-level or only those that are the
+:param bool frozen: show the names of the pkgs in the output that's favourable to pip --freeze
-sub-dependencies
-:param bool frozen: whether or not show the names of the pkgs in
-the output that's favourable to pip --freeze
 :returns: None
 </p>
 <p>
 </p>
 <a NAME="sorted_tree" ID="sorted_tree"></a>
 <h2>sorted_tree</h2>
 <b>sorted_tree</b>(<i>tree</i>)
 <p>
-Sorts the dict representation of the tree
+Sorts the dict representation of the tree. The root packages as well as the intermediate packages are sorted in the
-</p>
+alphabetical order of the package names.
-<p>
+</p>
-The root packages as well as the intermediate packages are sorted
+<p>
-in the alphabetical order of the package names.
+:param dict tree: the pkg dependency tree obtained by calling `construct_tree` function
-</p>
-<p>
-:param dict tree: the pkg dependency tree obtained by calling
-`construct_tree` function
 :returns: sorted tree
-:rtype: collections.OrderedDict
+:rtype: dict
-</p>
-<p>
 </p>
 <div align="right"><a href="#top">Up</a></div>
 <hr />
 </body></html>

Mercurial Repositories > eric / file comparison

comparison: src/eric7/Documentation/Source/eric7.PipInterface.pipdeptree.html

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