AhUvdZddlZddlmZddlmZddlmZmZm Z ddl m Z m Z GddejZy) zModels and base APIN)reduce)Q)modelsrouter connections)InvalidPositionMissingNodeOrderByc8eZdZdZdZedZedZedZed8dZ ed9dZ ed Z ed Z ed Z ed Zed Zed:dZed:dZdZdZdZdZdZdZdZdZdZdZdZdZdZdZdZ dZ!d:d Z"d!Z#d"Z$d#Z%d$Z&d;d%Z'd:d&Z(d'Z)de)_*de)_+d(Z,d)Z-d*Z.d+Z/e-d,zZ0e.d-zZ1d.Z2d/Z3ed0Z4ed!> ~"?"' # 'rcg}|dddDcgc]}||f}}|j}|jjj}|r|j \}} | dj } |j || |r| || |<|r|jdi| } n|jdi| } |j| jd| vr*|j| ddddDcgc]}| |fc}|r|Scc}wcc}w)a Loads a list/dictionary structure to the tree. :param bulk_data: The data that will be loaded, the structure is a list of dictionaries with 2 keys: - ``data``: will store arguments that will be passed for object creation, and - ``children``: a list of dictionaries, each one has it's own ``data`` and ``children`` keys (a recursive structure) :param parent: The node that will receive the structure as children, if not specified the first level of the structure will be loaded as root nodes :param keep_ids: If enabled, loads the nodes with the same primary keys that are given in the structure. Will error if there are nodes without primary key info or if the primary keys are already used. :returns: A list of the added node ids. Ndatachildren) rrr"attnamepopcopyr( add_childrappendextend) r bulk_datarkeep_idsaddednodestackrpk_field node_structr&node_objs r load_bulkzNode.load_bulk?s"H,5ddO&1(&; (#+6++8i8'3<<4)4 LL %[( +J 7" =t$& /=&s D, DTct)a Dumps a tree branch to a python data structure. :param parent: The node whose descendants will be dumped. The node itself will be included in the dump. If not given, the entire tree will be dumped. :param keep_ids: Stores the pk value (primary key) of every node. Enabled by default. :returns: A python data structure, described with detail in :meth:`load_bulk` r )rrr5s r dump_bulkzNode.dump_bulk~s $"!rct)z;:returns: A queryset containing the root nodes in the tree.r rs rget_root_nodeszNode.get_root_nodes "!rcH |jdS#t$rYywxYw)zd :returns: The first root node in the tree or ``None`` if it is empty. rN)rA IndexErrorr@s rget_first_root_nodezNode.get_first_root_nodes- %%'* *    !!cd |jjdS#t$rYywxYw)zc :returns: The last root node in the tree or ``None`` if it is empty. rN)rAreverserDr@s rget_last_root_nodezNode.get_last_root_nodes6 %%'//1!4 4   # //ct)z*Checks for problems in the tree structure.r r@s r find_problemszNode.find_problemsrBrct)z Solves problems that can appear when transactions are not used and a piece of code breaks, leaving the tree in an inconsistent state. r r@s rfix_treez Node.fix_trees "!rct)z :returns: A list of nodes ordered as DFS, including the parent. If no parent is given, the entire tree is returned. r )rrs rget_treez Node.get_tree "!rc||j}n|j}t|}|D]}|j|_|S)a Helper for a very common case: get a group of siblings and the number of *descendants* (not only children) in every sibling. :param parent: The parent of the siblings to return. If no parent is given, the root nodes will be returned. :returns: A `list` (**NOT** a Queryset) of node objects with an extra attribute: `descendants_count`. )rA get_childrenlistget_descendant_countdescendants_count)rrqsetnodesr7s rget_descendants_group_countz Node.get_descendants_group_countsU >%%'D&&(DT  AD%)%>%>%@D " A rct)z':returns: the depth (level) of the noder selfs r get_depthzNode.get_depth!!rct)zv :returns: A queryset of all the node's siblings, including the node itself. r r[s r get_siblingszNode.get_siblings "!rct)z/:returns: A queryset of all the node's childrenr r[s rrSzNode.get_childrenr^rc>|jjS)z+:returns: The number of the node's children)rScountr[s rget_children_countzNode.get_children_counts  "((**rct)z :returns: A queryset of all the node's descendants, doesn't include the node itself (some subclasses may return a list). r r[s rget_descendantszNode.get_descendantsrarc>|jjS)z.:returns: the number of descendants of a node.)rgrdr[s rrUzNode.get_descendant_counts##%++--rcH |jdS#t$rYywxYw)zb :returns: The leftmost node's child, or None if it has no children. rN)rSrDr[s rget_first_childzNode.get_first_childs-  $$&q) )  rFcd |jjdS#t$rYywxYw)zc :returns: The rightmost node's child, or None if it has no children. rN)rSrHrDr[s rget_last_childzNode.get_last_child s6  $$&..03 3  rJc(|jdS)z :returns: The leftmost node's sibling, can return the node itself if it was the leftmost sibling. r)r`r[s rget_first_siblingzNode.get_first_siblings  "1%%rcD|jjdS)z :returns: The rightmost node's sibling, can return the node itself if it was the rightmost sibling. r)r`rHr[s rget_last_siblingzNode.get_last_sibling s!  "**,Q//rc|j}|Dcgc]}|j}}|j|vr)|j|j}|dkDr||dz Syycc}w)zy :returns: The previous node's sibling, or None if it was the leftmost sibling. rN)r`r"indexr\siblingsobjidsidxs rget_prev_siblingzNode.get_prev_sibling)sk$$&!)*#svv** 77c>))DGG$CQwa(( +sA"c|j}|Dcgc]}|j}}|j|vr5|j|j}|t|dz kr||dzSyycc}w)zv :returns: The next node's sibling, or None if it was the rightmost sibling. rrN)r`r"rslenrts rget_next_siblingzNode.get_next_sibling7su$$&!)*#svv** 77c>))DGG$CS]Q&&a((' +sA.cr|jj|jjS)z :returns: ``True`` if the node is a sibling of another node given as an argument, else, returns ``False`` :param node: The node that will be checked as a sibling r!)r`filterr"existsr\r7s r is_sibling_ofzNode.is_sibling_ofE.  "))TWW)5<<>>rcr|jj|jjS)z :returns: ``True`` if the node is a child of another node given as an argument, else, returns ``False`` :param node: The node that will be checked as a parent r!)rSr~r"rrs r is_child_ofzNode.is_child_ofPrrct)z :returns: ``True`` if the node is a descendant of another node given as an argument, else, returns ``False`` :param node: The node that will be checked as an ancestor r rs ris_descendant_ofzNode.is_descendant_of[s "!rc t)a Adds a child to the node. The new node will be the new rightmost child. If you want to insert a node at a specific position, use the :meth:`add_sibling` method of an already existing child node instead. :param `**kwargs`: Object creation data that will be passed to the inherited Node model :param instance: Instead of passing object creation data, you can pass an already-constructed (but not yet saved) model instance to be inserted into the tree. :returns: The created node object. It will be save()d by this method. :raise NodeAlreadySaved: when the passed ``instance`` already exists in the database r )r\rs rr1zNode.add_childfs ("!rc t)a Adds a new node as a sibling to the current node object. :param pos: The position, relative to the current node object, where the new node will be inserted, can be one of: - ``first-sibling``: the new node will be the new leftmost sibling - ``left``: the new node will take the node's place, which will be moved to the right 1 position - ``right``: the new node will be inserted at the right of the node - ``last-sibling``: the new node will be the new rightmost sibling - ``sorted-sibling``: the new node will be at the right position according to the value of node_order_by :param `**kwargs`: Object creation data that will be passed to the inherited Node model :param instance: Instead of passing object creation data, you can pass an already-constructed (but not yet saved) model instance to be inserted into the tree. :returns: The created node object. It will be saved by this method. :raise InvalidPosition: when passing an invalid ``pos`` parm :raise InvalidPosition: when :attr:`node_order_by` is enabled and the ``pos`` parm wasn't ``sorted-sibling`` :raise MissingNodeOrderBy: when passing ``sorted-sibling`` as ``pos`` and the :attr:`node_order_by` attribute is missing :raise NodeAlreadySaved: when the passed ``instance`` already exists in the database r )r\posrs r add_siblingzNode.add_sibling|s J"!rct)z4:returns: the root node for the current node object.r r[s rget_rootz Node.get_rootr^rcP|jj|jk(S)z?:returns: True if the node is a root node (else, returns False))rr"r[s ris_rootz Node.is_roots}}!!TWW,,rc@|jj S)z?:returns: True if the node is a leaf node (else, returns False))rSrr[s ris_leafz Node.is_leafs$$&--///rct)z :returns: A queryset containing the current node object's ancestors, starting by the root node and descending to the parent. (some subclasses may return a list) r r[s r get_ancestorszNode.get_ancestorsrQrct)z :returns: the parent node of the current node object. Caches the result in the object itself to help in loops. :param update: Updates the cached value. r )r\updates r get_parentzNode.get_parentrarct)ax Moves the current node and all it's descendants to a new position relative to another node. :param target: The node that will be used as a relative child/sibling when moving :param pos: The position, relative to the target node, where the current node object will be moved to, can be one of: - ``first-child``: the node will be the new leftmost child of the ``target`` node - ``last-child``: the node will be the new rightmost child of the ``target`` node - ``sorted-child``: the new node will be moved as a child of the ``target`` node according to the value of :attr:`node_order_by` - ``first-sibling``: the node will be the new leftmost sibling of the ``target`` node - ``left``: the node will take the ``target`` node's place, which will be moved to the right 1 position - ``right``: the node will be moved to the right of the ``target`` node - ``last-sibling``: the node will be the new rightmost sibling of the ``target`` node - ``sorted-sibling``: the new node will be moved as a sibling of the ``target`` node according to the value of :attr:`node_order_by` .. note:: If no ``pos`` is given the library will use ``last-sibling``, or ``sorted-sibling`` if :attr:`node_order_by` is enabled. :returns: None :raise InvalidPosition: when passing an invalid ``pos`` parm :raise InvalidPosition: when :attr:`node_order_by` is enabled and the ``pos`` parm wasn't ``sorted-sibling`` or ``sorted-child`` :raise InvalidMoveToDescendant: when trying to move a node to one of it's own descendants :raise PathOverflow: when the library can't make room for the node's new position :raise MissingNodeOrderBy: when passing ``sorted-sibling`` or ``sorted-child`` as ``pos`` and the :attr:`node_order_by` attribute is missing r )r\targetrs rmovez Node.moves d"!rc|jjj|jj|i|S)z(Removes a node and all it's descendants.r!) __class__r$r~r"delete)r\argsrs rrz Node.deletes6?t~~%%,,,8??PPPrc||jrd}nd}||vrtd||jr%||vr!tddj|d|d||vr|js td|S) Nsorted-sibling last-siblingzInvalid relative position: z Must use z or z in z when node_order_by is enabledz Missing node_order_by attribute.) node_order_byrjoinr )r\r method_name valid_posvalid_sorted_poss r_prepare_pos_varzNode._prepare_pos_vars ;!!&$ i !S"KL L   #-="=!KK 01;@A A " "4+=+=$%GH H r)z first-siblingleftrightrr)rcR|j|d|j|jS)Nr)r_valid_pos_for_add_sibling!_valid_pos_for_sorted_add_siblingr\rs r _prepare_pos_var_for_add_siblingz%Node._prepare_pos_var_for_add_siblings-$$    + +  2 2 4 4r)z first-childz last-child sorted-child)rcR|j|d|j|jS)Nr)r_valid_pos_for_move_valid_pos_for_sorted_movers r_prepare_pos_var_for_movezNode._prepare_pos_var_for_moves-$$    $ $  + + - -rcVgg}}|jD]h}t||}|jt|Dcgc]\}}tdi||ic}}tdid|z|igz|j||fj|j t t j|Scc}}w)am :returns: A queryset of the nodes that must be moved to the right. Called only for Node models with :attr:`node_order_by` This function is based on _insertion_target_filters from django-mptt (BSD licensed) by Jonathan Buchanan: https://github.com/django-mptt/django-mptt/blob/0.3.0/mptt/signals.py z%s__gtr-)rgetattrr2rr~roperatoror_) r\runewobjrfiltersrvaluefvs rget_sorted_pos_querysetzNode.get_sorted_pos_queryset$sb'' *EFE*E NN.45daak1a&k548e+U3456  MM5%. ) *vhllG<== 6sB%c6gi}}d\}}|D]e}|j}||}|xr |duxs||kD}| ||krttd||z |d<|g||z d}|j||f|}g|r#|dkDrttd||z dz|d<|S)z9 Gets an annotated list from a queryset. NNNrclose)openrlevelrr)r]rTranger2) rqsresultinfo start_depth prev_depthr7depthrs rget_annotated_list_qszNode.get_annotated_list_qs<s 2". Z DNN$E"# HzT1GUZ5GD%%**< $U1j5.@%A BW  2 8KLD MM4- (J  ;? q*{*BQ*F!GHDM rcgi}}d\}}|j|}|r|j|}|j|S)aR Gets an annotated list from a tree branch. :param parent: The node whose descendants will be annotated. The node itself will be included in the list. If not given, the entire tree will be annotated. :param max_depth: Optionally limit to specified depth r) depth__lte)rPr~r)rr max_depthrrrrrs rget_annotated_listzNode.get_annotated_listQsI 2". Z \\& ! i0B((,,rc|}|jjr-|jj}|jjr-|S)z Returns a model with a valid _meta.local_fields (serializable). Basically, this means the original model, not a proxied model. (this is a workaround for a bug in django) )rproxyproxy_for_model)r current_classs r_get_serializable_modelzNode._get_serializable_modelhs@ !!'')//??M!!''rczttj|ttj|d|S)N)readwrite)rr db_for_read db_for_writeractions r_get_database_connectionzNode._get_database_connectionvs>  2 23 78 !4!4S!9:   rc8|j|jS)a  returns the supported database vendor used by a treebeard model when performing read (select) or write (update, insert, delete) operations. :param action: `read` or `write` :returns: postgresql, mysql or sqlite )rvendorrs rget_database_vendorzNode.get_database_vendor}s++F3:::rc@|j|jSN)rcursorrs r_get_database_cursorzNode._get_database_cursors++F3::<rArErIrLrNrPrYr]r`rSrergrUrjrlrnrpryr|rrrr1rrrrrrrr alters_data queryset_onlyrrrrrrrrrrrrrrrr-rrr r sNN""(  ''<<|""&""    """"""0"""+".  &0 ) ) ? ? "",%"N"-0""2"hQFF "D(;%45855!BF"->0(--,    ; ;==rr )rr functoolsrdjango.db.modelsr django.dbrrrtreebeard.exceptionsrr Modelr r-rrrs,11DE 6<<E r