/usr/share/pyshared/gaphas/tree.py is in python-gaphas 0.7.2-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 | """
Simple class containing the tree structure for the canvas items.
"""
__version__ = "$Revision$"
# $HeadURL$
from operator import attrgetter
class Tree(object):
"""
A Tree structure. Nodes are stores in a depth-first order.
``None`` is the root node.
@invariant: len(self._children) == len(self._nodes) + 1
"""
def __init__(self):
# List of nodes in the tree, sorted in the order they ought to be
# rendered
self._nodes = []
# Per entry a list of children is maintained.
self._children = { None: [] }
# For easy and fast lookups, also maintain a child -> parent mapping
self._parents = { }
nodes = property(lambda s: list(s._nodes))
def get_parent(self, node):
"""
Return the parent item of ``node``.
>>> tree = Tree()
>>> tree.add('n1')
>>> tree.add('n2', parent='n1')
>>> tree.get_parent('n2')
'n1'
"""
return self._parents.get(node)
def get_children(self, node):
"""
Return all child objects of ``node``.
>>> tree = Tree()
>>> tree.add('n1')
>>> tree.add('n2', parent='n1')
>>> tree.add('n3', parent='n1')
>>> tree.get_children('n1')
['n2', 'n3']
>>> tree.get_children('n2')
[]
"""
return self._children[node]
def get_siblings(self, node):
"""
Get all siblings of ``node``, including ``node``.
>>> tree = Tree()
>>> tree.add('n1')
>>> tree.add('n2', parent='n1')
>>> tree.add('n3', parent='n1')
>>> tree.get_siblings('n2')
['n2', 'n3']
"""
parent = self.get_parent(node)
return self._children[parent]
def get_next_sibling(self, node):
"""
Return the node on the same level after ``node``.
>>> tree = Tree()
>>> tree.add('n1')
>>> tree.add('n2', parent='n1')
>>> tree.add('n3', parent='n1')
>>> tree.get_next_sibling('n2')
'n3'
>>> tree.get_next_sibling('n3') # doctest: +ELLIPSIS
Traceback (most recent call last):
...
IndexError: list index out of range
"""
parent = self.get_parent(node)
siblings = self._children[parent]
return siblings[siblings.index(node) + 1]
def get_previous_sibling(self, node):
"""
Return the node on the same level before ``node``.
>>> tree = Tree()
>>> tree.add('n1')
>>> tree.add('n2', parent='n1')
>>> tree.add('n3', parent='n1')
>>> tree.get_previous_sibling('n3')
'n2'
>>> tree.get_previous_sibling('n2') # doctest: +ELLIPSIS
Traceback (most recent call last):
...
IndexError: list index out of range
"""
parent = self.get_parent(node)
siblings = self._children[parent]
index = siblings.index(node) - 1
if index < 0:
raise IndexError('list index out of range')
return siblings[index]
def get_all_children(self, node):
"""
Iterate all children (and children of children and so forth)
>>> tree = Tree()
>>> tree.add('n1')
>>> tree.add('n2', parent='n1')
>>> tree.add('n3', parent='n2')
>>> tree.get_children('n1')
['n2']
>>> tree.get_all_children('n1') # doctest: +ELLIPSIS
<generator object get_all_children at 0x...>
>>> list(tree.get_all_children('n1'))
['n2', 'n3']
"""
children = self.get_children(node)
for c in children:
yield c
for cc in self.get_all_children(c):
yield cc
def get_ancestors(self, node):
"""
Iterate all parents and parents of parents, etc.
>>> tree = Tree()
>>> tree.add('n1')
>>> tree.add('n2', parent='n1')
>>> tree.add('n3', parent='n2')
>>> tree.get_parent('n3')
'n2'
>>> tree.get_ancestors('n3') # doctest: +ELLIPSIS
<generator object get_ancestors at 0x...>
>>> list(tree.get_ancestors('n3'))
['n2', 'n1']
>>> list(tree.get_ancestors('n1'))
[]
"""
parent = self.get_parent(node)
while parent:
yield parent
parent = self.get_parent(parent)
def index_nodes(self, index_key):
"""
Provide each item in the tree with an index attribute. This makes
for fast sorting of items.
>>> class A(object):
... def __init__(self, n):
... self.n = n
... def __repr__(self):
... return self.n
>>> t = Tree()
>>> a = A('a')
>>> t.add(a)
>>> t.add(A('b'))
>>> t.add(A('c'), parent=a)
>>> t.nodes
[a, c, b]
>>> t.index_nodes('my_key')
>>> t.nodes[0].my_key, t.nodes[1].my_key, t.nodes[2].my_key
(0, 1, 2)
For sorting, see ``sort()``.
"""
nodes = self.nodes
lnodes = len(nodes)
map(setattr, nodes, [index_key] * lnodes, xrange(lnodes))
def sort(self, nodes, index_key, reverse=False):
"""
Sort a set (or list) of nodes.
>>> class A(object):
... def __init__(self, n):
... self.n = n
... def __repr__(self):
... return self.n
>>> t = Tree()
>>> a = A('a')
>>> t.add(a)
>>> t.add(A('b'))
>>> t.add(A('c'), parent=a)
>>> t.nodes # the series from Tree.index_nodes
[a, c, b]
>>> t.index_nodes('my_key')
>>> selection = (t.nodes[2], t.nodes[1])
>>> t.sort(selection, index_key='my_key')
[c, b]
"""
if index_key:
return sorted(nodes, key=attrgetter(index_key), reverse=reverse)
else:
raise NotImplemented('index_key should be provided.')
def _add_to_nodes(self, node, parent, index=None):
"""
Helper method to place nodes on the right location in the nodes list
Called only from add() and reparent()
"""
nodes = self._nodes
siblings = self._children[parent]
try:
atnode = siblings[index]
except (TypeError, IndexError):
index = len(siblings)
#self._add_to_nodes(node, parent)
if parent:
try:
next_uncle = self.get_next_sibling(parent)
except IndexError:
# parent has no younger brothers..
# place it before the next uncle of grant_parent:
return self._add_to_nodes(node, self.get_parent(parent))
else:
nodes.insert(nodes.index(next_uncle), node)
else:
# append to root node:
nodes.append(node)
else:
nodes.insert(nodes.index(atnode), node)
def _add(self, node, parent=None, index=None):
"""
Helper method for both add() and reparent().
"""
assert node not in self._nodes
siblings = self._children[parent]
self._add_to_nodes(node, parent, index)
# Fix parent-child and child-parent relationship
try:
siblings.insert(index, node)
except TypeError:
siblings.append(node)
# Create new entry for it's own children:
if parent:
self._parents[node] = parent
def add(self, node, parent=None, index=None):
"""
Add node to the tree. parent is the parent node, which may
be None if the item should be added to the root item.
For usage, see the unit tests.
"""
self._add(node, parent, index)
self._children[node] = []
def _remove(self, node):
# Remove from parent item
self.get_siblings(node).remove(node)
# Remove data entries:
del self._children[node]
self._nodes.remove(node)
try:
del self._parents[node]
except KeyError:
pass
def remove(self, node):
"""
Remove ``node`` from the tree.
For usage, see the unit tests.
"""
# First remove children:
for c in reversed(list(self._children[node])):
self.remove(c)
self._remove(node)
def _reparent_nodes(self, node, parent):
"""
Helper for reparent().
The _children and _parent trees can be left intact as far as children
of the reparented node are concerned. Only the position in the
_nodes list changes.
"""
self._nodes.remove(node)
self._add_to_nodes(node, parent)
for c in self._children[node]:
self._reparent_nodes(c, node)
def reparent(self, node, parent, index=None):
"""
Set new parent for a ``node``. ``Parent`` can be ``None``, indicating
it's added to the top.
>>> tree = Tree()
>>> tree.add('n1')
>>> tree.add('n2', parent='n1')
>>> tree.add('n3', parent='n1')
>>> tree.nodes
['n1', 'n2', 'n3']
>>> tree.reparent('n2', 'n3')
>>> tree.get_parent('n2')
'n3'
>>> tree.get_children('n3')
['n2']
>>> tree.nodes
['n1', 'n3', 'n2']
If a node contains children, those are also moved:
>>> tree.add('n4')
>>> tree.nodes
['n1', 'n3', 'n2', 'n4']
>>> tree.reparent('n1', 'n4')
>>> tree.get_parent('n1')
'n4'
>>> list(tree.get_all_children('n4'))
['n1', 'n3', 'n2']
>>> tree.nodes
['n4', 'n1', 'n3', 'n2']
"""
if parent is self.get_parent(node):
return
# Remove all node references:
old_parent = self.get_parent(node)
self._children[old_parent].remove(node)
self._nodes.remove(node)
if old_parent:
del self._parents[node]
self._add(node, parent, index)
# reorganize children in nodes list
for c in self._children[node]:
self._reparent_nodes(c, node)
# vi: sw=4:et:ai
|