Of'dZddlZddlZddlmZddlmZddlmZddlmZddlm Z ddlm Z dd l m Z d d gZ Gd d ZeZe GddZe GddeZGddZGddeeZee Gdd eZGddeeZee Gdd eZdZdZdZdZdS)zAdapter management N Interface) implementer providedBy)ro)_normalize_name) _use_c_impl)IAdapterRegistryAdapterRegistryVerifyingAdapterRegistryceZdZdZdZdZddZdZeddZ d Z e Z e ZeZeZd Zd Zd Zd ZdZddZeddZdZdZddZdZdZdZddZ dZ!dZ"dS)BaseAdapterRegistrya A basic implementation of the data storage and algorithms required for a :class:`zope.interface.interfaces.IAdapterRegistry`. Subclasses can set the following attributes to control how the data is stored; in particular, these hooks can be helpful for ZODB persistence. They can be class attributes that are the named (or similar) type, or they can be methods that act as a constructor for an object that behaves like the types defined here; this object will not assume that they are type objects, but subclasses are free to do so: _sequenceType = list This is the type used for our two mutable top-level "byorder" sequences. Must support mutation operations like ``append()`` and ``del seq[index]``. These are usually small (< 10). Although at least one of them is accessed when performing lookups or queries on this object, the other is untouched. In many common scenarios, both are only required when mutating registrations and subscriptions (like what :meth:`zope.interface.interfaces.IComponents.registerUtility` does). This use pattern makes it an ideal candidate to be a :class:`~persistent.list.PersistentList`. _leafSequenceType = tuple This is the type used for the leaf sequences of subscribers. It could be set to a ``PersistentList`` to avoid many unnecessary data loads when subscribers aren't being used. Mutation operations are directed through :meth:`_addValueToLeaf` and :meth:`_removeValueFromLeaf`; if you use a mutable type, you'll need to override those. _mappingType = dict This is the mutable mapping type used for the keyed mappings. A :class:`~persistent.mapping.PersistentMapping` could be used to help reduce the number of data loads when the registry is large and parts of it are rarely used. Further reductions in data loads can come from using a :class:`~BTrees.OOBTree.OOBTree`, but care is required to be sure that all required/provided values are fully ordered (e.g., no required or provided values that are classes can be used). _providedType = dict This is the mutable mapping type used for the ``_provided`` mapping. This is separate from the generic mapping type because the values are always integers, so one might choose to use a more optimized data structure such as a :class:`~BTrees.OIBTree.OIBTree`. The same caveats regarding key types apply as for ``_mappingType``. It is possible to also set these on an instance, but because of the need to potentially also override :meth:`_addValueToLeaf` and :meth:`_removeValueFromLeaf`, this may be less useful in a persistent scenario; using a subclass is recommended. .. versionchanged:: 5.3.0 Add support for customizing the way internal data structures are created. .. versionchanged:: 5.3.0 Add methods :meth:`rebuild`, :meth:`allRegistrations` and :meth:`allSubscriptions`. ) lookupqueryMultiAdapterlookup1 queryAdapter adapter_hook lookupAllnames subscriptions subscribersrc||_||_||_|||_dSN) _sequenceType _adapters _subscribers _providedType _provided _createLookup __bases__selfbasess H/var/www/html/env/lib/python3.11/site-packages/zope/interface/adapter.py__init__zBaseAdapterRegistry.__init__sc++--!..00++--  cv||jd<tj||_||dS)z If subclasses need to track when ``__bases__`` changes, they can override this method. Subclasses must still call this method. r"N)__dict__rchangedr#s r& _setBaseszBaseAdapterRegistry._setBasess7&+ k"%++ Tr(c|jdS)Nr")r*r$s r&zBaseAdapterRegistry.s dmK&@r(c,||Sr)r,r#s r&r/zBaseAdapterRegistry.sT^^E-B-Br(c|||_|jD]}t|j||j|< dSr) LookupClass _v_lookup _delegatedgetattrr*)r$names r&r!z!BaseAdapterRegistry._createLookupsQ))$//O @ @D")$.$"?"?DM$   @ @r(c||fS||fzS)a) Add the value *new_item* to the *existing_leaf_sequence*, which may be ``None``. Subclasses that redefine `_leafSequenceType` should override this method. :param existing_leaf_sequence: If *existing_leaf_sequence* is not *None*, it will be an instance of `_leafSequenceType`. (Unless the object has been unpickled from an old pickle and the class definition has changed, in which case it may be an instance of a previous definition, commonly a `tuple`.) :return: This method returns the new value to be stored. It may mutate the sequence in place if it was not ``None`` and the type is mutable, but it must also return it. .. versionadded:: 5.3.0 r)r$existing_leaf_sequencenew_items r&_addValueToLeafz#BaseAdapterRegistry._addValueToLeafs, " ); % 33r(c:tfd|DS)aa Remove the item *to_remove* from the (non-``None``, non-empty) *existing_leaf_sequence* and return the mutated sequence. If there is more than one item that is equal to *to_remove* they must all be removed. Subclasses that redefine `_leafSequenceType` should override this method. Note that they can call this method to help in their implementation; this implementation will always return a new tuple constructed by iterating across the *existing_leaf_sequence* and omitting items equal to *to_remove*. :param existing_leaf_sequence: As for `_addValueToLeaf`, probably an instance of `_leafSequenceType` but possibly an older type; never `None`. :return: A version of *existing_leaf_sequence* with all items equal to *to_remove* removed. Must not return `None`. However, returning an empty object, even of another type such as the empty tuple, ``()`` is explicitly allowed; such an object will never be stored. .. versionadded:: 5.3.0 c g|] }|k| Srr).0v to_removes r& z.sJJJA1 >>a>>>r()tuple)r$r8r?s `r&_removeValueFromLeafz(BaseAdapterRegistry._removeValueFromLeafs)4JJJJ!7JJJKKKr(cZ|xjdz c_|j|dSN) _generationr3r+r$originally_changeds r&r+zBaseAdapterRegistry.changed s3 A 122222r(ct|tstd||||||dSt d|D}t |}t |}|j}t ||kr:|| t ||k:||}||fz}|D]4} | | } | | } | || <| }5| ||urdS|||<|j |ddz} | |j |<| dkr|j |||dS)Nname is not a stringc,g|]}t|Sr_convert_None_to_Interfacer=rs r&r@z0BaseAdapterRegistry.register..!JJJA4Q77JJJr(rrE) isinstancestr ValueError unregisterrAr lenrappend _mappingTypegetr r3 add_extendorr+) r$requiredprovidedr6valueorderbyorder componentskeykdns r&registerzBaseAdapterRegistry.registers$$$ 5344 4 = OOHhe < < < FJJJJJKKt$$H .'lle## NN4,,.. / / /'lle##U^ ($  Aq!!Ay%%'' ! 1 JJ >>$  5 ( ( F 4 N  x + +a /#$x 66 N ' ' 1 1 1 Tr(ctd|D}t|}t||krdS||}||fz}|D]}||} | dS| }||S)Nc,g|]}t|SrrLrNs r&r@z2BaseAdapterRegistry._find_leaf..7rPr()rArUrX) r$r^rZr[r6r]r_r`rarbs r& _find_leafzBaseAdapterRegistry._find_leaf1s JJJJJKKH  w<<5 4U^ ($  Aq!!AyttJJ~~d###r(cV||j||t|Sr)rgrr )r$rZr[r6s r& registeredzBaseAdapterRegistry.registeredGs. N   D ! !    r(c#K|dkr&|D]\}}||fz|fVdS|D]+\}}||fz}|||dz |Ed{V,dS)NrrE)items_allKeys)clsr_iparent_krar> new_parent_ks r&rmzBaseAdapterRegistry._allKeysOs 66"((** ) )1!oq((((( ) )#((** @ @1'1$ <<1q5,?????????? @ @r(c#Kt|D]^\}}|||dzD]?\}}t||dzksJ|d|}|d}|d}||||fV@_dS)NrE) enumeratermrU) r$r^ror_r`r\rZr[r6s r& _all_entriesz BaseAdapterRegistry._all_entriesYs'w// 8 8MAz#mmJA>> 8 8 U3xx1q5((((rr7r72w477777  8 8 8r(c#JK||jEd{VdS)aT Yields tuples ``(required, provided, name, value)`` for all the registrations that this object holds. These tuples could be passed as the arguments to the :meth:`register` method on another adapter registry to duplicate the registrations this object holds. .. versionadded:: 5.3.0 N)rwrr.s r&allRegistrationsz$BaseAdapterRegistry.allRegistrationsks6$$T^44444444444r(Nctd|D}t|}|j}|t|krdS||}||fz}g} |D]5} || } | dS| || f| }6||} | dS|| |urdS||=|s;t | D]\} } | | } | rn| | =|r|ds |d=|r|d |j|dz }|dkr#|j|=|j|n ||j|<| |dS)Nc,g|]}t|SrrLrNs r&r@z2BaseAdapterRegistry.unregister..yrPr(FrurEr) rArUrrXrVreversedr r3remove_extendorr+)r$rZr[r6r\r]r^r_r`lookupsrarboldcomprcs r&rTzBaseAdapterRegistry.unregisterxsJJJJJKKH . CLL 5U^ ($  Aq!!Ay NNJ? + + +JJnnT"" ; F  Cu$4$4 F t  $G,,  aG EQ '"+ BK '"+ N8 $q ( 66x( N * *8 4 4 4 4'(DN8 $ Tr(ctd|D}d}t|}|j}t||kr:||t||k:||}||fz}|D]4} || } | |} | || <| }5||||||<|H|j|ddz} | |j|<| dkr|j || |dS)Nc,g|]}t|SrrLrNs r&r@z1BaseAdapterRegistry.subscribe..rPr(rhrrE) rArUrrVrWrXr:r r3rYr+) r$rZr[r\r6r]r^r_r`rarbrcs r& subscribezBaseAdapterRegistry.subscribes^JJJJJKKH #'lle## NN4,,.. / / /'lle##U^ ($  Aq!!Ay%%'' ! 1 JJ// t0D0DeLL 4  ""8Q//!3A'(DN8 $Avv++H555 Tr(cP||j||dpd}||vr|ndS)Nrhr)rgr)r$rZr[ subscriberrs r& subscribedzBaseAdapterRegistry.subscribedsGoo           (;66zzD@r(c#fK||jD]\}}}}|D] }|||fV dS)aM Yields tuples ``(required, provided, value)`` for all the subscribers that this object holds. These tuples could be passed as the arguments to the :meth:`subscribe` method on another adapter registry to duplicate the registrations this object holds. .. versionadded:: 5.3.0 N)rwr)r$rZr[_namer\r>s r&allSubscriptionsz$BaseAdapterRegistry.allSubscriptionssl150A0A  1 1  . . ,Hhu . .1----- . . .r(c0td|D}t|}|j}|t|krdS||}||fz}g}|D]5} || } | dS||| f| }6|d} | sdSt| } |d} n|| |} ~ t| | krdS| r| |d<n>|d=t |D]\}} || } | rn|| =|r|ds |d=|r|d |S|j|t| z| z }|dkr#|j|=|j |n ||j|<| |dS)Nc,g|]}t|SrrLrNs r&r@z3BaseAdapterRegistry.unsubscribe..rPr(rhrrur) rArUrrXrVrBr|r r3r}r+)r$rZr[r\r]r^r_r`r~rarbrlen_oldnewrrcs r& unsubscribezBaseAdapterRegistry.unsubscribes JJJJJKKH # CLL FU^ ($  Aq!!Ay NNJ? + + +JJnnR    Fc(( = CC++C77C  s88w   F   JrNN2#G,,  aG EQ '"+ BK '"+   x(3s883g=AAvvN8,..x8888+,x( Tr(c|}|}d}||}||}||j|D] }|j| |D] }|j| dS)aE Rebuild (and replace) all the internal data structures of this object. This is useful, especially for persistent implementations, if you suspect an issue with reference counts keeping interfaces alive even though they are no longer used. It is also useful if you or a subclass change the data types (``_mappingType`` and friends) that are to be used. This method replaces all internal data structures with new objects; it specifically does not re-use any storage. .. versionadded:: 5.3.0 c t|}n#t$rtdcYSwxYwtj|f|S)Nr)next StopIterationiter itertoolschain)itfirsts r&bufferz+BaseAdapterRegistry.rebuild..buffer8sT R    Bxx ?E8R00 0s ..N)ryrr'r"rdr)r$ registrationsrrargss r&rebuildzBaseAdapterRegistry.rebuild"s&--// --//  1 1 1}-- }--  dn%%%" ! !D DM4 ! " "D DND ! ! ! " "r(c Gdd}|S)NceZdZiZdS)2BaseAdapterRegistry.get..XXXTwistedFakeOutN)__name__ __module__ __qualname__ selfImpliedrr(r&XXXTwistedFakeOutrZsKKKr(rr)r$_rs r&rXzBaseAdapterRegistry.getYs0          r(rrhr)#rrr__doc__r4rFr'r,propertyr"r!listrrA_leafSequenceTypedictrWrr:rBr+rdrgrj classmethodrmrwryrTrrrrrrXrr(r&rr@s;;|2J K----^   @@BBI@@@MLM4444LLL8333!!!F$$$,    @@@[@888$ 5 5 5....`6AAA..."CCCCJ3"3"3"n!!!!!r(rcXeZdZdZd dZdZd dZd dZd dZd fd Z d Z d Z xZ S) LookupBasec0i|_i|_i|_dSr)_cache_mcache_scacher.s r&r'zLookupBase.__init__es   r(Nc|j|j|jdSr)rclearrr)r$ignoreds r&r+zLookupBase.changedjsD   r(c|j|}| i}||j|<|r ||}|i}|||<|}|Sr)rrX)r$r[r6cachecs r& _getcachezLookupBase._getcacheos_ )) =E$)DK !   $Ayd E r(rhct|tstd|||}t |}t |dkr"||dt}n(|t |t}|turH||||}t |dkr |||d<n||t |<||S|S)NrJrEr) rQrRrSrrArUrX_not_in_mapping_uncached_lookupr$rZr[r6defaultrresults r&rzLookupBase.lookup|s$$$ 5344 4x..?? x==A  YYx{O<N r(ct|tstd|||}||t }|t ur||f|||S||S|SNrJ)rQrRrSrrXrrrs r&rzLookupBase.lookup1s}$$$ 5344 4x..8_55 _ $ $;;|XtWEE E >N r(c2|||||Sr)r)r$objectr[r6rs r&rzLookupBase.queryAdapters  64AAAr(clt|tstdt|}|||}||t }|t ur||f||}|+t|tr|j }||}||S|Sr) rQrRrSrrrXrrsuper__self__) r$r[rr6rrZrfactoryr __class__s r&rzLookupBase.adapter_hooks$$$ 5344 4f%%x..))Ho66 o % %kk8,$??G  &%(( )WV__F! r(c|j|}| i}||j|<t|}||t}|tur|||}|||<|Sr)rrXrAr_uncached_lookupAllr$rZr[rrs r&rzLookupBase.lookupAllsy   ** =E%*DL "??8_55 _ $ $--hAAF$E(O r(c|j|}| i}||j|<t|}||t}|tur|||}|||<|Sr)rrXrAr_uncached_subscriptionsrs r&rzLookupBase.subscriptionssy   ** =E%*DL "??8_55 _ $ $11(HEEF$E(O r(rrhN) rrrr'r+rrrrrrr __classcell__rs@r&rrbs    ,    BBBB$          r(rc,eZdZdZdZdZdZdZdS) VerifyingBasect|||jjdd|_d|jD|_dS)NrEcg|] }|j SrrFrNs r&r@z)VerifyingBase.changed..s#K#K#KaAM#K#K#Kr()LookupBaseFallbackr+ _registryr _verify_ro_verify_generationsrGs r&r+zVerifyingBase.changedsL""4);<<<.+ABB/#K#K4?#K#K#K   r(chd|jD|jkr|ddSdS)Ncg|] }|j SrrrNs r&r@z)VerifyingBase._verify..s'   "#    r()rrr+r.s r&_verifyzVerifyingBase._verifysT  '+   ) * * LL       * *r(cb|t|||Sr)rrr)r$r[r6s r&rzVerifyingBase._getcaches. !++ (D   r(cb|t|||Sr)rrrr$rZr[s r&rzVerifyingBase.lookupAlls. !++ (H   r(cb|t|||Sr)rrrrs r&rzVerifyingBase.subscriptionss. !// (H   r(N)rrrr+rrrrrr(r&rrsbLLL            r(rcneZdZfdZdfd ZdZdZdZdZdd Z dfd Z d Z d Z d Z dZxZS)AdapterLookupBasec||_i|_|tdSr)r _requiredinit_extendorsrr')r$registryrs r&r'zAdapterLookupBase.__init__s?!  r(Nctd|jD]#}|}|||$|jdSr)rr+rkeysrr)r$rrOrs r&r+zAdapterLookupBase.changedss $$&& $ $AA} d### r(c\i|_|jjD]}||dSr) _extendorsrr rY)r$ps r&rz AdapterLookupBase.init_extendorss>) ! !A   a  ! !r(c|j}jD]<}||d}fd|Dgzfd|Dz||<=dS)Nrc>g|]}||Sr isOrExtendsr=er[s r&r@z2AdapterLookupBase.add_extendor..(s<H,@,@,C,Cr(c>g|]}||Srrrs r&r@z2AdapterLookupBase.add_extendor..,s<0D0DQ0G0Gr(r__iro__rX)r$r[rro extendorss ` r&rYzAdapterLookupBase.add_extendor#s_ !  A"q"--I((  qMM  r(ct|j}jD]'}fd||dD||<(dS)Nc g|] }|k| Srrrs r&r@z5AdapterLookupBase.remove_extendor..4s)///1 !X  - r(rr)r$r[rros ` r&r}z!AdapterLookupBase.remove_extendor1sa_ ! / /A//// q"(=(=///JqMM / /r(c|j}|D]4}|}||vr||d||<5dSrD)rweakrefr)r$rZ_refsrOrefs r& _subscribezAdapterLookupBase._subscribe7sV  A))++C% D!!!c   r(rhc 2t|}d}t|}|jjD]_}|j}|t|kr|jj|}|s?||} t| |||d|}|n`|j ||SNr) rArUrrrr3rrX_lookupr) r$rZr[r6rr]rr^rr_s r&rz"AdapterLookupBase._uncached_lookup?s??H )  H(GG $$ *599(CCI  JZ9dA"$$F!" "" r(c||d|D||}||S|fd|D}||S|S)Nc,g|]}t|Srrr=os r&r@z7AdapterLookupBase.queryMultiAdapter..Ws>>>z!}}>>>r(cLg|] }t|tr|jn|!Sr)rQrr)r=rrs r&r@z7AdapterLookupBase.queryMultiAdapter..[s;   :;*Q.. 5AJJA   r()r)r$objectsr[r6rrrrs r&rz#AdapterLookupBase.queryMultiAdapterVst++>>g>>>$OO ?N    ?F     >N r(c t|}t|}i}t|jjD][}|j}|t|kr|jj|}|s?||}t||||d|\|j |t| Sr) rArUr|rrrr3rrX _lookupAllrrl) r$rZr[r]rrr^rr_s r&rz%AdapterLookupBase._uncached_lookupAllcs??H  !233 J JH(GG $$ *599(CCI  J z8Y5 I I I I""V\\^^$$$r(cBd|||DS)Ncg|] }|d S)rr)r=rs r&r@z+AdapterLookupBase.names..vsAAA!AAAr()rrs r&rzAdapterLookupBase.namesus$AAdnnXx@@AAAAr(c Nt|}t|}g}t|jjD]`}|j}|t|kr||f}n"|jj|}|Et||||d|d|a|j ||S)Nrhr) rArUr|rrrr3rrX_subscriptionsr)r$rZr[r]rrr^rs r&rz)AdapterLookupBase._uncached_subscriptionsxs??H  !233 - -H+GG $$%L $.9==hGG $ 75>8Y!1e - - - - "" r(c|d|D|}| d}|D]}||n#g}|D]}||}||||S)Nc,g|]}t|Srrrs r&r@z1AdapterLookupBase.subscribers..s , , ,qZ]] , , ,r(r)rrV)r$rr[rr subscriptionrs r&rzAdapterLookupBase.subscriberss** , ,G , , ,h    F - ' '  g&&& 'F - . . )\73 )MM*--- r(rrr)rrrr'r+rrYr}rrrrrrrrrs@r&rrs <!!!   /// .      %%%$BBB.r(rceZdZdS) AdapterLookupNrrrrr(r&rrDr(rcHeZdZdZeZdfd ZdZdZfdZ fdZ xZ S) r za A full implementation of ``IAdapterRegistry`` that adds support for sub-registries. rcztj|_t|dSr)rWeakKeyDictionary_v_subregistriesrr')r$r%rs r&r'zAdapterRegistry.__init__s4!( 9 ; ; r(cd|j|<dSrDrr$rOs r&_addSubregistryzAdapterRegistry._addSubregistrys#$a   r(c,||jvr |j|=dSdSrrrs r&_removeSubregistryz"AdapterRegistry._removeSubregistrys) % % %%a((( & %r(c|jdd}|D]}||vr|||D]}||vr||t |dS)Nr"r)r*rXrrrr,)r$r%rrOrs r&r,zAdapterRegistry._setBasessm R00 + +A~~$$T*** ( (A||!!$''' %     r(ct||jD]}||dSr)rr+rr)r$rHsubrs r&r+zAdapterRegistry.changedsX *+++(--// , ,C KK* + + + + , ,r(r) rrrrrr2r'rrr,r+rrs@r&r r s  K      %%%))) ! ! ! ! !,,,,,,,,,r(ceZdZdS)VerifyingAdapterLookupNrrr(r&r!r!rr(r!ceZdZdZeZdS)r z2 The most commonly-used adapter registry. N)rrrrr!r2rr(r&r r s)KKKr(c|tS|Srr)xs r&rMrMsyr(c |j}||kr;||jD],}||}|rt|||||dz|} | | cS-n-|D]*} || }|r||} | | cS+dSrD)rX__sro__r) r_specsr[r6rolcomponents_getspeccompsrOifaces r&rrs  ^N1uu!H$  D"N4((E E5(D!a%CC=HHH    E"N5))E IIdOO=HHH 4r(c |j}||krCt||jD]&}||}|rt|||||dz|'dSt|D]$} || }|r||%dSrD)rXr|r&rupdate) r_r'r[rror(r)r*r+r,s r&rrs^N1uuU1X-.. E ED"N4((E E5%61q5!DDD E E h'' % %E"N5))E % e$$$ % %r(c >|j}||krDt||jD]'}||} | rt| |||||dz|(dSt|D];} || } | r,| |} | r|| r5s$$$$$$&&&&&&%%%%%%222222......666666 H\!\!\!\!\!\!\!\!~&(( kkkkkkk k\ # # # # # &# #  # LeeeeeeeeP     %z     %,%,%,%,%,)%,%,%,P     .      )))))2)))0 % % %)))))r(