h :dZddlmZddlmZddlmZddlmZddlmZddlmZdd l m Z dd l m Z ed Z ee ee ge fZd gZ d ddZdZdZdZdZGddee ZdZy )aA custom list that manages index/position information for contained elements. :author: Jason Kirtland ``orderinglist`` is a helper for mutable ordered relationships. It will intercept list operations performed on a :func:`_orm.relationship`-managed collection and automatically synchronize changes in list position onto a target scalar attribute. Example: A ``slide`` table, where each row refers to zero or more entries in a related ``bullet`` table. The bullets within a slide are displayed in order based on the value of the ``position`` column in the ``bullet`` table. As entries are reordered in memory, the value of the ``position`` attribute should be updated to reflect the new sort order:: Base = declarative_base() class Slide(Base): __tablename__ = "slide" id = Column(Integer, primary_key=True) name = Column(String) bullets = relationship("Bullet", order_by="Bullet.position") class Bullet(Base): __tablename__ = "bullet" id = Column(Integer, primary_key=True) slide_id = Column(Integer, ForeignKey("slide.id")) position = Column(Integer) text = Column(String) The standard relationship mapping will produce a list-like attribute on each ``Slide`` containing all related ``Bullet`` objects, but coping with changes in ordering is not handled automatically. When appending a ``Bullet`` into ``Slide.bullets``, the ``Bullet.position`` attribute will remain unset until manually assigned. When the ``Bullet`` is inserted into the middle of the list, the following ``Bullet`` objects will also need to be renumbered. The :class:`.OrderingList` object automates this task, managing the ``position`` attribute on all ``Bullet`` objects in the collection. It is constructed using the :func:`.ordering_list` factory:: from sqlalchemy.ext.orderinglist import ordering_list Base = declarative_base() class Slide(Base): __tablename__ = "slide" id = Column(Integer, primary_key=True) name = Column(String) bullets = relationship( "Bullet", order_by="Bullet.position", collection_class=ordering_list("position"), ) class Bullet(Base): __tablename__ = "bullet" id = Column(Integer, primary_key=True) slide_id = Column(Integer, ForeignKey("slide.id")) position = Column(Integer) text = Column(String) With the above mapping the ``Bullet.position`` attribute is managed:: s = Slide() s.bullets.append(Bullet()) s.bullets.append(Bullet()) s.bullets[1].position >>> 1 s.bullets.insert(1, Bullet()) s.bullets[2].position >>> 2 The :class:`.OrderingList` construct only works with **changes** to a collection, and not the initial load from the database, and requires that the list be sorted when loaded. Therefore, be sure to specify ``order_by`` on the :func:`_orm.relationship` against the target ordering attribute, so that the ordering is correct when first loaded. .. warning:: :class:`.OrderingList` only provides limited functionality when a primary key column or unique column is the target of the sort. Operations that are unsupported or are problematic include: * two entries must trade values. This is not supported directly in the case of a primary key or unique constraint because it means at least one row would need to be temporarily removed first, or changed to a third, neutral value while the switch occurs. * an entry must be deleted in order to make room for a new entry. SQLAlchemy's unit of work performs all INSERTs before DELETEs within a single flush. In the case of a primary key, it will trade an INSERT/DELETE of the same primary key for an UPDATE statement in order to lessen the impact of this limitation, however this does not take place for a UNIQUE column. A future feature will allow the "DELETE before INSERT" behavior to be possible, alleviating this limitation, though this feature will require explicit configuration at the mapper level for sets of columns that are to be handled in this way. :func:`.ordering_list` takes the name of the related object's ordering attribute as an argument. By default, the zero-based integer index of the object's position in the :func:`.ordering_list` is synchronized with the ordering attribute: index 0 will get position 0, index 1 position 1, etc. To start numbering at 1 or some other integer, provide ``count_from=1``. ) annotations)Callable)List)Optional)Sequence)TypeVar) collection)collection_adapter_T ordering_listNc.t|||fdS)a1Prepares an :class:`OrderingList` factory for use in mapper definitions. Returns an object suitable for use as an argument to a Mapper relationship's ``collection_class`` option. e.g.:: from sqlalchemy.ext.orderinglist import ordering_list class Slide(Base): __tablename__ = "slide" id = Column(Integer, primary_key=True) name = Column(String) bullets = relationship( "Bullet", order_by="Bullet.position", collection_class=ordering_list("position"), ) :param attr: Name of the mapped attribute to use for storage and retrieval of ordering information :param count_from: Set up an integer-based ordering, starting at ``count_from``. For example, ``ordering_list('pos', count_from=1)`` would create a 1-based list in SQL, storing the value in the 'pos' column. Ignored if ``ordering_func`` is supplied. Additional arguments are passed to the :class:`.OrderingList` constructor. ) count_from ordering_funcreorder_on_appendctfiSN) OrderingList)attrkwsDD:\EasyAligner\venv\Lib\site-packages\sqlalchemy/ext/orderinglist.pyzordering_list..s<++)_unsugar_count_from)rrrrrs` @rr r s!P #+ B ,+rc|S)z7Numbering function: consecutive integers starting at 0.indexr s r count_from_0rs  Lrc |dzS)z7Numbering function: consecutive integers starting at 1.rrs r count_from_1r"s 19rcHfd} dz|_|S#t$rY|SwxYw)zENumbering function: consecutive integers starting at arbitrary start.c|zSrr)rr starts rfzcount_from_n_factory..fs u}rz count_from_%i)__name__ TypeError)r%r&s` rcount_from_n_factoryr)s9 $u,  H   H s  !!c |jdd}|jdd0|.|dk(r t|d<|S|dk(r t|d<|St ||d<|S)zBuilds counting functions from keyword arguments. Keyword argument filter, prepares a simple ``ordering_func`` from a ``count_from`` argument, otherwise passes ``ordering_func`` on unchanged. rNrrr!)popgetrr"r))rrs rrrsr d+J vvot$,1G ?".B  I 1_".B  I#7z"BB  IrceZdZUdZded<ded<ded< d ddZd Zd Zdd ZeZ dd Z fd Z fdZ e jde Z fdZfdZdfd ZfdZfdZfdZfdZdZeej3D]M\ZZeesejek(sejr,eees6eeeje_O[[xZS)rzA custom list that manages position information for its children. The :class:`.OrderingList` object is normally set up using the :func:`.ordering_list` factory function, used in conjunction with the :func:`_orm.relationship` function. str ordering_attr OrderingFuncrboolrc>||_|t}||_||_y)a A custom list that manages position information for its children. ``OrderingList`` is a ``collection_class`` list implementation that syncs position in a Python list with a position attribute on the mapped objects. This implementation relies on the list starting in the proper order, so be **sure** to put an ``order_by`` on your relationship. :param ordering_attr: Name of the attribute that stores the object's order in the relationship. :param ordering_func: Optional. A function that maps the position in the Python list to a value to store in the ``ordering_attr``. Values returned are usually (but need not be!) integers. An ``ordering_func`` is called with two positional parameters: the index of the element in the list, and the list itself. If omitted, Python list indexes are used for the attribute values. Two basic pre-built numbering functions are provided in this module: ``count_from_0`` and ``count_from_1``. For more exotic examples like stepped numbering, alphabetical and Fibonacci numbering, see the unit tests. :param reorder_on_append: Default False. When appending an object with an existing (non-None) ordering value, that value will be left untouched unless ``reorder_on_append`` is true. This is an optimization to avoid a variety of dangerous unexpected database writes. SQLAlchemy will add instances to the list via append() when your object loads. If for some reason the result set from the database skips a step in the ordering (say, row '1' is missing but you get '2', '3', and '4'), reorder_on_append=True would immediately renumber the items to '1', '2', '3'. If you have multiple sessions making changes, any of whom happen to load this collection even in passing, all of the sessions would try to "clean up" the numbering in their commits, possibly causing all but one to fail with a concurrent modification error. Recommend leaving this with the default of False, and just call ``reorder()`` if you're doing ``append()`` operations with previously ordered instances or when doing some housekeeping after manual sql operations. N)r/rrr)selfr/rrs r__init__zOrderingList.__init__s(n+  (M*!2rc.t||jSr)getattrr/)r3entitys r_get_order_valuezOrderingList._get_order_value>svt1122rc2t||j|yr)setattrr/)r3r7values r_set_order_valuezOrderingList._set_order_valueAs**E2rcPt|D]\}}|j||dy)zSynchronize ordering for the entire collection. Sweeps through the list and ensures that each object has accurate ordering information set. TN) enumerate _order_entity)r3rr7s rreorderzOrderingList.reorderDs('t_ME6   ufd 3-rc|j|}||sy|j||}||k7r|j||yyr)r8rr<)r3rr7r@have should_bes rr?zOrderingList._order_entityQsN$$V,  G &&ud3 9   ! !&) 4 rcvt|||jt|dz ||jy)Nr!)superappendr?lenrr3r7 __class__s rrFzOrderingList.append\s/ v 3t9q=&$2H2HIrc$t||y)z%Append without any ordering behavior.N)rErFrHs r _raw_appendzOrderingList._raw_append`s vrr!cFt||||jyr)rEinsert_reorderr3rr7rIs rrMzOrderingList.insertgs uf% rczt||t|}|r|jr|j yyyr)rEremover _referenced_by_ownerrN)r3r7adapterrIs rrQzOrderingList.removeks4 v$T* w33 MMO47rcFt||}|j|Sr)rEr+rNrOs rr+zOrderingList.poprsU#  rczt|tr|jxsd}|jxsd}|dkr|t |z }|j xs t |}|dkr|t |z }t |||D]}|j|||y|j||dt|||y)Nr!rT) isinstanceslicestepr%rGstoprange __setitem__r?rE)r3rr7rXr%rYirIs rr[zOrderingList.__setitem__ws eU #::?DKK$1EqyT"::*TDaxD !5$-  F1I..   ufd 3 G v .rcDt|||jyr)rE __delitem__rN)r3rrIs rr^zOrderingList.__delitem__s E" rcHt|||||jyr)rE __setslice__rN)r3r%endvaluesrIs rr`zOrderingList.__setslice__s UC0 rcFt||||jyr)rE __delslice__rN)r3r%rarIs rrdzOrderingList.__delslice__s UC( rcRt|j|jt|ffSr) _reconstituterI__dict__list)r3s r __reduce__zOrderingList.__reduce__s t~~t}}d4jIIIrNNF)r/z Optional[str]rOptional[OrderingFunc]rr1)returnNone)T)) r' __module__ __qualname____doc____annotations__r4r8r<r@rNr?rFrKr addsrMrQr+r[r^r`rdrirhlocalsitems func_namefunccallablehasattrr6 __classcell__)rIs@rrrs(,04"' ;3$;3.;3 ;3~334H 5J %/*//!$[1K / J  01 4 TN *LLi("43;;DL2 4rrc|j|}|jj|tj |||S)zReconstitute an :class:`.OrderingList`. This is the adjoint to :meth:`.OrderingList.__reduce__`. It is used for unpickling :class:`.OrderingList` objects. )__new__rgupdaterhextend)clsdict_ruobjs rrfrfs7 ++c CLLKKU Jrrj) rr.rz Optional[int]rrkrr1rlzCallable[[], OrderingList])rq __future__rtypingrrrrrorm.collectionsr r r intr0__all__r rr"r)rrrfrrrrsxr#(0 T]hrl+S01    !%,0# -, -,-,*-, -,  -,f   $l48l^ r