From 5f8de423f190bbb79a62f804151bc24824fa32d8 Mon Sep 17 00:00:00 2001 From: "Matt A. Tobin" Date: Fri, 2 Feb 2018 04:16:08 -0500 Subject: Add m-esr52 at 52.6.0 --- python/altgraph/doc/_build/html/objectgraph.html | 283 +++++++++++++++++++++++ 1 file changed, 283 insertions(+) create mode 100644 python/altgraph/doc/_build/html/objectgraph.html (limited to 'python/altgraph/doc/_build/html/objectgraph.html') diff --git a/python/altgraph/doc/_build/html/objectgraph.html b/python/altgraph/doc/_build/html/objectgraph.html new file mode 100644 index 000000000..c9879f656 --- /dev/null +++ b/python/altgraph/doc/_build/html/objectgraph.html @@ -0,0 +1,283 @@ + + + + + + + + altgraph.ObjectGraph — Graphs of objecs with an identifier — altgraph 0.11 documentation + + + + + + + + + + + + + + + +
+
+
+
+ +
+

altgraph.ObjectGraph — Graphs of objecs with an identifier

+
+
+class altgraph.ObjectGraph.ObjectGraph([graph[, debug]])
+

A graph of objects that have a “graphident” attribute. The +value of this attribute is the key for the object in the +graph.

+

The optional graph is a previously constructed +Graph.

+

The optional debug level controls the amount of debug output +(see msg(), msgin() and msgout()).

+
+

Note

+

the altgraph library does not generate output, the +debug attribute and message methods are present for use +by subclasses.

+
+
+ +
+
+ObjectGraph.graph
+

An Graph object that contains +the graph data.

+
+ +
+
+ObjectGraph.addNode(node)
+

Adds a node to the graph.

+
+

Note

+

re-adding a node that was previously removed +using removeNode() will reinstate the previously +removed node.

+
+
+ +
+
+ObjectGraph.createNode(self, cls, name, *args, **kwds)
+

Creates a new node using cls(*args, **kwds) and adds that +node using addNode().

+

Returns the newly created node.

+
+ +
+
+ObjectGraph.removeNode(node)
+

Removes a node from the graph when it exists. The node argument +is either a node object, or the graphident of a node.

+
+ +
+
+ObjectGraph.createReferences(fromnode, tonode[, edge_data])
+

Creates a reference from fromnode to tonode. The optional +edge_data is associated with the edge.

+

Fromnode and tonode can either be node objects or the graphident +values for nodes.

+
+ +
+
+altgraph.ObjectGraph.removeReference(fromnode, tonode)
+

Removes the reference from fromnode to tonode if it exists.

+
+ +
+
+ObjectGraph.getRawIdent(node)
+

Returns the graphident attribute of node, or the graph itself +when node is None.

+
+ +
+
+altgraph.ObjectGraph.getIdent(node)
+

Same as getRawIdent(), but only if the node is part +of the graph.

+

Node can either be an actual node object or the graphident of +a node.

+
+ +
+
+ObjectGraph.findNode(node)
+

Returns a given node in the graph, or Node when it cannot +be found.

+

Node is either an object with a graphident attribute or +the graphident attribute itself.

+
+ +
+
+ObjectGraph.__contains__(node)
+

Returns True if node is a member of the graph. Node is either an +object with a graphident attribute or the graphident attribute itself.

+
+ +
+
+ObjectGraph.flatten([condition[, start]])
+

Yield all nodes that are entirely reachable by condition +starting fromt he given start node or the graph root.

+
+

Note

+

objects are only reachable from the graph root +when there is a reference from the root to the node +(either directly or through another node)

+
+
+ +
+
+ObjectGraph.nodes()
+

Yield all nodes in the graph.

+
+ +
+
+ObjectGraph.get_edges(node)
+

Returns two iterators that yield the nodes reaching by +outgoing and incoming edges.

+
+ +
+
+ObjectGraph.filterStack(filters)
+

Filter the ObjectGraph in-place by removing all edges to nodes that +do not match every filter in the given filter list

+

Returns a tuple containing the number of: +(nodes_visited, nodes_removed, nodes_orphaned)

+
+ +
+

Debug output

+
+
+ObjectGraph.debug
+

The current debug level.

+
+ +
+
+ObjectGraph.msg(level, text, *args)
+

Print a debug message at the current indentation level when the current +debug level is level or less.

+
+ +
+
+ObjectGraph.msgin(level, text, *args)
+

Print a debug message when the current debug level is level or less, +and increase the indentation level.

+
+ +
+
+ObjectGraph.msgout(level, text, *args)
+

Decrease the indentation level and print a debug message when the +current debug level is level or less.

+
+ +
+
+ + +
+
+
+
+
+

Table Of Contents

+ + +

Previous topic

+

altgraph.Graph — Basic directional graphs

+

Next topic

+

altgraph.GraphAlgo — Graph algorithms

+ + +
+
+
+
+ + + + \ No newline at end of file -- cgit v1.2.3