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
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
|
API
===
.. module:: treebeard.models
.. inheritance-diagram:: Node
.. autoclass:: Node
:show-inheritance:
This is the base class that defines the API of all tree models in this
library:
- :class:`treebeard.mp_tree.MP_Node` (materialized path)
- :class:`treebeard.ns_tree.NS_Node` (nested sets)
- :class:`treebeard.al_tree.AL_Node` (adjacency list)
.. warning::
Please be aware of the :doc:`caveats` when using this library.
.. automethod:: Node.add_root
Example:
.. code-block:: python
MyNode.add_root(numval=1, strval='abcd')
Or, to pass in an existing instance:
.. code-block:: python
new_node = MyNode(numval=1, strval='abcd')
MyNode.add_root(instance=new_node)
.. automethod:: add_child
Example:
.. code-block:: python
node.add_child(numval=1, strval='abcd')
Or, to pass in an existing instance:
.. code-block:: python
new_node = MyNode(numval=1, strval='abcd')
node.add_child(instance=new_node)
.. automethod:: add_sibling
Examples:
.. code-block:: python
node.add_sibling('sorted-sibling', numval=1, strval='abc')
Or, to pass in an existing instance:
.. code-block:: python
new_node = MyNode(numval=1, strval='abc')
node.add_sibling('sorted-sibling', instance=new_node)
.. automethod:: delete
.. note::
Call our queryset's delete to handle children removal. Subclasses
will handle extra maintenance.
.. automethod:: get_tree
.. automethod:: get_depth
Example:
.. code-block:: python
node.get_depth()
.. automethod:: get_ancestors
Example:
.. code-block:: python
node.get_ancestors()
.. automethod:: get_children
Example:
.. code-block:: python
node.get_children()
.. automethod:: get_children_count
Example:
.. code-block:: python
node.get_children_count()
.. automethod:: get_descendants
Example:
.. code-block:: python
node.get_descendants()
.. automethod:: get_descendant_count
Example:
.. code-block:: python
node.get_descendant_count()
.. automethod:: get_first_child
Example:
.. code-block:: python
node.get_first_child()
.. automethod:: get_last_child
Example:
.. code-block:: python
node.get_last_child()
.. automethod:: get_first_sibling
Example:
.. code-block:: python
node.get_first_sibling()
.. automethod:: get_last_sibling
Example:
.. code-block:: python
node.get_last_sibling()
.. automethod:: get_prev_sibling
Example:
.. code-block:: python
node.get_prev_sibling()
.. automethod:: get_next_sibling
Example:
.. code-block:: python
node.get_next_sibling()
.. automethod:: get_parent
Example:
.. code-block:: python
node.get_parent()
.. automethod:: get_root
Example:
.. code-block:: python
node.get_root()
.. automethod:: get_siblings
Example:
.. code-block:: python
node.get_siblings()
.. automethod:: is_child_of
Example:
.. code-block:: python
node.is_child_of(node2)
.. automethod:: is_descendant_of
Example:
.. code-block:: python
node.is_descendant_of(node2)
.. automethod:: is_sibling_of
Example:
.. code-block:: python
node.is_sibling_of(node2)
.. automethod:: is_root
Example:
.. code-block:: python
node.is_root()
.. automethod:: is_leaf
Example:
.. code-block:: python
node.is_leaf()
.. automethod:: move
.. note:: The node can be moved under another root node.
Examples:
.. code-block:: python
node.move(node2, 'sorted-child')
node.move(node2, 'prev-sibling')
.. automethod:: save
.. automethod:: get_first_root_node
Example:
.. code-block:: python
MyNodeModel.get_first_root_node()
.. automethod:: get_last_root_node
Example:
.. code-block:: python
MyNodeModel.get_last_root_node()
.. automethod:: get_root_nodes
Example:
.. code-block:: python
MyNodeModel.get_root_nodes()
.. automethod:: load_bulk
.. note::
Any internal data that you may have stored in your
nodes' data (:attr:`path`, :attr:`depth`) will be
ignored.
.. note::
If your node model has a ForeignKey this method will try to load
the related object before loading the data. If the related object
doesn't exist it won't load anything and will raise a DoesNotExist
exception. This is done because the dump_data method uses integers
to dump related objects.
.. note::
If your node model has :attr:`node_order_by` enabled, it will
take precedence over the order in the structure.
Example:
.. code-block:: python
data = [{'data':{'desc':'1'}},
{'data':{'desc':'2'}, 'children':[
{'data':{'desc':'21'}},
{'data':{'desc':'22'}},
{'data':{'desc':'23'}, 'children':[
{'data':{'desc':'231'}},
]},
{'data':{'desc':'24'}},
]},
{'data':{'desc':'3'}},
{'data':{'desc':'4'}, 'children':[
{'data':{'desc':'41'}},
]},
]
# parent = None
MyNodeModel.load_bulk(data, None)
Will create:
.. digraph:: load_bulk_digraph
"1";
"2";
"2" -> "21";
"2" -> "22";
"2" -> "23" -> "231";
"2" -> "24";
"3";
"4";
"4" -> "41";
.. automethod:: dump_bulk
Example:
.. code-block:: python
tree = MyNodeModel.dump_bulk()
branch = MyNodeModel.dump_bulk(node_obj)
.. automethod:: find_problems
.. automethod:: fix_tree
.. automethod:: get_descendants_group_count
Example:
.. code-block:: python
# get a list of the root nodes
root_nodes = MyModel.get_descendants_group_count()
for node in root_nodes:
print '%s by %s (%d replies)' % (node.comment, node.author,
node.descendants_count)
.. automethod:: get_annotated_list
Example:
.. code-block:: python
annotated_list = MyModel.get_annotated_list()
With data:
.. digraph:: get_annotated_list_digraph
"a";
"a" -> "ab";
"ab" -> "aba";
"ab" -> "abb";
"ab" -> "abc";
"a" -> "ac";
Will return:
.. code-block:: python
[
(a, {'open':True, 'close':[], 'level': 0})
(ab, {'open':True, 'close':[], 'level': 1})
(aba, {'open':True, 'close':[], 'level': 2})
(abb, {'open':False, 'close':[], 'level': 2})
(abc, {'open':False, 'close':[0,1], 'level': 2})
(ac, {'open':False, 'close':[0], 'level': 1})
]
This can be used with a template like:
.. code-block:: django
{% for item, info in annotated_list %}
{% if info.open %}
<ul><li>
{% else %}
</li><li>
{% endif %}
{{ item }}
{% for close in info.close %}
</li></ul>
{% endfor %}
{% endfor %}
.. note::
This method was contributed originally by
`Alexey Kinyov <rudi@05bit.com>`_, using an idea borrowed from
`django-mptt`_.
.. versionadded:: 1.55
.. automethod:: get_annotated_list_qs
.. automethod:: get_database_vendor
Example:
.. code-block:: python
MyNodeModel.get_database_vendor("write")
.. versionadded:: 1.61
.. _django-mptt: https://github.com/django-mptt/django-mptt/
|
