a C gU@s^dZddlZddlmZddlmZddlmZmZm Z ddl m Z m Z Gdddej ZdS) zModels and base APIN)reduceQ)modelsrouter connections)InvalidPositionMissingNodeOrderByc@seZdZdZdZeddZeddZeddZedgd d Z edhd dZ eddZ eddZ eddZ eddZeddZediddZedjddZddZdd Zd!d"Zd#d$Zd%d&Zd'd(Zd)d*Zd+d,Zd-d.Zd/d0Zd1d2Zd3d4Zd5d6Zd7d8Zd9d:Z d;d<Z!dkd=d>Z"d?d@Z#dAdBZ$dCdDZ%dEdFZ&dldGdHZ'dmdIdJZ(dKdLZ)d e)_*d e)_+dMdNZ,dOZ-dPZ.dQdRZ/e-dSZ0e.dTZ1dUdVZ2dWdXZ3edYdZZ4ednd[d\Z5ed]d^Z6ed_d`Z7edadbZ8edcddZ9GdedfdfZ:dS)oNodez Node classNcKstdS)a Adds a root node to the tree. The new root node will be the new rightmost root node. If you want to insert a root node at a specific position, use :meth:`add_sibling` in an already existing root 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 NNotImplementedError)clskwargsrO/var/www/lab.imftr.de/x/nb_venv/lib/python3.9/site-packages/treebeard/models.pyadd_rootsz Node.add_rootcCs:i}|jjD](}|dkr |jdkr |jj||j<q |S)zhGet foreign keys and models they refer to, so we can pre-process the data for load_bulk Z ForeignKeyparent)_metafieldsZget_internal_typenameZ remote_fieldmodel)r foreign_keysfieldrrrget_foreign_keys&s  zNode.get_foreign_keyscCs4|D]&}||vr||jj||d||<qdS)zFor each foreign key try to load the actual object so load_bulk doesn't fail trying to load an int where django expects a model instance pkN)keysobjectsget)r r node_datakeyrrr_process_foreign_keys4s   zNode._process_foreign_keysFc sg}fdd|dddD}|}|jjj}|r|\}|d} ||| |rj||| |<rjfi| n|jfi| | jd|vr2| fdd|ddddDq2|S)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. csg|] }|fqSrr.0node)rrr ez"Node.load_bulk..Ndatachildrencsg|] }|fqSrrr")node_objrrr%xs) rrrZattnamepopcopyr! add_childrappendextend) r Z bulk_datarkeep_idsaddedstackrZpk_fieldZ node_structrr)r*rr load_bulk?s&$       zNode.load_bulkTcCstdS)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` Nr )r rr0rrr dump_bulk~szNode.dump_bulkcCstdS)z;:returns: A queryset containing the root nodes in the tree.Nr r rrrget_root_nodesszNode.get_root_nodescCs(z|dWSty"YdS0dS)zd :returns: The first root node in the tree or ``None`` if it is empty. rN)r6 IndexErrorr5rrrget_first_root_nodes zNode.get_first_root_nodecCs,z|dWSty&YdS0dS)zc :returns: The last root node in the tree or ``None`` if it is empty. rN)r6reverser7r5rrrget_last_root_nodes zNode.get_last_root_nodecCstdS)z*Checks for problems in the tree structure.Nr r5rrr find_problemsszNode.find_problemscCstdS)z Solves problems that can appear when transactions are not used and a piece of code breaks, leaving the tree in an inconsistent state. Nr r5rrrfix_treesz Node.fix_treecCstdS)z :returns: A list of nodes ordered as DFS, including the parent. If no parent is given, the entire tree is returned. Nr )r rrrrget_treesz Node.get_treecCs:|dur|}n|}t|}|D]}||_q&|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`. N)r6 get_childrenlistget_descendant_countZdescendants_count)r rZqsetnodesr$rrrget_descendants_group_counts  z Node.get_descendants_group_countcCstdS)z':returns: the depth (level) of the nodeNr selfrrr get_depthszNode.get_depthcCstdS)zv :returns: A queryset of all the node's siblings, including the node itself. Nr rCrrr get_siblingsszNode.get_siblingscCstdS)z/:returns: A queryset of all the node's childrenNr rCrrrr>szNode.get_childrencCs |S)z+:returns: The number of the node's children)r>countrCrrrget_children_countszNode.get_children_countcCstdS)z :returns: A queryset of all the node's descendants, doesn't include the node itself (some subclasses may return a list). Nr rCrrrget_descendantsszNode.get_descendantscCs |S)z.:returns: the number of descendants of a node.)rIrGrCrrrr@szNode.get_descendant_countcCs(z|dWSty"YdS0dS)zb :returns: The leftmost node's child, or None if it has no children. rN)r>r7rCrrrget_first_childs zNode.get_first_childcCs,z|dWSty&YdS0dS)zc :returns: The rightmost node's child, or None if it has no children. rN)r>r9r7rCrrrget_last_child s zNode.get_last_childcCs |dS)z :returns: The leftmost node's sibling, can return the node itself if it was the leftmost sibling. r)rFrCrrrget_first_siblingszNode.get_first_siblingcCs|dS)z :returns: The rightmost node's sibling, can return the node itself if it was the rightmost sibling. r)rFr9rCrrrget_last_sibling szNode.get_last_siblingcCsD|}dd|D}|j|vr@||j}|dkr@||dSdS)zy :returns: The previous node's sibling, or None if it was the leftmost sibling. cSsg|] }|jqSrrr#objrrrr%1r&z)Node.get_prev_sibling..rN)rFrindexrDsiblingsidsidxrrrget_prev_sibling)s   zNode.get_prev_siblingcCsL|}dd|D}|j|vrH||j}|t|dkrH||dSdS)zv :returns: The next node's sibling, or None if it was the rightmost sibling. cSsg|] }|jqSrrrNrrrr%?r&z)Node.get_next_sibling..rPN)rFrrQlenrRrrrget_next_sibling7s   zNode.get_next_siblingcCs|j|jdS)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)rFfilterrexistsrDr$rrr is_sibling_ofEs zNode.is_sibling_ofcCs|j|jdS)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)r>rYrrZr[rrr is_child_ofPs zNode.is_child_ofcCstdS)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 Nr r[rrris_descendant_of[s zNode.is_descendant_ofcKstdS)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 Nr )rDrrrrr-fszNode.add_childcKstdS)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 Nr )rDposrrrr add_sibling|s%zNode.add_siblingcCstdS)z4:returns: the root node for the current node object.Nr rCrrrget_rootsz Node.get_rootcCs|j|jkS)z?:returns: True if the node is a root node (else, returns False))rarrCrrris_rootsz Node.is_rootcCs| S)z?:returns: True if the node is a leaf node (else, returns False))r>rZrCrrris_leafsz Node.is_leafcCstdS)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) Nr rCrrr get_ancestorsszNode.get_ancestorscCstdS)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. Nr )rDupdaterrr get_parentszNode.get_parentcCstdS)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 Nr )rDtargetr_rrrmoves2z Node.movecOs|jjj|jdj|i|S)z(Removes a node and all it's descendants.r) __class__rrYrdelete)rDargsrrrrrjsz Node.deletecCsl|dur|jrd}nd}||vr.td|f|jrR||vrRtdd||f||vrh|jshtd|S)Nsorted-sibling last-siblingzInvalid relative position: %sz/Must use %s in %s when node_order_by is enabledz or z Missing node_order_by attribute.) node_order_byrjoinr )rDr_ method_nameZ valid_posZvalid_sorted_posrrr_prepare_pos_vars zNode._prepare_pos_var)z first-siblingleftrightrmrl)rlcCs||d|j|jS)Nr`)rq_valid_pos_for_add_sibling!_valid_pos_for_sorted_add_siblingrDr_rrr _prepare_pos_var_for_add_siblings z%Node._prepare_pos_var_for_add_sibling)z first-childz last-child sorted-child)rxcCs||d|j|jS)Nrh)rq_valid_pos_for_move_valid_pos_for_sorted_movervrrr_prepare_pos_var_for_moves zNode._prepare_pos_var_for_movec Cspgg}}|jD]L}t||}|tdd|Dtfid||ig|||fq|ttj|S)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 cSs"g|]\}}tfi||iqSrr)r#fvrrrr%5r&z0Node.get_sorted_pos_queryset..z%s__gt)rngetattrr.rrYroperatoror_)rDrSZnewobjrfiltersrvaluerrrget_sorted_pos_queryset$s    zNode.get_sorted_pos_querysetc Csgi}}d\}}|D]t}|}|dur.|}|o@|dup@||k}|durh||krhttd|||d<|g||d}|||f|}q|r|dkrttd||d|d<|S)z9 Gets an annotated list from a queryset. NNNrclose)openrlevelrP)rEr?ranger.) r qsresultinfo start_depth prev_depthr$depthrrrrget_annotated_list_qs<s  zNode.get_annotated_list_qscCs6gi}}d\}}||}|r,|j|d}||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)Z depth__lte)r=rYr)r rZ max_depthrrrrrrrrget_annotated_listQs    zNode.get_annotated_listcCs|}|jjr|jj}q|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) )rproxyZproxy_for_model)r Z current_classrrr_get_serializable_modelhs  zNode._get_serializable_modelcCs"tt|tt|d|S)N)readwrite)rrZ db_for_readZ db_for_writer actionrrr_get_database_connectionvs   zNode._get_database_connectioncCs ||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 )rvendorrrrrget_database_vendor}s zNode.get_database_vendorcCs||S)N)rcursorrrrr_get_database_cursorszNode._get_database_cursorc@seZdZdZdZdS)z Node.MetazAbstract model.TN)__name__ __module__ __qualname____doc__ZabstractrrrrMetasr)NF)NT)N)N)N)F)N)NN);rrrrZ_db_connection classmethodrrr!r3r4r6r8r:r;r<r=rBrErFr>rHrIr@rJrKrLrMrVrXr\r]r^r-r`rarbrcrdrfrhrjZ alters_dataZ queryset_onlyrqrtrurwryrzr{rrrrrrrrrrrrr s    >                  ' 4      r )rr functoolsrZdjango.db.modelsrZ django.dbrrrZtreebeard.exceptionsrr ZModelr rrrrs