U
|
¸ý°d%Í ã @ sÊ U d Z ddlmZ ddlZddlZddlZddlmZ ddlmZ ddlmZ ddlm Z ddlm
|
Z
|
dd lm Z dd
|
lm Z dd lm Z dd lmZ dd lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlZddlmZ ddlmZ ddlmZ ddl m Z ddl m Z ddl m!Z! ejrddl"m#Z# dd l"m$Z$ dd l%m&a& dd l%m'a' dd l%m(a( dd l%m)a) dd!l*m+Z+ d"d#d$d%d&d%d&d'd(g Z,e -¡ Z.eg d)f Z/ed*ed+Z0ed,ed+Z1ed-ed+Z2ed.d/d+Z3ed0d1d+Z4G d2d3 d3e!Z5G d4d) d)e!Z6G d5d" d"Z7er6d/d6d7d8d#Z8n
|
e 9d9¡Z8G d:d6 d6Z:dxd;d<Z;d=d>d?d@dAZ<dBdC Z=dDdE Z>dFdG Z?dHdI Z@dJdK ZAdLdM ZBdydNdOZCdPdQ ZDdRdS ZEdzdTdUZFdVdWdXdYZGdVdWdZd[ZHeIeJfZKd\d\d]d^d_d`ZLd\d\d]d^dadbZMdVdWdcddZNG dedf dfe e0 ZOG dgdh dhee0 ZPG didj dje
|
e1e2f ZQe ReSeOeIePeTeQi¡ZUdkeVdl< e ReSdmdndodpeG feIdqdndodpeN feTdrdsieH fi¡ZWdteVdu< dvdw ZXeXeY dS ){aF Support for collections of mapped entities.
|
|
The collections package supplies the machinery used to inform the ORM of
|
collection membership changes. An instrumentation via decoration approach is
|
used, allowing arbitrary types (including built-ins) to be used as entity
|
collections without requiring inheritance from a base class.
|
|
Instrumentation decoration relays membership change events to the
|
:class:`.CollectionAttributeImpl` that is currently managing the collection.
|
The decorators observe function call arguments and return values, tracking
|
entities entering or leaving the collection. Two decorator approaches are
|
provided. One is a bundle of generic decorators that map function arguments
|
and return values to events::
|
|
from sqlalchemy.orm.collections import collection
|
class MyClass:
|
# ...
|
|
@collection.adds(1)
|
def store(self, item):
|
self.data.append(item)
|
|
@collection.removes_return()
|
def pop(self):
|
return self.data.pop()
|
|
|
The second approach is a bundle of targeted decorators that wrap appropriate
|
append and remove notifiers around the mutation methods present in the
|
standard Python ``list``, ``set`` and ``dict`` interfaces. These could be
|
specified in terms of generic decorator recipes, but are instead hand-tooled
|
for increased efficiency. The targeted decorators occasionally implement
|
adapter-like behavior, such as mapping bulk-set methods (``extend``,
|
``update``, ``__setslice__``, etc.) into the series of atomic mutation events
|
that the ORM requires.
|
|
The targeted decorators are used internally for automatic instrumentation of
|
entity collection classes. Every collection class goes through a
|
transformation process roughly like so:
|
|
1. If the class is a built-in, substitute a trivial sub-class
|
2. Is this class already instrumented?
|
3. Add in generic decorators
|
4. Sniff out the collection interface through duck-typing
|
5. Add targeted decoration to any undecorated interface method
|
|
This process modifies the class at runtime, decorating methods and adding some
|
bookkeeping properties. This isn't possible (or desirable) for built-in
|
classes like ``list``, so trivial sub-classes are substituted to hold
|
decoration::
|
|
class InstrumentedList(list):
|
pass
|
|
Collection classes can be specified in ``relationship(collection_class=)`` as
|
types or a function that returns an instance. Collection classes are
|
inspected and instrumented during the mapper compilation phase. The
|
collection_class callable will be executed once to produce a specimen
|
instance, and the type of that specimen will be instrumented. Functions that
|
return built-in types like ``lists`` will be adapted to produce instrumented
|
instances.
|
|
When extending a known type like ``list``, additional decorations are not
|
generally not needed. Odds are, the extension method will delegate to a
|
method that's already instrumented. For example::
|
|
class QueueIsh(list):
|
def push(self, item):
|
self.append(item)
|
def shift(self):
|
return self.pop(0)
|
|
There's no need to decorate these methods. ``append`` and ``pop`` are already
|
instrumented as part of the ``list`` interface. Decorating them would fire
|
duplicate events, which should be avoided.
|
|
The targeted decoration tries not to rely on other methods in the underlying
|
collection class, but some are unavoidable. Many depend on 'read' methods
|
being present to properly instrument a 'write', for example, ``__setitem__``
|
needs ``__getitem__``. "Bulk" methods like ``update`` and ``extend`` may also
|
reimplemented in terms of atomic appends and removes, so the ``extend``
|
decoration will actually perform many ``append`` operations and not call the
|
underlying method at all.
|
|
Tight control over bulk operation and the firing of events is also possible by
|
implementing the instrumentation internally in your methods. The basic
|
instrumentation package works under the general assumption that collection
|
mutation will not raise unusual exceptions. If you want to closely
|
orchestrate append and remove events with exception management, internal
|
instrumentation may be the answer. Within your method,
|
``collection_adapter(self)`` will retrieve an object that you can use for
|
explicit control over triggering append and remove events.
|
|
The owning object and :class:`.CollectionAttributeImpl` are also reachable
|
through the adapter, allowing for some very sophisticated behavior.
|
|
é )Ú annotationsN)ÚAny)ÚCallable)Úcast)Ú
|
Collection)ÚDict)ÚIterable)ÚList)ÚNoReturn)ÚOptional)ÚSet)ÚTuple)ÚType)Ú TYPE_CHECKING)ÚTypeVar)ÚUnioné )ÚNO_KEYé )Úexc)Úutil©ÚNO_ARG)Úinspect_getfullargspec)ÚProtocol)ÚAttributeEventToken)ÚCollectionAttributeImpl©Úattribute_keyed_dict©Úcolumn_keyed_dict©Úkeyfunc_mapping©Ú KeyFuncDict)Ú InstanceStateÚ
|
collectionÚcollection_adapterr" r r ÚMappedCollectionr$ Ú_AdaptedCollectionProtocolÚ_T)ÚboundÚ_KTÚ_VTÚ_COLzCollection[Any]Ú_FNúCallable[..., Any]c @ s e Zd ZdddddZdS )Ú _CollectionConverterProtocolr. ©r& Úreturnc C s d S ©N© )Úselfr& r5 r5 úQd:\z\workplace\vscode\pyvenv\venv\Lib\site-packages\sqlalchemy/orm/collections.pyÚ__call__ª s z%_CollectionConverterProtocol.__call__N)Ú__name__Ú
|
__module__Ú __qualname__r8 r5 r5 r5 r7 r1 © s r1 c @ s6 e Zd ZU ded< ded< ded< ded< ded < d
|
S ) r) ÚCollectionAdapterÚ _sa_adapterr0 Ú _sa_appenderÚ _sa_removerz Callable[..., Iterable[Any]]Ú _sa_iteratorr1 Ú _sa_converterN)r9 r: r; Ú__annotations__r5 r5 r5 r7 r) ® s
|
|
c @ s e Zd ZdZedd Zedd Zedd Zedd Zee
|
d
|
d ¡d d Z edd Z edd Z edd Zedd ZdS )r& au Decorators for entity collection classes.
|
|
The decorators fall into two groups: annotations and interception recipes.
|
|
The annotating decorators (appender, remover, iterator, converter,
|
internally_instrumented) indicate the method's purpose and take no
|
arguments. They are not written with parens::
|
|
@collection.appender
|
def append(self, append): ...
|
|
The recipe decorators all require parens, even those that take no
|
arguments::
|
|
@collection.adds('entity')
|
def insert(self, position, entity): ...
|
|
@collection.removes_return()
|
def popitem(self): ...
|
|
c C s
|
d| _ | S )a Tag the method as the collection appender.
|
|
The appender method is called with one positional argument: the value
|
to append. The method will be automatically decorated with 'adds(1)'
|
if not already decorated::
|
|
@collection.appender
|
def add(self, append): ...
|
|
# or, equivalently
|
@collection.appender
|
@collection.adds(1)
|
def add(self, append): ...
|
|
# for mapping type, an 'append' may kick out a previous value
|
# that occupies that slot. consider d['a'] = 'foo'- any previous
|
# value in d['a'] is discarded.
|
@collection.appender
|
@collection.replaces(1)
|
def add(self, entity):
|
key = some_key_func(entity)
|
previous = None
|
if key in self:
|
previous = self[key]
|
self[key] = entity
|
return previous
|
|
If the value to append is not allowed in the collection, you may
|
raise an exception. Something to remember is that the appender
|
will be called for each object mapped by a database query. If the
|
database contains rows that violate your collection semantics, you
|
will need to get creative to fix the problem, as access via the
|
collection will not work.
|
|
If the appender method is internally instrumented, you must also
|
receive the keyword argument '_sa_initiator' and ensure its
|
promulgation to collection events.
|
|
Úappender©Ú_sa_instrument_role©Úfnr5 r5 r7 rC Ð s )zcollection.appenderc C s
|
d| _ | S )a Tag the method as the collection remover.
|
|
The remover method is called with one positional argument: the value
|
to remove. The method will be automatically decorated with
|
:meth:`removes_return` if not already decorated::
|
|
@collection.remover
|
def zap(self, entity): ...
|
|
# or, equivalently
|
@collection.remover
|
@collection.removes_return()
|
def zap(self, ): ...
|
|
If the value to remove is not present in the collection, you may
|
raise an exception or return None to ignore the error.
|
|
If the remove method is internally instrumented, you must also
|
receive the keyword argument '_sa_initiator' and ensure its
|
promulgation to collection events.
|
|
ÚremoverrD rF r5 r5 r7 rH ü s zcollection.removerc C s
|
d| _ | S )zÿTag the method as the collection remover.
|
|
The iterator method is called with no arguments. It is expected to
|
return an iterator over all collection members::
|
|
@collection.iterator
|
def __iter__(self): ...
|
|
ÚiteratorrD rF r5 r5 r7 rI s zcollection.iteratorc C s
|
d| _ | S )aÈ Tag the method as instrumented.
|
|
This tag will prevent any decoration from being applied to the
|
method. Use this if you are orchestrating your own calls to
|
:func:`.collection_adapter` in one of the basic SQLAlchemy
|
interface methods, or to prevent an automatic ABC method
|
decoration from wrapping your implementation::
|
|
# normally an 'extend' method on a list-like class would be
|
# automatically intercepted and re-implemented in terms of
|
# SQLAlchemy events and append(). your implementation will
|
# never be called, unless:
|
@collection.internally_instrumented
|
def extend(self, items): ...
|
|
T)Ú_sa_instrumentedrF r5 r5 r7 Úinternally_instrumented% s z"collection.internally_instrumentedz1.3zçThe :meth:`.collection.converter` handler is deprecated and will be removed in a future release. Please refer to the :class:`.AttributeEvents.bulk_replace` listener interface in conjunction with the :func:`.event.listen` function.c C s
|
d| _ | S )a¡ Tag the method as the collection converter.
|
|
This optional method will be called when a collection is being
|
replaced entirely, as in::
|
|
myobj.acollection = [newvalue1, newvalue2]
|
|
The converter method will receive the object being assigned and should
|
return an iterable of values suitable for use by the ``appender``
|
method. A converter must not assign values or mutate the collection,
|
its sole job is to adapt the value the user provides into an iterable
|
of values for the ORM's use.
|
|
The default converter implementation will use duck-typing to do the
|
conversion. A dict-like collection will be convert into an iterable
|
of dictionary values, and other types will simply be iterated::
|
|
@collection.converter
|
def convert(self, other): ...
|
|
If the duck-typing of the object does not match the type of this
|
collection, a TypeError is raised.
|
|
Supply an implementation of this method if you want to expand the
|
range of possible types that can be assigned in bulk or perform
|
validation on the values about to be assigned.
|
|
Ú converterrD rF r5 r5 r7 rL : s %zcollection.converterc s fdd}|S )aÛ Mark the method as adding an entity to the collection.
|
|
Adds "add to collection" handling to the method. The decorator
|
argument indicates which method argument holds the SQLAlchemy-relevant
|
value. Arguments can be specified positionally (i.e. integer) or by
|
name::
|
|
@collection.adds(1)
|
def push(self, item): ...
|
|
@collection.adds('entity')
|
def do_stuff(self, thing, entity=None): ...
|
|
c s d f| _ | S )NÚfire_append_event©Ú_sa_instrument_beforerF ©Úargr5 r7 Ú decorators s
|
z"collection.adds.<locals>.decoratorr5 ©rQ rR r5 rP r7 Úaddsb s zcollection.addsc s fdd}|S )a Mark the method as replacing an entity in the collection.
|
|
Adds "add to collection" and "remove from collection" handling to
|
the method. The decorator argument indicates which method argument
|
holds the SQLAlchemy-relevant value to be added, and return value, if
|
any will be considered the value to remove.
|
|
Arguments can be specified positionally (i.e. integer) or by name::
|
|
@collection.replaces(2)
|
def __setitem__(self, index, item): ...
|
|
c s d f| _ d| _| S )NrM Úfire_remove_event)rO Ú_sa_instrument_afterrF rP r5 r7 rR s
|
z&collection.replaces.<locals>.decoratorr5 rS r5 rP r7 Úreplacesy s zcollection.replacesc s fdd}|S )a Mark the method as removing an entity in the collection.
|
|
Adds "remove from collection" handling to the method. The decorator
|
argument indicates which method argument holds the SQLAlchemy-relevant
|
value to be removed. Arguments can be specified positionally (i.e.
|
integer) or by name::
|
|
@collection.removes(1)
|
def zap(self, item): ...
|
|
For methods where the value to remove is not known at call-time, use
|
collection.removes_return.
|
|
c s d f| _ | S ©NrU rN rF rP r5 r7 rR ¡ s
|
z%collection.removes.<locals>.decoratorr5 rS r5 rP r7 Úremoves s zcollection.removesc C s dd } | S )aµ Mark the method as removing an entity in the collection.
|
|
Adds "remove from collection" handling to the method. The return
|
value of the method, if any, is considered the value to remove. The
|
method arguments are not inspected::
|
|
@collection.removes_return()
|
def pop(self): ...
|
|
For methods where the value to remove is known at call-time, use
|
collection.remove.
|
|
c S s
|
d| _ | S rX )rV rF r5 r5 r7 rR · s z,collection.removes_return.<locals>.decoratorr5 )rR r5 r5 r7 Úremoves_return§ s zcollection.removes_returnN)r9 r: r; Ú__doc__Ú staticmethodrC rH rI rK r Ú
|
deprecatedrL rT rW rY rZ r5 r5 r5 r7 r& ¶ s.
|
+
|
|
|
þ
|
|
|
r< r2 c C s dS )z7Fetch the :class:`.CollectionAdapter` for a collection.Nr5 )r& r5 r5 r7 r' À s r= c @ s e Zd ZU dZdZded< ded< ded< d ed
|
< d ed < d ed< d ed< dd ddddZddddZeddddZ ed dddZ
|
d d Z dOd d dd!d"d#Z d$d% Z ddd&d'Zd(dd)d*Zd dd+d,d-Zd.dd/d0d1Zd2d3 ZdPd d dd!d4d5Zd dd+d6d7ZdQd dd8d9d:Zddd;d<Zd=d> Zd?d@ ZdAdB Zd efdCdDZd efdEdFZ d efdGdHZ d efdIdJZ dKdL Z dMdN Z d S )Rr< ai Bridges between the ORM and arbitrary Python collections.
|
|
Proxies base-level collection operations (append, remove, iterate)
|
to the underlying Python collection, and emits add/remove events for
|
entities entering or leaving the collection.
|
|
The ORM uses :class:`.CollectionAdapter` exclusively for interaction with
|
entity collections.
|
|
|
)ÚattrÚ_keyÚ_dataÚ owner_stateÚ
|
_converterÚ invalidatedÚemptyr r^ Ústrr_ z)Callable[..., _AdaptedCollectionProtocol]r` zInstanceState[Any]ra r1 rb Úboolrc rd r) )r^ ra Údatac C s> || _ |j| _t |¡| _|| _| |_|j| _ d| _
|
d| _ d S )NF) r^ Úkeyr_ ÚweakrefÚrefr` ra r= rA rb rc rd )r6 r^ ra rg r5 r5 r7 Ú__init__é s zCollectionAdapter.__init__ÚNone©r3 c C s t d¡ d S )Nz%This collection has been invalidated.)r Úwarn©r6 r5 r5 r7 Ú_warn_invalidatedÿ s z#CollectionAdapter._warn_invalidatedc C s | ¡ S )z$The entity collection being adapted.)r` ro r5 r5 r7 rg s zCollectionAdapter.datac C s | j j| j | ¡ kS )zÃreturn True if the owner state still refers to this collection.
|
|
This will return False within a bulk replace operation,
|
where this collection is the one being replaced.
|
|
)ra Údictr_ r` ro r5 r5 r7 Ú_referenced_by_owner s z&CollectionAdapter._referenced_by_ownerc C s
|
| ¡ jS r4 ©r` r> ro r5 r5 r7 Ú bulk_appender s z CollectionAdapter.bulk_appenderNr z Optional[AttributeEventToken])ÚitemÚ initiatorr3 c C s | ¡ j||d dS )z8Add an entity to the collection, firing mutation events.©Ú _sa_initiatorNrs ©r6 ru rv r5 r5 r7 Úappend_with_event s z#CollectionAdapter.append_with_eventc C s& | j rtdd| _ || jj| j< d S )Nz7This collection adapter is already in the 'empty' stateT)rd ÚAssertionErrorra Ú_empty_collectionsr_ )r6 Ú user_datar5 r5 r7 Ú
|
_set_empty s ÿþz CollectionAdapter._set_emptyc C s2 | j stdd| _ | jj | j¡| jj| j< d S )Nz3This collection adapter is not in the 'empty' stateF)rd r{ ra r| Úpopr_ rq ro r5 r5 r7 Ú _reset_empty" s ÿþþÿz CollectionAdapter._reset_emptyr
|
c C s t d¡d S )NzZThis is a special 'empty' collection which cannot accommodate internal mutation operations)Úsa_excZInvalidRequestErrorro r5 r5 r7 Ú _refuse_empty+ s ÿz CollectionAdapter._refuse_empty)ru r3 c C s$ | j r| ¡ | ¡ j|dd dS ©z=Add or restore an entity to the collection, firing no events.Frw N©rd r r` r> ©r6 ru r5 r5 r7 Úappend_without_event1 s z&CollectionAdapter.append_without_eventz Iterable[Any])Úitemsr3 c C s2 | j r| ¡ | ¡ j}|D ]}||dd q dS r r )r6 r rC ru r5 r5 r7 Ú append_multiple_without_event8 s
|
|
z/CollectionAdapter.append_multiple_without_eventc C s
|
| ¡ jS r4 ©r` r? ro r5 r5 r7 Ú bulk_remover@ s z CollectionAdapter.bulk_removerc C s | ¡ j||d dS )z=Remove an entity from the collection, firing mutation events.rw Nr ry r5 r5 r7 Úremove_with_eventC s z#CollectionAdapter.remove_with_eventc C s$ | j r| ¡ | ¡ j|dd dS )z7Remove an entity from the collection, firing no events.Frw N)rd r r` r? r
r5 r5 r7 Úremove_without_eventI s z&CollectionAdapter.remove_without_event)rv r3 c C s6 | j r| ¡ | ¡ j}t| D ]}|||d q dS )z>Empty the collection, firing a mutation event for each entity.rw N©rd r r` r? Úlist)r6 rv rH ru r5 r5 r7 Úclear_with_eventO s
|
|
z"CollectionAdapter.clear_with_eventc C s6 | j r| ¡ | ¡ j}t| D ]}||dd q dS )z'Empty the collection, firing no events.Frw Nr )r6 rH ru r5 r5 r7 Úclear_without_eventZ s
|
|
z%CollectionAdapter.clear_without_eventc C s t | ¡ ¡ S )z(Iterate over entities in the collection.)Úiterr` r@ ro r5 r5 r7 Ú__iter__c s zCollectionAdapter.__iter__c C s t t| ¡ ¡ S )z!Count entities in the collection.)Úlenr r` r@ ro r5 r5 r7 Ú__len__h s zCollectionAdapter.__len__c C s dS ©NTr5 ro r5 r5 r7 Ú__bool__l s zCollectionAdapter.__bool__c C sF |dk r>| j r| ¡ | jr$| ¡ | j | j| jj|||¡S |S dS )ab Notify that a entity is entering the collection but is already
|
present.
|
|
|
Initiator is a token owned by the InstrumentedAttribute that
|
initiated the membership mutation, and should be left as None
|
unless you are passing along an initiator value from a chained
|
operation.
|
|
.. versionadded:: 1.4.15
|
|
FN)rc rp rd r r^ Ú fire_append_wo_mutation_eventra rq ©r6 ru rv rh r5 r5 r7 r o s ÿz/CollectionAdapter.fire_append_wo_mutation_eventc C sF |dk r>| j r| ¡ | jr$| ¡ | j | j| jj|||¡S |S dS )a Notify that a entity has entered the collection.
|
|
Initiator is a token owned by the InstrumentedAttribute that
|
initiated the membership mutation, and should be left as None
|
unless you are passing along an initiator value from a chained
|
operation.
|
|
FN)rc rp rd r r^ rM ra rq r r5 r5 r7 rM s ÿz#CollectionAdapter.fire_append_eventc C sB |dk r>| j r| ¡ | jr$| ¡ | j | j| jj|||¡ dS )a Notify that a entity has been removed from the collection.
|
|
Initiator is the InstrumentedAttribute that initiated the membership
|
mutation, and should be left as None unless you are passing along
|
an initiator value from a chained operation.
|
|
FN)rc rp rd r r^ rU ra rq r r5 r5 r7 rU s ÿz#CollectionAdapter.fire_remove_eventc C s, | j r| ¡ | jj| j| jj||d dS )z«Notify that an entity is about to be removed from the collection.
|
|
Only called if the entity cannot be removed after calling
|
fire_remove_event().
|
|
)rv rh N)rc rp r^ Úfire_pre_remove_eventra rq )r6 rv rh r5 r5 r7 r ² s üz'CollectionAdapter.fire_pre_remove_eventc C s | j | j| jj| j| j| jdS )N)rh ra Ú owner_clsrg rc rd )r_ ra Úclass_rg rc rd ro r5 r5 r7 Ú __getstate__Â s úz CollectionAdapter.__getstate__c C sj |d | _ |d | _t |d ¡| _|d j| _| |d _|d | _t |d | j j
|
| _ | dd¡| _ d S )Nrh ra rg rc r rd F)r_ ra ri rj r` rA rb r= rc ÚgetattrÚimplr^ Úgetrd )r6 Údr5 r5 r7 Ú __setstate__Ì s
|
|
|
|
z CollectionAdapter.__setstate__)N)N)N)!r9 r: r; r[ Ú __slots__rB rk rp Úpropertyrg rr rt rz r~ r r r r r r r r r r r r r r rM rU r r r¡ r5 r5 r5 r7 r< Ç sN
|
|
ÿ ÿ ÿ
|
c C sª t | tsttj}||p d}| | p*d¡}|| p6d |¡}| |¡}| ¡ } | pXdD ].}
|
|
|
|krt| |
|
|d qZ|
|
|krZ| |
|
dd qZ|r¦|D ]}
|
|j|
|
|d qdS )aF Load a new collection, firing events based on prior like membership.
|
|
Appends instances in ``values`` onto the ``new_adapter``. Events will be
|
fired for any instance not present in the ``existing_adapter``. Any
|
instances in ``existing_adapter`` not present in ``values`` will have
|
remove events fired upon them.
|
|
:param values: An iterable of collection member instances
|
|
:param existing_adapter: A :class:`.CollectionAdapter` of
|
instances to be replaced
|
|
:param new_adapter: An empty :class:`.CollectionAdapter`
|
to load with ``values``
|
|
|
r5 rw F)rv N) Ú
|
isinstancer r{ r Z IdentitySetÚ intersectionÚ
|
differencert rU ) ÚvaluesZexisting_adapterZ new_adapterrv ZidsetZexisting_idsetÚ constantsZ additionsZremovalsrC Úmemberr5 r5 r7 Ú bulk_replaceÚ s
|
rª z4Union[Type[Collection[Any]], _CollectionFactoryType]Ú_CollectionFactoryType)Úfactoryr3 c C sx | t krt | }n
|
tt| }t| }|t kr@t | }t| }t ¡ rtz t|ddt|krft | W 5 t ¡ X |S )ao Prepare a callable for future use as a collection class factory.
|
|
Given a collection class factory (either a type or no-arg callable),
|
return another factory that will produce compatible instances when
|
called.
|
|
This function is responsible for converting collection_class=list
|
into the run-time behavior of collection_class=InstrumentedList.
|
|
rJ N)
|
Ú__canned_instrumentationr r« ÚtypeÚ__instrumentation_mutexÚacquireÚreleaser ÚidÚ_instrument_class)r¬ Z impl_factoryÚclsr5 r5 r7 Úprepare_instrumentation s
|
|
|
|
|
rµ c C sH | j dkrt d¡t| \}}t| || t| || t| || dS )z6Modify methods in a class and install instrumentation.Ú __builtin__zGCan not instrument a built-in type. Use a subclass, even a trivial one.N)r: r Ú ArgumentErrorÚ_locate_roles_and_methodsÚ_setup_canned_rolesÚ_assert_required_rolesÚ_set_collection_attributes©r´ ÚrolesÚmethodsr5 r5 r7 r³ 3 s
|
ÿ r³ c C sÚ i }i }| j D ]Â}t| ¡ D ]°\}}t|s0q t|drX|j}|dksLt| ||¡ d}d}t|dr|j\} }
|
| dkst| |
|
f}t|dr¨|j } | dks¤t| }|r¼||f ||< q |r dd|f||< q q||fS )zgsearch for _sa_instrument_role-decorated methods in
|
method resolution order, assign to roles.
|
|
rE )rC rH rI rL NrO )rM rU rV )
|
Ú__mro__Úvarsr ÚcallableÚhasattrrE r{ Ú
|
setdefaultrO rV ) r´ r½ r¾ ZsuperclsÚnameÚmethodÚroleÚbeforeÚafterÚopÚargumentr5 r5 r7 r¸ H s2
|
|
|
|
|
r¸ c C s t | ¡}|tkr|dk s tt| \}}| ¡ D ]\}}| ||¡ q2| ¡ D ]:\}} t| |d}
|
|
|
rP||krPt|
|
dsPt| || |
|
qPdS )zÇsee if this class has "canned" roles based on a known
|
collection type (dict, set, list). Apply those roles
|
as needed to the "roles" dictionary, and also
|
prepare "decorator" methods
|
|
NrJ ) r Úduck_type_collectionÚ __interfacesr{ r rà r r Úsetattr) r´ r½ r¾ Zcollection_typeZ canned_rolesZ
|
decoratorsrÆ rÄ rÅ rR rG r5 r5 r7 r¹ u s
|
ÿþýr¹ c C sÒ d|kst | |d s(t d| j ¡n,|d |krTt t| |d dsTd||d < d|ksjt | |d s|t d| j ¡n,|d |kr¨t t| |d ds¨d||d < d|ks¾t | |d sÎt d | j ¡d
|
S ) zTensure all roles are present, and apply implicit instrumentation if
|
needed
|
|
rC z>Type %s must elect an appender method to be a collection classrJ )rM r NrH z<Type %s must elect a remover method to be a collection class)rU r NrI z>Type %s must elect an iterator method to be a collection classN)r r r· r9 r r¼ r5 r5 r7 rº s8 ÿÿ ÿ ÿÿ ÿ ÿÿrº c C s | ¡ D ]*\}\}}}t| |tt| |||| q| ¡ D ] \}}t| d| t| | q<d| _t| dsrd| _t| | _dS )zkapply ad-hoc instrumentation from decorators, class-level defaults
|
and implicit role declarations
|
|
z_sa_%sNrA ) r rÍ Ú _instrument_membership_mutatorr r= r rA r² rJ )r´ r½ r¾ Ú method_namerÇ rÊ rÈ rÆ r5 r5 r7 r» ® s" ÿý
|
r» c s¢ r`t t td ¡}ttrBt|kr<| p>dn |krV| ¡nd~ fdd}d|_t drj
|
|_
|
j |_ j |_ |S )zIRoute method args and/or return value through the collection
|
adapter.r Nc sÚ rbd kr,|kr"t d ¡| }n6t| krB| }n |krT| }nt d ¡| dd ¡}|dkr|d }n
|
| d j}r|rt||| r¦|s°| |S | |}|d k rÒt| || |S d S )NzMissing argument %srx Fr )r r· r r r= r )ÚargsÚkwÚvaluerv ÚexecutorÚres©rÈ rÊ rÇ rÅ Z named_argZpos_argr5 r7 ÚwrapperÙ s4 ÿ
|
|
|
ÿ
|
|
|
z/_instrument_membership_mutator.<locals>.wrapperTrE ) r r Zflatten_iteratorr r¤ Úintr ÚindexrJ r rE r9 r[ )rÅ rÇ rÊ rÈ Zfn_argsrÖ r5 rÕ r7 rÎ Æ s& ÿ
|
#
|
rÎ c C s& |dk r"| j }|r"|j||dd dS )zERun set wo mutation events.
|
|
The collection is not mutated.
|
|
FN©rh )r= r )r& ru rx rÓ r5 r5 r7 Ú__set_wo_mutation s ÿrÚ c C s& |dk r"| j }|r"|j|||d}|S )z^Run set events.
|
|
This event always occurs before the collection is actually mutated.
|
|
FrÙ )r= rM ©r& ru rx rh rÓ r5 r5 r7 Ú__set s
|
rÜ c C s& |dk r"| j }|r"|j|||d dS )a Run del events.
|
|
This event occurs before the collection is actually mutated, *except*
|
in the case of a pop operation, in which case it occurs afterwards.
|
For pop operations, the __before_pop hook is called before the
|
operation occurs.
|
|
FrÙ N)r= rU rÛ r5 r5 r7 Ú__del s rÝ c C s | j }|r| |¡ dS )z;An event which occurs on a before a pop() operation occurs.N)r= r )r& rx rÓ r5 r5 r7 Ú __before_pop/ s rÞ z Dict[str, Callable[[_FN], _FN]]rm c
|
s dd fdd} fdd} fdd} fd d
|
} fd d } fd d} fdd} fdd} fdd}t ¡ } | d¡ | S )z:Tailored instrumentation wrappers for any list-like class.c S s d| _ tt| jj| _d S r )rJ r r r9 r[ rF r5 r5 r7 Ú_tidy9 s z _list_decorators.<locals>._tidyc s d fdd }| |S )Nc s t | ||t} | | d S r4 )rÜ r )r6 ru rx rF r5 r7 Úappend> s z0_list_decorators.<locals>.append.<locals>.append)Nr5 )rG rà ©rß rF r7 rà = s z _list_decorators.<locals>.appendc s d fdd }| |S )Nc s t | ||t | | d S r4 ©rÝ r ©r6 rÒ rx rF r5 r7 ÚremoveF s z0_list_decorators.<locals>.remove.<locals>.remove)Nr5 ©rG rä rá rF r7 rä E s z _list_decorators.<locals>.removec s fdd}| |S )Nc s t | |d |} | || d S r4 )rÜ )r6 rØ rÒ rF r5 r7 ÚinsertO s z0_list_decorators.<locals>.insert.<locals>.insertr5 )rG ræ rá rF r7 ræ N s z _list_decorators.<locals>.insertc s fdd}| |S )Nc
|
sX t |tsF| | }|d k r(t| |d | t| |d |} | || n|jpNd}|jpXd}|dk rn|t| 7 }|jd k r|j}nt| }|dk r|t| 7 }|dkrø|| kr°d S t|||D ]}t| |kr¼| |= q¼t |D ]\}}|
|
|| |¡ qÜn\t t|||} t|t| kr2t dt|t| f t | |D ]\}}| ||¡ q<d S )Nr r zBattempt to assign sequence of size %s to extended slice of size %s)r¤ ÚslicerÝ rÜ ÚstepÚstartr ÚstopÚrangeÚ enumerateræ r Ú
|
ValueErrorÚzipÚ __setitem__)
|
r6 rØ rÒ Úexistingrè ré rê Úiru ÚrngrF r5 r7 rï W s@
|
|
|
|
þÿz:_list_decorators.<locals>.__setitem__.<locals>.__setitem__r5 ©rG rï rá rF r7 rï V s (z%_list_decorators.<locals>.__setitem__c s fdd}| |S )Nc sV t |ts,| | }t| |d | | | n&| | D ]}t| |d | q4 | | d S r4 )r¤ rç rÝ ©r6 rØ ru rF r5 r7 Ú __delitem__ s
|
z:_list_decorators.<locals>.__delitem__.<locals>.__delitem__r5 ©rG rõ rá rF r7 rõ s z%_list_decorators.<locals>.__delitem__c s dd } | |S )Nc S s t |D ]}| |¡ qd S r4 ©r rà ©r6 ÚiterablerÒ r5 r5 r7 Úextend s z0_list_decorators.<locals>.extend.<locals>.extendr5 )rG rú rá r5 r7 rú s z _list_decorators.<locals>.extendc s dd } | |S )Nc S s t |D ]}| |¡ q| S r4 r÷ rø r5 r5 r7 Ú__iadd__ s z4_list_decorators.<locals>.__iadd__.<locals>.__iadd__r5 )rG rû rá r5 r7 rû s z"_list_decorators.<locals>.__iadd__c s d fdd }| |S )Néÿÿÿÿc s$ t | | |}t| |d | |S r4 ©rÞ rÝ rô rF r5 r7 r § s
|
z*_list_decorators.<locals>.pop.<locals>.pop)rü r5 ©rG r rá rF r7 r ¦ s z _list_decorators.<locals>.popc s d fdd }| |S )Nrü c s$ | D ]}t | |d | q | d S r4 ©rÝ rô rF r5 r7 Úclear± s z._list_decorators.<locals>.clear.<locals>.clear)rü r5 ©rG r rá rF r7 r ° s z _list_decorators.<locals>.clearrß ©ÚlocalsÚcopyr )
|
rà rä ræ rï rõ rú rû r r Úlr5 rá r7 Ú_list_decorators6 s ,
|
|
|
r c st dd fdd} fdd} fdd} fd d
|
} fd d } fd d} fdd}t ¡ }| d¡ |S )zBTailored instrumentation wrappers for any dict-like mapping class.c S s d| _ tt| jj| _d S r )rJ r rq r9 r[ rF r5 r5 r7 rß Æ s z _dict_decorators.<locals>._tidyc s d fdd }| |S )Nc s8 || krt | | | || t| |||} | || d S r4 )rÝ rÜ )r6 rh rÒ rx rF r5 r7 rï Ë s z:_dict_decorators.<locals>.__setitem__.<locals>.__setitem__)Nr5 ró rá rF r7 rï Ê s z%_dict_decorators.<locals>.__setitem__c s d fdd }| |S )Nc s( || krt | | | || | | d S r4 rÿ )r6 rh rx rF r5 r7 rõ Õ s z:_dict_decorators.<locals>.__delitem__.<locals>.__delitem__)Nr5 rö rá rF r7 rõ Ô s z%_dict_decorators.<locals>.__delitem__c s fdd}| |S )Nc s( | D ]}t | | | d | q | d S r4 rÿ )r6 rh rF r5 r7 r Þ s z._dict_decorators.<locals>.clear.<locals>.clearr5 r rá rF r7 r Ý s z _dict_decorators.<locals>.clearc s t f fdd }| |S )Nc sF t | || k}|tkr$ | |}n | ||}|rBt| |d | |S r4 )rÞ r rÝ )r6 rh ÚdefaultZ_to_delru rF r5 r7 r ç s z*_dict_decorators.<locals>.pop.<locals>.popr rþ rá rF r7 r æ s z _dict_decorators.<locals>.popc s fdd}| |S )Nc s& t | | }t| |d d d |S )Nr rý r
rF r5 r7 Úpopitemö s z2_dict_decorators.<locals>.popitem.<locals>.popitemr5 )rG r rá rF r7 r õ s z!_dict_decorators.<locals>.popitemc s ddd} | |S )Nc S s> || kr| ||¡ |S | |¡}||kr6t| |d |S d S r4 )rï Ú __getitem__rÚ )r6 rh r rÒ r5 r5 r7 rà s
|
z8_dict_decorators.<locals>.setdefault.<locals>.setdefault)Nr5 )rG rà rá r5 r7 rà ÿ s
|
z$_dict_decorators.<locals>.setdefaultc s t fdd} | |S )Nc [ sÔ |t k rt|drXt|D ]:}|| ks6| | || k rD|| | |< qt| || d qn8|D ]2\}}|| ksx| | |k r|| |< q\t| |d q\|D ]:}|| ks°| | || k r¾|| | |< qt| || d qd S )NÚkeys)r r r rÚ )r6 Z__otherrÑ rh rÒ r5 r5 r7 Úupdate s
|
|
z0_dict_decorators.<locals>.update.<locals>.updater ©rG r rá r5 r7 r s z _dict_decorators.<locals>.updaterß r )rï rõ r r r rà r r r5 rá r7 Ú_dict_decoratorsà s
|
|
|
|
r r rf )r6 Úobjr3 c C s t |t| jf S )zKAllow only set, frozenset and self.__class__-derived
|
objects in binops.)r¤ Ú_set_binop_basesÚ __class__©r6 r r5 r5 r7 Ú_set_binops_check_strict. s r c C s t |t| jf p t |¡tkS )z5Allow anything set-like to participate in set binops.)r¤ r r r rË Úsetr r5 r5 r7 Ú_set_binops_check_loose4 s þr c s¼ dd fdd} fdd} fdd} fd d
|
} fd d } fd d} fdd} fdd} fdd} fdd} fdd}
|
fdd} fdd } t ¡ } | d ¡ | S ) z9Tailored instrumentation wrappers for any set-like class.c S s d| _ tt| jj| _d S r )rJ r r r9 r[ rF r5 r5 r7 rß ? s z _set_decorators.<locals>._tidyc s d fdd }| |S )Nc s2 || krt | ||t}n t| || | | d S r4 )rÜ r rÚ rã rF r5 r7 ÚaddD s z)_set_decorators.<locals>.add.<locals>.add)Nr5 )rG r rá rF r7 r C s z _set_decorators.<locals>.addc s d fdd }| |S )Nc s$ || krt | ||t | | d S r4 râ rã rF r5 r7 ÚdiscardP s z1_set_decorators.<locals>.discard.<locals>.discard)Nr5 )rG r rá rF r7 r O s z _set_decorators.<locals>.discardc s d fdd }| |S )Nc s$ || krt | ||t | | d S r4 râ rã rF r5 r7 rä [ s z/_set_decorators.<locals>.remove.<locals>.remove)Nr5 rå rá rF r7 rä Z s z _set_decorators.<locals>.removec s fdd}| |S )Nc s" t | | }t| |d t |S r4 )rÞ rÝ r r
rF r5 r7 r f s z)_set_decorators.<locals>.pop.<locals>.popr5 rþ rá rF r7 r e s z _set_decorators.<locals>.popc s dd } | |S )Nc S s t | D ]}| |¡ qd S r4 )r rä r
r5 r5 r7 r r s z-_set_decorators.<locals>.clear.<locals>.clearr5 r rá r5 r7 r q s z _set_decorators.<locals>.clearc s dd } | |S )Nc S s |D ]}| |¡ qd S r4 )r ©r6 rÒ ru r5 r5 r7 r z s z/_set_decorators.<locals>.update.<locals>.updater5 r rá r5 r7 r y s z _set_decorators.<locals>.updatec s dd } | |S )Nc S s& t | |stS |D ]}| |¡ q| S r4 )r ÚNotImplementedr r r5 r5 r7 Ú__ior__ s
|
|
z1_set_decorators.<locals>.__ior__.<locals>.__ior__r5 )rG r rá r5 r7 r s z _set_decorators.<locals>.__ior__c s dd } | |S )Nc S s |D ]}| |¡ qd S r4 )r r r5 r5 r7 Údifference_update s zE_set_decorators.<locals>.difference_update.<locals>.difference_updater5 )rG r rá r5 r7 r s z*_set_decorators.<locals>.difference_updatec s dd } | |S )Nc S s& t | |stS |D ]}| |¡ q| S r4 )r r r r r5 r5 r7 Ú__isub__ s
|
|
z3_set_decorators.<locals>.__isub__.<locals>.__isub__r5 )rG r rá r5 r7 r s z!_set_decorators.<locals>.__isub__c s dd } | |S )Nc S sR | |¡t| }}|| || }}|D ]}| |¡ q*|D ]}| |¡ q>d S r4 )r¥ r rä r ©r6 ÚotherZwantZhaverä r ru r5 r5 r7 Úintersection_update s zI_set_decorators.<locals>.intersection_update.<locals>.intersection_updater5 )rG r rá r5 r7 r s z,_set_decorators.<locals>.intersection_updatec s dd } | |S )Nc S s` t | |stS | |¡t| }}|| || }}|D ]}| |¡ q8|D ]}| |¡ qL| S r4 )r r r¥ r rä r r r5 r5 r7 Ú__iand__ s
|
z3_set_decorators.<locals>.__iand__.<locals>.__iand__r5 )rG r rá r5 r7 r ¬ s z!_set_decorators.<locals>.__iand__c s dd } | |S )Nc S sR | |¡t| }}|| || }}|D ]}| |¡ q*|D ]}| |¡ q>d S r4 )Úsymmetric_differencer rä r r r5 r5 r7 Úsymmetric_difference_update½ s zY_set_decorators.<locals>.symmetric_difference_update.<locals>.symmetric_difference_updater5 )rG r! rá r5 r7 r! ¼ s z4_set_decorators.<locals>.symmetric_difference_updatec s dd } | |S )Nc S s` t | |stS | |¡t| }}|| || }}|D ]}| |¡ q8|D ]}| |¡ qL| S r4 )r r r r rä r r r5 r5 r7 Ú__ixor__Ê s
|
z3_set_decorators.<locals>.__ixor__.<locals>.__ixor__r5 )rG r" rá r5 r7 r" É s z!_set_decorators.<locals>.__ixor__rß r )r r rä r r r r r r r r r! r" r r5 rá r7 Ú_set_decorators< s"
|
|
r# c @ s e Zd ZdZdS )ÚInstrumentedListz-An instrumented version of the built-in list.N©r9 r: r; r[ r5 r5 r5 r7 r$ Þ s r$ c @ s e Zd ZdZdS )ÚInstrumentedSetz,An instrumented version of the built-in set.Nr% r5 r5 r5 r7 r& â s r& c @ s e Zd ZdZdS )ÚInstrumentedDictz-An instrumented version of the built-in dict.Nr% r5 r5 r5 r7 r' æ s r' z/util.immutabledict[Any, _CollectionFactoryType]r rà rä r )rC rH rI r rI r§ zMutil.immutabledict[Any, Tuple[Dict[str, str], Dict[str, Callable[..., Any]]]]rÌ c C s| ddl ma ddl ma ddl ma ddl ma ddl m a ddl ma ddl ma dd l ma tt tt
|
tt d S )
|
Nr r! r r r# )Úmapped_collection)Úcolumn_mapped_collection)Úattribute_mapped_collection)r( ) r( r" r r r$ r) r* r( r³ r$ r& )Zlclsr5 r5 r7 Ú__go s r+ )N)N)N)Zr[ Ú
|
__future__r ÚoperatorÚ threadingÚtypingr r r r r r r r
|
r r r r r r r ri Úbaser Ú r r r Zsql.baser Z util.compatr Z util.typingr Ú
|
attributesr r r( r r r" r$ Ústater% Ú__all__ÚLockr¯ r« r* r, r- r. r/ r1 r) r& r' Ú
|
attrgetterr< rª rµ r³ r¸ r¹ rº r» rÎ rÚ rÜ rÝ rÞ r r r Ú frozensetr r r r# r$ r& r' Z immutabledictr rq r rB rÌ r+ r r5 r5 r5 r7 Ú<module> sä a ÷
|
|
|
(1- >
|
|
h # ýÿþ
|
ýú
|
þ òÿú
|
|
