Why Gemfury?
Push, build, and install
RubyGems
npm packages
Python packages
Maven artifacts
PHP packages
Go Modules
Debian packages
RPM packages
NuGet packages
squarecapadmin
squarecapadmin / zope.interface python
Repository URL to install this package:
|
Version:
4.1.2 ▾
|
cdocutils.nodes
document
q)q}q(UtagnameqUdocumentqUreporterqNU
attributesq}q(Udupnamesq ]Ubackrefsq
]UsourceX> /home/tseaver/projects/Zope/Z3/zope.interface/docs/adapter.rstq Uidsq ]Uclassesq
]Unamesq]uUparse_messagesq]qcdocutils.nodes
system_message
q)q}q(hhhUsystem_messageqh}q(h ]h
]qUid1qaUlineMªh
]h ]UlevelKUsourceh h]UtypeUINFOquUlineqMªUsourceqh U rawsourceqU Uparentq cdocutils.nodes
section
q )q }q (hhhUsectionq h}q!(h
]h ]q"X default adaptersq#ah]h ]q$hah
]uhMªhh hU h h )q%}q&(hhhh h}q'(h
]h ]h]q(X multi-adaptersq)ah ]q*Umulti-adaptersq+ah
]uhMahh hU h h )q,}q-(hhhh h}q.(h
]h ]h]q/X adapter registryq0ah ]q1Uadapter-registryq2ah
]uhKhh hU h hUchildrenq3]q4(cdocutils.nodes
title
q5)q6}q7(hhhUtitleq8h}q9(h
]h ]h]h ]h
]uhKhh hX Adapter Registryq:h h,h3]q;cdocutils.nodes
Text
q<X Adapter Registryq=
q>}q?(hh:h h6ubaubcdocutils.nodes
paragraph
q@)qA}qB(hhhU paragraphqCh}qD(h
]h ]h]h ]h
]uhKhh hX Adapter registries provide a way to register objects that depend on
one or more interface specifications and provide (perhaps indirectly)
some interface. In addition, the registrations have names. (You can
think of the names as qualifiers of the provided interfaces.)qEh h,h3]qFh<X Adapter registries provide a way to register objects that depend on
one or more interface specifications and provide (perhaps indirectly)
some interface. In addition, the registrations have names. (You can
think of the names as qualifiers of the provided interfaces.)qG
qH}qI(hhEh hAubaubh@)qJ}qK(hhhhCh}qL(h
]h ]h]h ]h
]uhK
hh hX The term "interface specification" refers both to interfaces and to
interface declarations, such as declarations of interfaces implemented
by a class.qMh h,h3]qNh<X The term "interface specification" refers both to interfaces and to
interface declarations, such as declarations of interfaces implemented
by a class.qO
qP}qQ(hhMh hJubaubh )qR}qS(hhhh h}qT(h
]h ]h]qUX single adaptersqVah ]qWUsingle-adaptersqXah
]uhKhh hU h h,h3]qY(h5)qZ}q[(hhhh8h}q\(h
]h ]h]h ]h
]uhKhh hX Single Adaptersq]h hRh3]q^h<X Single Adaptersq_
q`}qa(hh]h hZubaubh@)qb}qc(hhhhCh}qd(h
]h ]h]h ]h
]uhKhh hXF Let's look at a simple example, using a single required specification:qeh hRh3]qfh<XF Let's look at a simple example, using a single required specification:qg
qh}qi(hheh hbubaubcdocutils.nodes
literal_block
qj)qk}ql(hhhU
literal_blockqmh}qn(h ]U xml:spaceqoUpreserveqph
]U testnodetypeX doctesth
]Ugroups]qqUdefaultqrah ]Uoptionsqs}h]uhKhh hX >>> from zope.interface.adapter import AdapterRegistry
>>> import zope.interface
>>> class IR1(zope.interface.Interface):
... pass
>>> class IP1(zope.interface.Interface):
... pass
>>> class IP2(IP1):
... pass
>>> registry = AdapterRegistry()h hRh3]qth<X >>> from zope.interface.adapter import AdapterRegistry
>>> import zope.interface
>>> class IR1(zope.interface.Interface):
... pass
>>> class IP1(zope.interface.Interface):
... pass
>>> class IP2(IP1):
... pass
>>> registry = AdapterRegistry()qu
qv}qw(hU h hkubaubh@)qx}qy(hhhhCh}qz(h
]h ]h]h ]h
]uhK"hh hX@ We'll register an object that depends on IR1 and "provides" IP2:q{h hRh3]q|h<X@ We'll register an object that depends on IR1 and "provides" IP2:q}
q~}q(hh{h hxubaubhj)q}q(hhhhmh}q(h ]hohph
]U testnodetypeX doctesth
]Ugroups]qhrah ]hs}h]uhK$hh hX) >>> registry.register([IR1], IP2, '', 12)h hRh3]qh<X) >>> registry.register([IR1], IP2, '', 12)q
q}q(hU h hubaubh@)q}q(hhhhCh}q(h
]h ]h]h ]h
]uhK(hh hX0 Given the registration, we can look it up again:qh hRh3]qh<X0 Given the registration, we can look it up again:q
q}q(hhh hubaubhj)q}q(hhhhmh}q(h ]hohph
]U testnodetypeX doctesth
]Ugroups]qhrah ]hs}h]uhK*hh hX& >>> registry.lookup([IR1], IP2, '')
12h hRh3]qh<X& >>> registry.lookup([IR1], IP2, '')
12q
q}q(hU h hubaubh@)q}q(hhhhCh}q(h
]h ]h]h ]h
]uhK/hh hXd Note that we used an integer in the example. In real applications,
one would use some objects that actually depend on or provide
interfaces. The registry doesn't care about what gets registered, so
we'll use integers and strings to keep the examples simple. There is
one exception. Registering a value of None unregisters any
previously-registered value.qh hRh3]qh<Xd Note that we used an integer in the example. In real applications,
one would use some objects that actually depend on or provide
interfaces. The registry doesn't care about what gets registered, so
we'll use integers and strings to keep the examples simple. There is
one exception. Registering a value of None unregisters any
previously-registered value.q
q}q(hhh hubaubh@)q }q¡(hhhhCh}q¢(h
]h ]h]h ]h
]uhK6hh hX If an object depends on a specification, it can be looked up with a
specification that extends the specification that it depends on:q£h hRh3]q¤h<X If an object depends on a specification, it can be looked up with a
specification that extends the specification that it depends on:q¥
q¦}q§(hh£h h ubaubhj)q¨}q©(hhhhmh}qª(h ]hohph
]U testnodetypeX doctesth
]Ugroups]q«hrah ]hs}h]uhK9hh hXG >>> class IR2(IR1):
... pass
>>> registry.lookup([IR2], IP2, '')
12h hRh3]q¬h<XG >>> class IR2(IR1):
... pass
>>> registry.lookup([IR2], IP2, '')
12q
q®}q¯(hU h h¨ubaubh@)q°}q±(hhhhCh}q²(h
]h ]h]h ]h
]uhK@hh hXF We can use a class implementation specification to look up the object:q³h hRh3]q´h<XF We can use a class implementation specification to look up the object:qµ
q¶}q·(hh³h h°ubaubhj)q¸}q¹(hhhhmh}qº(h ]hohph
]U testnodetypeX doctesth
]Ugroups]q»hrah ]hs}h]uhKBhh hXy >>> class C2:
... zope.interface.implements(IR2)
>>> registry.lookup([zope.interface.implementedBy(C2)], IP2, '')
12h hRh3]q¼h<Xy >>> class C2:
... zope.interface.implements(IR2)
>>> registry.lookup([zope.interface.implementedBy(C2)], IP2, '')
12q½
q¾}q¿(hU h h¸ubaubh@)qÀ}qÁ(hhhhCh}qÂ(h
]h ]h]h ]h
]uhKKhh hXK and it can be looked up for interfaces that its provided interface
extends:qÃh hRh3]qÄh<XK and it can be looked up for interfaces that its provided interface
extends:qŅqÆ}qÇ(hhÃh hÀubaubhj)qÈ}qÉ(hhhhmh}qÊ(h ]hohph
]U testnodetypeX doctesth
]Ugroups]qËhrah ]hs}h]uhKNhh hXM >>> registry.lookup([IR1], IP1, '')
12
>>> registry.lookup([IR2], IP1, '')
12h hRh3]qÌh<XM >>> registry.lookup([IR1], IP1, '')
12
>>> registry.lookup([IR2], IP1, '')
12qͅqÎ}qÏ(hU h hÈubaubh@)qÐ}qÑ(hhhhCh}qÒ(h
]h ]h]h ]h
]uhKUhh hXw But if you require a specification that doesn't extend the specification the
object depends on, you won't get anything:qÓh hRh3]qÔh<Xw But if you require a specification that doesn't extend the specification the
object depends on, you won't get anything:qՅqÖ}q×(hhÓh hÐubaubhj)qØ}qÙ(hhhhmh}qÚ(h ]hohph
]U testnodetypeX doctesth
]Ugroups]qÛhrah ]hs}h]uhKXhh hX8 >>> registry.lookup([zope.interface.Interface], IP1, '')h hRh3]qÜh<X8 >>> registry.lookup([zope.interface.Interface], IP1, '')q݅qÞ}qß(hU h hØubaubh@)qà}qá(hhhhCh}qâ(h
]h ]h]h ]h
]uhK\hh hX3 By the way, you can pass a default value to lookup:qãh hRh3]qäh<X3 By the way, you can pass a default value to lookup:q允qæ}qç(hhãh hàubaubhj)qè}qé(hhhhmh}qê(h ]hohph
]U testnodetypeX doctesth
]Ugroups]qëhrah ]hs}h]uhK^hh hX? >>> registry.lookup([zope.interface.Interface], IP1, '', 42)
42h hRh3]qìh<X? >>> registry.lookup([zope.interface.Interface], IP1, '', 42)
42q텁qî}qï(hU h hèubaubh@)qð}qñ(hhhhCh}qò(h
]h ]h]h ]h
]uhKchh hXW If you try to get an interface the object doesn't provide, you also
won't get anything:qóh hRh3]qôh<XW If you try to get an interface the object doesn't provide, you also
won't get anything:qõ
qö}q÷(hhóh hðubaubhj)qø}qù(hhhhmh}qú(h ]hohph
]U testnodetypeX doctesth
]Ugroups]qûhrah ]hs}h]uhKfhh hXD >>> class IP3(IP2):
... pass
>>> registry.lookup([IR1], IP3, '')h hRh3]qüh<XD >>> class IP3(IP2):
... pass
>>> registry.lookup([IR1], IP3, '')qý
qþ}qÿ(hU h høubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhKlhh hX6 You also won't get anything if you use the wrong name:r h hRh3]r h<X6 You also won't get anything if you use the wrong name:r
r }r (hj h j ubaubhj)r }r (hhhhmh}r
(h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhKnhh hX >>> registry.lookup([IR1], IP1, 'bob')
>>> registry.register([IR1], IP2, 'bob', "Bob's 12")
>>> registry.lookup([IR1], IP1, 'bob')
"Bob's 12"h hRh3]r h<X >>> registry.lookup([IR1], IP1, 'bob')
>>> registry.register([IR1], IP2, 'bob', "Bob's 12")
>>> registry.lookup([IR1], IP1, 'bob')
"Bob's 12"r
r }r (hU h j ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhKuhh hX/ You can leave the name off when doing a lookup:r h hRh3]r h<X/ You can leave the name off when doing a lookup:r
r }r (hj h j ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhKwhh hX" >>> registry.lookup([IR1], IP1)
12h hRh3]r h<X" >>> registry.lookup([IR1], IP1)
12r
r }r (hU h j ubaubh@)r }r! (hhhhCh}r" (h
]h ]h]h ]h
]uhK|hh hX+ If we register an object that provides IP1:r# h hRh3]r$ h<X+ If we register an object that provides IP1:r%
r& }r' (hj# h j ubaubhj)r( }r) (hhhhmh}r* (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r+ hrah ]hs}h]uhK~hh hX) >>> registry.register([IR1], IP1, '', 11)h hRh3]r, h<X) >>> registry.register([IR1], IP1, '', 11)r-
r. }r/ (hU h j( ubaubh@)r0 }r1 (hhhhCh}r2 (h
]h ]h]h ]h
]uhKhh hX- then that object will be prefered over O(12):r3 h hRh3]r4 h<X- then that object will be prefered over O(12):r5
r6 }r7 (hj3 h j0 ubaubhj)r8 }r9 (hhhhmh}r: (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r; hrah ]hs}h]uhKhh hX& >>> registry.lookup([IR1], IP1, '')
11h hRh3]r< h<X& >>> registry.lookup([IR1], IP1, '')
11r=
r> }r? (hU h j8 ubaubh@)r@ }rA (hhhhCh}rB (h
]h ]h]h ]h
]uhKhh hXR Also, if we register an object for IR2, then that will be prefered
when using IR2:rC h hRh3]rD h<XR Also, if we register an object for IR2, then that will be prefered
when using IR2:rE
rF }rG (hjC h j@ ubaubhj)rH }rI (hhhhmh}rJ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rK hrah ]hs}h]uhKhh hXP >>> registry.register([IR2], IP1, '', 21)
>>> registry.lookup([IR2], IP1, '')
21h hRh3]rL h<XP >>> registry.register([IR2], IP1, '', 21)
>>> registry.lookup([IR2], IP1, '')
21rM
rN }rO (hU h jH ubaubh )rP }rQ (hhhh h}rR (h
]h ]h]rS X, finding out what, if anything, is registeredrT ah ]rU U*finding-out-what-if-anything-is-registeredrV ah
]uhKhh hU h hRh3]rW (h5)rX }rY (hhhh8h}rZ (h
]h ]h]h ]h
]uhKhh hX, Finding out what, if anything, is registeredr[ h jP h3]r\ h<X, Finding out what, if anything, is registeredr]
r^ }r_ (hj[ h jX ubaubh@)r` }ra (hhhhCh}rb (h
]h ]h]h ]h
]uhKhh hX We can ask if there is an adapter registered for a collection of
interfaces. This is different than lookup, because it looks for an
exact match:rc h jP h3]rd h<X We can ask if there is an adapter registered for a collection of
interfaces. This is different than lookup, because it looks for an
exact match:re
rf }rg (hjc h j` ubaubhj)rh }ri (hhhhmh}rj (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rk hrah ]hs}h]uhKhh hXô >>> print registry.registered([IR1], IP1)
11
>>> print registry.registered([IR1], IP2)
12
>>> print registry.registered([IR1], IP2, 'bob')
Bob's 12
>>> print registry.registered([IR2], IP1)
21
>>> print registry.registered([IR2], IP2)
Noneh jP h3]rl h<Xô >>> print registry.registered([IR1], IP1)
11
>>> print registry.registered([IR1], IP2)
12
>>> print registry.registered([IR1], IP2, 'bob')
Bob's 12
>>> print registry.registered([IR2], IP1)
21
>>> print registry.registered([IR2], IP2)
Nonerm
rn }ro (hU h jh ubaubh@)rp }rq (hhhhCh}rr (h
]h ]h]h ]h
]uhK«hh hXg In the last example, None was returned because nothing was registered
exactly for the given interfaces.rs h jP h3]rt h<Xg In the last example, None was returned because nothing was registered
exactly for the given interfaces.ru
rv }rw (hjs h jp ubaubeubh )rx }ry (hhhh h}rz (h
]h ]h]r{ X lookup1r| ah ]r} Ulookup1r~ ah
]uhK¯hh hU h hRh3]r (h5)r }r (hhhh8h}r (h
]h ]h]h ]h
]uhK¯hh hX lookup1r h jx h3]r h<X lookup1r
r }r (hj h j ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhK±hh hX Lookup of single adapters is common enough that there is a specialized
version of lookup that takes a single required interface:r h jx h3]r h<X Lookup of single adapters is common enough that there is a specialized
version of lookup that takes a single required interface:r
r }r (hj h j ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhK´hh hXG >>> registry.lookup1(IR2, IP1, '')
21
>>> registry.lookup1(IR2, IP1)
21h jx h3]r h<XG >>> registry.lookup1(IR2, IP1, '')
21
>>> registry.lookup1(IR2, IP1)
21r
r }r (hU h j ubaubeubh )r }r (hhhh h}r (h
]h ]h]r X actual adaptationr ah ]r Uactual-adaptationr ah
]uhK¼hh hU h hRh3]r (h5)r }r¡ (hhhh8h}r¢ (h
]h ]h]h ]h
]uhK¼hh hX Actual Adaptationr£ h j h3]r¤ h<X Actual Adaptationr¥
r¦ }r§ (hj£ h j ubaubh@)r¨ }r© (hhhhCh}rª (h
]h ]h]h ]h
]uhK¾hh hX The adapter registry is intended to support adaptation, where one
object that implements an interface is adapted to another object that
supports a different interface. The adapter registry supports the
computation of adapters. In this case, we have to register adapter
factories:r« h j h3]r¬ h<X The adapter registry is intended to support adaptation, where one
object that implements an interface is adapted to another object that
supports a different interface. The adapter registry supports the
computation of adapters. In this case, we have to register adapter
factories:r
r® }r¯ (hj« h j¨ ubaubhj)r° }r± (hhhhmh}r² (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r³ hrah ]hs}h]uhKÄhh hX >>> class IR(zope.interface.Interface):
... pass
>>> class X:
... zope.interface.implements(IR)
>>> class Y:
... zope.interface.implements(IP1)
... def __init__(self, context):
... self.context = context
>>> registry.register([IR], IP1, '', Y)h j h3]r´ h<X >>> class IR(zope.interface.Interface):
... pass
>>> class X:
... zope.interface.implements(IR)
>>> class Y:
... zope.interface.implements(IP1)
... def __init__(self, context):
... self.context = context
>>> registry.register([IR], IP1, '', Y)rµ
r¶ }r· (hU h j° ubaubh@)r¸ }r¹ (hhhhCh}rº (h
]h ]h]h ]h
]uhKÓhh hXm In this case, we registered a class as the factory. Now we can call
`queryAdapter` to get the adapted object:h j h3]r» (h<XD In this case, we registered a class as the factory. Now we can call
r¼
r½ }r¾ (hXD In this case, we registered a class as the factory. Now we can call
h j¸ ubcdocutils.nodes
title_reference
r¿ )rÀ }rÁ (hX `queryAdapter`hUtitle_referencer h}rà (h
]h ]h]h ]h
]uh j¸ h3]rÄ h<X queryAdapterrÅ
rÆ }rÇ (hU h jÀ ubaubh<X to get the adapted object:rÈ
rÉ }rÊ (hX to get the adapted object:h j¸ ubeubhj)rË }rÌ (hhhhmh}rÍ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rÎ hrah ]hs}h]uhKÖhh hXf >>> x = X()
>>> y = registry.queryAdapter(x, IP1)
>>> y.__class__.__name__
'Y'
>>> y.context is x
Trueh j h3]rÏ h<Xf >>> x = X()
>>> y = registry.queryAdapter(x, IP1)
>>> y.__class__.__name__
'Y'
>>> y.context is x
TruerÐ
rÑ }rÒ (hU h jË ubaubh@)rÓ }rÔ (hhhhCh}rÕ (h
]h ]h]h ]h
]uhKßhh hX' We can register and lookup by name too:rÖ h j h3]r× h<X' We can register and lookup by name too:rØ
rÙ }rÚ (hjÖ h jÓ ubaubhj)rÛ }rÜ (hhhhmh}rÝ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rÞ hrah ]hs}h]uhKáhh hX >>> class Y2(Y):
... pass
>>> registry.register([IR], IP1, 'bob', Y2)
>>> y = registry.queryAdapter(x, IP1, 'bob')
>>> y.__class__.__name__
'Y2'
>>> y.context is x
Trueh j h3]rß h<X >>> class Y2(Y):
... pass
>>> registry.register([IR], IP1, 'bob', Y2)
>>> y = registry.queryAdapter(x, IP1, 'bob')
>>> y.__class__.__name__
'Y2'
>>> y.context is x
Truerà
rá }râ (hU h jÛ ubaubh@)rã }rä (hhhhCh}rå (h
]h ]h]h ]h
]uhKíhh hX When the adapter factory produces `None`, then this is treated as if no
adapter has been found. This allows us to prevent adaptation (when desired)
and let the adapter factory determine whether adaptation is possible based on
the state of the object being adapted:h j h3]ræ (h<X" When the adapter factory produces rç
rè }ré (hX" When the adapter factory produces h jã ubj¿ )rê }rë (hX `None`hj h}rì (h
]h ]h]h ]h
]uh jã h3]rí h<X Nonerî
rï }rð (hU h jê ubaubh<Xà , then this is treated as if no
adapter has been found. This allows us to prevent adaptation (when desired)
and let the adapter factory determine whether adaptation is possible based on
the state of the object being adapted:rñ
rò }ró (hXà , then this is treated as if no
adapter has been found. This allows us to prevent adaptation (when desired)
and let the adapter factory determine whether adaptation is possible based on
the state of the object being adapted:h jã ubeubhj)rô }rõ (hhhhmh}rö (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r÷ hrah ]hs}h]uhKòhh hXõ >>> def factory(context):
... if context.name == 'object':
... return 'adapter'
... return None
>>> class Object(object):
... zope.interface.implements(IR)
... name = 'object'
>>> registry.register([IR], IP1, 'conditional', factory)
>>> obj = Object()
>>> registry.queryAdapter(obj, IP1, 'conditional')
'adapter'
>>> obj.name = 'no object'
>>> registry.queryAdapter(obj, IP1, 'conditional') is None
True
>>> registry.queryAdapter(obj, IP1, 'conditional', 'default')
'default'h j h3]rø h<Xõ >>> def factory(context):
... if context.name == 'object':
... return 'adapter'
... return None
>>> class Object(object):
... zope.interface.implements(IR)
... name = 'object'
>>> registry.register([IR], IP1, 'conditional', factory)
>>> obj = Object()
>>> registry.queryAdapter(obj, IP1, 'conditional')
'adapter'
>>> obj.name = 'no object'
>>> registry.queryAdapter(obj, IP1, 'conditional') is None
True
>>> registry.queryAdapter(obj, IP1, 'conditional', 'default')
'default'rù
rú }rû (hU h jô ubaubh@)rü }rý (hhhhCh}rþ (h
]h ]h]h ]h
]uhMhh hX\ An alternate method that provides the same function as `queryAdapter()` is
`adapter_hook()`:h j h3]rÿ (h<X7 An alternate method that provides the same function as r
r }r (hX7 An alternate method that provides the same function as h jü ubj¿ )r }r (hX `queryAdapter()`hj h}r (h
]h ]h]h ]h
]uh jü h3]r h<X queryAdapter()r
r }r (hU h j ubaubh<X is
r
r }r (hX is
h jü ubj¿ )r
}r (hX `adapter_hook()`hj h}r (h
]h ]h]h ]h
]uh jü h3]r h<X adapter_hook()r
r }r (hU h j
ubaubh<X :
r }r (hX :h jü ubeubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhM
hh hX½ >>> y = registry.adapter_hook(IP1, x)
>>> y.__class__.__name__
'Y'
>>> y.context is x
True
>>> y = registry.adapter_hook(IP1, x, 'bob')
>>> y.__class__.__name__
'Y2'
>>> y.context is x
Trueh j h3]r h<X½ >>> y = registry.adapter_hook(IP1, x)
>>> y.__class__.__name__
'Y'
>>> y.context is x
True
>>> y = registry.adapter_hook(IP1, x, 'bob')
>>> y.__class__.__name__
'Y2'
>>> y.context is x
Truer
r }r (hU h j ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhMhh hX The `adapter_hook()` simply switches the order of the object and
interface arguments. It is used to hook into the interface call
mechanism.h j h3]r! (h<X The r"
r# }r$ (hX The h j ubj¿ )r% }r& (hX `adapter_hook()`hj h}r' (h
]h ]h]h ]h
]uh j h3]r( h<X adapter_hook()r)
r* }r+ (hU h j% ubaubh<Xx simply switches the order of the object and
interface arguments. It is used to hook into the interface call
mechanism.r,
r- }r. (hXx simply switches the order of the object and
interface arguments. It is used to hook into the interface call
mechanism.h j ubeubeubh )r/ }r0 (hhhh h}r1 (h
]h ]r2 h#ah]h ]r3 Udefault-adaptersr4 ah
]uhM hh hU h hRU
referencedr5 Kh3]r6 (h5)r7 }r8 (hhhh8h}r9 (h
]h ]h]h ]h
]uhM hh hX Default Adaptersr: h j/ h3]r; h<X Default Adaptersr<
r= }r> (hj: h j7 ubaubh@)r? }r@ (hhhhCh}rA (h
]h ]h]h ]h
]uhM hh hXu Sometimes, you want to provide an adapter that will adapt anything.
For that, provide None as the required interface:rB h j/ h3]rC h<Xu Sometimes, you want to provide an adapter that will adapt anything.
For that, provide None as the required interface:rD
rE }rF (hjB h j? ubaubhj)rG }rH (hhhhmh}rI (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rJ hrah ]hs}h]uhM"hh hX) >>> registry.register([None], IP1, '', 1)h j/ h3]rK h<X) >>> registry.register([None], IP1, '', 1)rL
rM }rN (hU h jG ubaubh@)rO }rP (hhhhCh}rQ (h
]h ]h]h ]h
]uhM&hh hXP then we can use that adapter for interfaces we don't have specific
adapters for:rR h j/ h3]rS h<XP then we can use that adapter for interfaces we don't have specific
adapters for:rT
rU }rV (hjR h jO ubaubhj)rW }rX (hhhhmh}rY (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rZ hrah ]hs}h]uhM)hh hXY >>> class IQ(zope.interface.Interface):
... pass
>>> registry.lookup([IQ], IP1, '')
1h j/ h3]r[ h<XY >>> class IQ(zope.interface.Interface):
... pass
>>> registry.lookup([IQ], IP1, '')
1r\
r] }r^ (hU h jW ubaubh@)r_ }r` (hhhhCh}ra (h
]h ]h]h ]h
]uhM0hh hX< Of course, specific adapters are still used when applicable:rb h j/ h3]rc h<X< Of course, specific adapters are still used when applicable:rd
re }rf (hjb h j_ ubaubhj)rg }rh (hhhhmh}ri (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rj hrah ]hs}h]uhM2hh hX& >>> registry.lookup([IR2], IP1, '')
21h j/ h3]rk h<X& >>> registry.lookup([IR2], IP1, '')
21rl
rm }rn (hU h jg ubaubeubh )ro }rp (hhhh h}rq (h
]h ]h]rr X class adaptersrs ah ]rt Uclass-adaptersru ah
]uhM9hh hU h hRh3]rv (h5)rw }rx (hhhh8h}ry (h
]h ]h]h ]h
]uhM9hh hX Class adaptersrz h jo h3]r{ h<X Class adaptersr|
r} }r~ (hjz h jw ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhM;hh hXk You can register adapters for class declarations, which is almost the
same as registering them for a class:r h jo h3]r h<Xk You can register adapters for class declarations, which is almost the
same as registering them for a class:r
r
}r (hj h j ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhM>hh hX >>> registry.register([zope.interface.implementedBy(C2)], IP1, '', 'C21')
>>> registry.lookup([zope.interface.implementedBy(C2)], IP1, '')
'C21'h jo h3]r h<X >>> registry.register([zope.interface.implementedBy(C2)], IP1, '', 'C21')
>>> registry.lookup([zope.interface.implementedBy(C2)], IP1, '')
'C21'r
r }r (hU h j ubaubeubh )r }r (hhhh h}r (h
]h ]h]r X
dict adaptersr ah ]r U
dict-adaptersr ah
]uhMEhh hU h hRh3]r (h5)r }r (hhhh8h}r (h
]h ]h]h ]h
]uhMEhh hX
Dict adaptersr h j h3]r h<X
Dict adaptersr
r }r (hj h j ubaubh@)r }r (hhhhCh}r¡ (h
]h ]h]h ]h
]uhMGhh hXp At some point it was impossible to register dictionary-based adapters due a
bug. Let's make sure this works now:r¢ h j h3]r£ h<Xp At some point it was impossible to register dictionary-based adapters due a
bug. Let's make sure this works now:r¤
r¥ }r¦ (hj¢ h j ubaubhj)r§ }r¨ (hhhhmh}r© (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rª hrah ]hs}h]uhMJhh hXk >>> adapter = {}
>>> registry.register((), IQ, '', adapter)
>>> registry.lookup((), IQ, '') is adapter
Trueh j h3]r« h<Xk >>> adapter = {}
>>> registry.register((), IQ, '', adapter)
>>> registry.lookup((), IQ, '') is adapter
Truer¬
r }r® (hU h j§ ubaubeubh )r¯ }r° (hhhh h}r± (h
]h ]h]r² X
unregisteringr³ ah ]r´ U
unregisteringrµ ah
]uhMRhh hU h hRh3]r¶ (h5)r· }r¸ (hhhh8h}r¹ (h
]h ]h]h ]h
]uhMRhh hX
Unregisteringrº h j¯ h3]r» h<X
Unregisteringr¼
r½ }r¾ (hjº h j· ubaubh@)r¿ }rÀ (hhhhCh}rÁ (h
]h ]h]h ]h
]uhMThh hX> You can unregister by registering None, rather than an object:r h j¯ h3]rà h<X> You can unregister by registering None, rather than an object:rÄ
rÅ }rÆ (hj h j¿ ubaubhj)rÇ }rÈ (hhhhmh}rÉ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rÊ hrah ]hs}h]uhMVhh hX >>> registry.register([zope.interface.implementedBy(C2)], IP1, '', None)
>>> registry.lookup([zope.interface.implementedBy(C2)], IP1, '')
21h j¯ h3]rË h<X >>> registry.register([zope.interface.implementedBy(C2)], IP1, '', None)
>>> registry.lookup([zope.interface.implementedBy(C2)], IP1, '')
21rÌ
rÍ }rÎ (hU h jÇ ubaubh@)rÏ }rÐ (hhhhCh}rÑ (h
]h ]h]h ]h
]uhM\hh hX Of course, this means that None can't be registered. This is an
exception to the statement, made earlier, that the registry doesn't
care what gets registered.rÒ h j¯ h3]rÓ h<X Of course, this means that None can't be registered. This is an
exception to the statement, made earlier, that the registry doesn't
care what gets registered.rÔ
rÕ }rÖ (hjÒ h jÏ ubaubeubeubh%h )r× }rØ (hhhh h}rÙ (h
]h ]h]rÚ X
null adaptersrÛ ah ]rÜ U
null-adaptersrÝ ah
]uhM¶hh hU h h,h3]rÞ (h5)rß }rà (hhhh8h}rá (h
]h ]h]h ]h
]uhM¶hh hX
Null Adaptersrâ h j× h3]rã h<X
Null Adaptersrä
rå }ræ (hjâ h jß ubaubh@)rç }rè (hhhhCh}ré (h
]h ]h]h ]h
]uhM¸hh hX$ You can also adapt no specification:rê h j× h3]rë h<X$ You can also adapt no specification:rì
rí }rî (hjê h jç ubaubhj)rï }rð (hhhhmh}rñ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rò hrah ]hs}h]uhMºhh hXk >>> registry.register([], IP2, '', 2)
>>> registry.lookup([], IP2, '')
2
>>> registry.lookup([], IP1, '')
2h j× h3]ró h<Xk >>> registry.register([], IP2, '', 2)
>>> registry.lookup([], IP2, '')
2
>>> registry.lookup([], IP1, '')
2rô
rõ }rö (hU h jï ubaubh )r÷ }rø (hhhh h}rù (h
]h ]h]rú X listing named adaptersrû ah ]rü Ulisting-named-adaptersrý ah
]uhMÃhh hU h j× h3]rþ (h5)rÿ }r (hhhh8h}r (h
]h ]h]h ]h
]uhMÃhh hX Listing named adaptersr h j÷ h3]r h<X Listing named adaptersr
r }r (hj h jÿ ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhMÅhh hXa Adapters are named. Sometimes, it's useful to get all of the named
adapters for given interfaces:r
h j÷ h3]r h<Xa Adapters are named. Sometimes, it's useful to get all of the named
adapters for given interfaces:r
r
}r (hj
h j ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhMÈhh hX >>> adapters = list(registry.lookupAll([IR1], IP1))
>>> adapters.sort()
>>> assert adapters == [(u'', 11), (u'bob', "Bob's 12")]h j÷ h3]r h<X >>> adapters = list(registry.lookupAll([IR1], IP1))
>>> adapters.sort()
>>> assert adapters == [(u'', 11), (u'bob', "Bob's 12")]r
r }r (hU h j ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhMÎhh hX" This works for multi-adapters too:r h j÷ h3]r h<X" This works for multi-adapters too:r
r }r (hj h j ubaubhj)r }r (hhhhmh}r! (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r" hrah ]hs}h]uhMÐhh hXÉ >>> registry.register([IR1, IQ2], IP2, 'bob', '1q2 for bob')
>>> adapters = list(registry.lookupAll([IR2, IQ2], IP1))
>>> adapters.sort()
>>> assert adapters == [(u'', '1q22'), (u'bob', '1q2 for bob')]h j÷ h3]r# h<XÉ >>> registry.register([IR1, IQ2], IP2, 'bob', '1q2 for bob')
>>> adapters = list(registry.lookupAll([IR2, IQ2], IP1))
>>> adapters.sort()
>>> assert adapters == [(u'', '1q22'), (u'bob', '1q2 for bob')]r$
r% }r& (hU h j ubaubh@)r' }r( (hhhhCh}r) (h
]h ]h]h ]h
]uhM×hh hX And even null adapters:r* h j÷ h3]r+ h<X And even null adapters:r,
r- }r. (hj* h j' ubaubhj)r/ }r0 (hhhhmh}r1 (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r2 hrah ]hs}h]uhMÙhh hX >>> registry.register([], IP2, 'bob', 3)
>>> adapters = list(registry.lookupAll([], IP1))
>>> adapters.sort()
>>> assert adapters == [(u'', 2), (u'bob', 3)]h j÷ h3]r3 h<X >>> registry.register([], IP2, 'bob', 3)
>>> adapters = list(registry.lookupAll([], IP1))
>>> adapters.sort()
>>> assert adapters == [(u'', 2), (u'bob', 3)]r4
r5 }r6 (hU h j/ ubaubeubeubh )r7 }r8 (hhhh h}r9 (h
]h ]h]r: X
subscriptionsr; ah ]r< U
subscriptionsr= ah
]uhMáhh hU h h,h3]r> (h5)r? }r@ (hhhh8h}rA (h
]h ]h]h ]h
]uhMáhh hX
SubscriptionsrB h j7 h3]rC h<X
SubscriptionsrD
rE }rF (hjB h j? ubaubh@)rG }rH (hhhhCh}rI (h
]h ]h]h ]h
]uhMãhh hX Normally, we want to look up an object that most-closely matches a
specification. Sometimes, we want to get all of the objects that
match some specification. We use subscriptions for this. We
subscribe objects against specifications and then later find all of
the subscribed objects:rJ h j7 h3]rK h<X Normally, we want to look up an object that most-closely matches a
specification. Sometimes, we want to get all of the objects that
match some specification. We use subscriptions for this. We
subscribe objects against specifications and then later find all of
the subscribed objects:rL
rM }rN (hjJ h jG ubaubhj)rO }rP (hhhhmh}rQ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rR hrah ]hs}h]uhMéhh hX` >>> registry.subscribe([IR1], IP2, 'sub12 1')
>>> registry.subscriptions([IR1], IP2)
['sub12 1']h j7 h3]rS h<X` >>> registry.subscribe([IR1], IP2, 'sub12 1')
>>> registry.subscriptions([IR1], IP2)
['sub12 1']rT
rU }rV (hU h jO ubaubh@)rW }rX (hhhhCh}rY (h
]h ]h]h ]h
]uhMïhh hX> Note that, unlike regular adapters, subscriptions are unnamed.rZ h j7 h3]r[ h<X> Note that, unlike regular adapters, subscriptions are unnamed.r\
r] }r^ (hjZ h jW ubaubh@)r_ }r` (hhhhCh}ra (h
]h ]h]h ]h
]uhMñhh hX= You can have multiple subscribers for the same specification:rb h j7 h3]rc h<X= You can have multiple subscribers for the same specification:rd
re }rf (hjb h j_ ubaubhj)rg }rh (hhhhmh}ri (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rj hrah ]hs}h]uhMóhh hXk >>> registry.subscribe([IR1], IP2, 'sub12 2')
>>> registry.subscriptions([IR1], IP2)
['sub12 1', 'sub12 2']h j7 h3]rk h<Xk >>> registry.subscribe([IR1], IP2, 'sub12 2')
>>> registry.subscriptions([IR1], IP2)
['sub12 1', 'sub12 2']rl
rm }rn (hU h jg ubaubh@)ro }rp (hhhhCh}rq (h
]h ]h]h ]h
]uhMùhh hXm If subscribers are registered for the same required interfaces, they
are returned in the order of definition.rr h j7 h3]rs h<Xm If subscribers are registered for the same required interfaces, they
are returned in the order of definition.rt
ru }rv (hjr h jo ubaubh@)rw }rx (hhhhCh}ry (h
]h ]h]h ]h
]uhMühh hX? You can register subscribers for all specifications using None:rz h j7 h3]r{ h<X? You can register subscribers for all specifications using None:r|
r} }r~ (hjz h jw ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhMþhh hXs >>> registry.subscribe([None], IP1, 'sub_1')
>>> registry.subscriptions([IR2], IP1)
['sub_1', 'sub12 1', 'sub12 2']h j7 h3]r h<Xs >>> registry.subscribe([None], IP1, 'sub_1')
>>> registry.subscriptions([IR2], IP1)
['sub_1', 'sub12 1', 'sub12 2']r
r
}r (hU h j ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhMhh hX¦ Note that the new subscriber is returned first. Subscribers defined
for less general required interfaces are returned before subscribers
for more general interfaces.r h j7 h3]r h<X¦ Note that the new subscriber is returned first. Subscribers defined
for less general required interfaces are returned before subscribers
for more general interfaces.r
r }r (hj h j ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhMhh hXF Subscriptions may be combined over multiple compatible specifications:r h j7 h3]r h<XF Subscriptions may be combined over multiple compatible specifications:r
r }r (hj h j ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhM
hh hX >>> registry.subscriptions([IR2], IP1)
['sub_1', 'sub12 1', 'sub12 2']
>>> registry.subscribe([IR1], IP1, 'sub11')
>>> registry.subscriptions([IR2], IP1)
['sub_1', 'sub12 1', 'sub12 2', 'sub11']
>>> registry.subscribe([IR2], IP2, 'sub22')
>>> registry.subscriptions([IR2], IP1)
['sub_1', 'sub12 1', 'sub12 2', 'sub11', 'sub22']
>>> registry.subscriptions([IR2], IP2)
['sub12 1', 'sub12 2', 'sub22']h j7 h3]r h<X >>> registry.subscriptions([IR2], IP1)
['sub_1', 'sub12 1', 'sub12 2']
>>> registry.subscribe([IR1], IP1, 'sub11')
>>> registry.subscriptions([IR2], IP1)
['sub_1', 'sub12 1', 'sub12 2', 'sub11']
>>> registry.subscribe([IR2], IP2, 'sub22')
>>> registry.subscriptions([IR2], IP1)
['sub_1', 'sub12 1', 'sub12 2', 'sub11', 'sub22']
>>> registry.subscriptions([IR2], IP2)
['sub12 1', 'sub12 2', 'sub22']r
r }r (hU h j ubaubh@)r }r (hhhhCh}r¡ (h
]h ]h]h ]h
]uhMhh hX0 Subscriptions can be on multiple specifications:r¢ h j7 h3]r£ h<X0 Subscriptions can be on multiple specifications:r¤
r¥ }r¦ (hj¢ h j ubaubhj)r§ }r¨ (hhhhmh}r© (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rª hrah ]hs}h]uhMhh hXf >>> registry.subscribe([IR1, IQ], IP2, 'sub1q2')
>>> registry.subscriptions([IR1, IQ], IP2)
['sub1q2']h j7 h3]r« h<Xf >>> registry.subscribe([IR1, IQ], IP2, 'sub1q2')
>>> registry.subscriptions([IR1, IQ], IP2)
['sub1q2']r¬
r }r® (hU h j§ ubaubh@)r¯ }r° (hhhhCh}r± (h
]h ]h]h ]h
]uhM hh hX As with single subscriptions and non-subscription adapters, you can
specify None for the first required interface, to specify a default:r² h j7 h3]r³ h<X As with single subscriptions and non-subscription adapters, you can
specify None for the first required interface, to specify a default:r´
rµ }r¶ (hj² h j¯ ubaubhj)r· }r¸ (hhhhmh}r¹ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rº hrah ]hs}h]uhM"hh hX¦ >>> registry.subscribe([None, IQ], IP2, 'sub_q2')
>>> registry.subscriptions([IS, IQ], IP2)
['sub_q2']
>>> registry.subscriptions([IR1, IQ], IP2)
['sub_q2', 'sub1q2']h j7 h3]r» h<X¦ >>> registry.subscribe([None, IQ], IP2, 'sub_q2')
>>> registry.subscriptions([IS, IQ], IP2)
['sub_q2']
>>> registry.subscriptions([IR1, IQ], IP2)
['sub_q2', 'sub1q2']r¼
r½ }r¾ (hU h j· ubaubh@)r¿ }rÀ (hhhhCh}rÁ (h
]h ]h]h ]h
]uhM*hh hXE You can have subscriptions that are indepenent of any specifications:r h j7 h3]rà h<XE You can have subscriptions that are indepenent of any specifications:rÄ
rÅ }rÆ (hj h j¿ ubaubhj)rÇ }rÈ (hhhhmh}rÉ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rÊ hrah ]hs}h]uhM,hh hX >>> list(registry.subscriptions([], IP1))
[]
>>> registry.subscribe([], IP2, 'sub2')
>>> registry.subscriptions([], IP1)
['sub2']
>>> registry.subscribe([], IP1, 'sub1')
>>> registry.subscriptions([], IP1)
['sub2', 'sub1']
>>> registry.subscriptions([], IP2)
['sub2']h j7 h3]rË h<X >>> list(registry.subscriptions([], IP1))
[]
>>> registry.subscribe([], IP2, 'sub2')
>>> registry.subscriptions([], IP1)
['sub2']
>>> registry.subscribe([], IP1, 'sub1')
>>> registry.subscriptions([], IP1)
['sub2', 'sub1']
>>> registry.subscriptions([], IP2)
['sub2']rÌ
rÍ }rÎ (hU h jÇ ubaubh )rÏ }rÐ (hhhh h}rÑ (h
]h ]h]rÒ X unregistering subscribersrÓ ah ]rÔ Uunregistering-subscribersrÕ ah
]uhM;hh hU h j7 h3]rÖ (h5)r× }rØ (hhhh8h}rÙ (h
]h ]h]h ]h
]uhM;hh hX Unregistering subscribersrÚ h jÏ h3]rÛ h<X Unregistering subscribersrÜ
rÝ }rÞ (hjÚ h j× ubaubh@)rß }rà (hhhhCh}rá (h
]h ]h]h ]h
]uhM=hh hXi We can unregister subscribers. When unregistering a subscriber, we
can unregister a specific subscriber:râ h jÏ h3]rã h<Xi We can unregister subscribers. When unregistering a subscriber, we
can unregister a specific subscriber:rä
rå }ræ (hjâ h jß ubaubhj)rç }rè (hhhhmh}ré (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rê hrah ]hs}h]uhM@hh hXt >>> registry.unsubscribe([IR1], IP1, 'sub11')
>>> registry.subscriptions([IR1], IP1)
['sub_1', 'sub12 1', 'sub12 2']h jÏ h3]rë h<Xt >>> registry.unsubscribe([IR1], IP1, 'sub11')
>>> registry.subscriptions([IR1], IP1)
['sub_1', 'sub12 1', 'sub12 2']rì
rí }rî (hU h jç ubaubh@)rï }rð (hhhhCh}rñ (h
]h ]h]h ]h
]uhMFhh hXe If we don't specify a value, then all subscribers matching the given
interfaces will be unsubscribed:rò h jÏ h3]ró h<Xe If we don't specify a value, then all subscribers matching the given
interfaces will be unsubscribed:rô
rõ }rö (hjò h jï ubaubhj)r÷ }rø (hhhhmh}rù (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rú hrah ]hs}h]uhMIhh hXU >>> registry.unsubscribe([IR1], IP2)
>>> registry.subscriptions([IR1], IP1)
['sub_1']h jÏ h3]rû h<XU >>> registry.unsubscribe([IR1], IP2)
>>> registry.subscriptions([IR1], IP1)
['sub_1']rü
rý }rþ (hU h j÷ ubaubeubh )rÿ }r (hhhh h}r (h
]h ]h]r X subscription adaptersr ah ]r Usubscription-adaptersr ah
]uhMQhh hU h j7 h3]r (h5)r }r (hhhh8h}r (h
]h ]h]h ]h
]uhMQhh hX Subscription adaptersr
h jÿ h3]r h<X Subscription adaptersr
r
}r (hj
h j ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhMShh hXµ We normally register adapter factories, which then allow us to compute
adapters, but with subscriptions, we get multiple adapters. Here's an
example of multiple-object subscribers:r h jÿ h3]r h<Xµ We normally register adapter factories, which then allow us to compute
adapters, but with subscriptions, we get multiple adapters. Here's an
example of multiple-object subscribers:r
r }r (hj h j ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhMWhh hXL >>> registry.subscribe([IR, IQ], IM, M)
>>> registry.subscribe([IR, IQ], IM, M2)
>>> subscribers = registry.subscribers((x, q), IM)
>>> len(subscribers)
2
>>> class_names = [s.__class__.__name__ for s in subscribers]
>>> class_names.sort()
>>> class_names
['M', 'M2']
>>> [(s.x is x and s.q is q) for s in subscribers]
[True, True]h jÿ h3]r h<XL >>> registry.subscribe([IR, IQ], IM, M)
>>> registry.subscribe([IR, IQ], IM, M2)
>>> subscribers = registry.subscribers((x, q), IM)
>>> len(subscribers)
2
>>> class_names = [s.__class__.__name__ for s in subscribers]
>>> class_names.sort()
>>> class_names
['M', 'M2']
>>> [(s.x is x and s.q is q) for s in subscribers]
[True, True]r
r }r (hU h j ubaubh@)r }r (hhhhCh}r! (h
]h ]h]h ]h
]uhMfhh hX4 adapter factory subcribers can't return None values:r" h jÿ h3]r# h<X4 adapter factory subcribers can't return None values:r$
r% }r& (hj" h j ubaubhj)r' }r( (hhhhmh}r) (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r* hrah ]hs}h]uhMhhh hX >>> def M3(x, y):
... return None
>>> registry.subscribe([IR, IQ], IM, M3)
>>> subscribers = registry.subscribers((x, q), IM)
>>> len(subscribers)
2h jÿ h3]r+ h<X >>> def M3(x, y):
... return None
>>> registry.subscribe([IR, IQ], IM, M3)
>>> subscribers = registry.subscribers((x, q), IM)
>>> len(subscribers)
2r,
r- }r. (hU h j' ubaubeubh )r/ }r0 (hhhh h}r1 (h
]h ]h]r2 X handlersr3 ah ]r4 Uhandlersr5 ah
]uhMshh hU h j7 h3]r6 (h5)r7 }r8 (hhhh8h}r9 (h
]h ]h]h ]h
]uhMshh hX Handlersr: h j/ h3]r; h<X Handlersr<
r= }r> (hj: h j7 ubaubh@)r? }r@ (hhhhCh}rA (h
]h ]h]h ]h
]uhMuhh hXµ A handler is a subscriber factory that doesn't produce any normal
output. It returns None. A handler is unlike adapters in that it does
all of its work when the factory is called.rB h j/ h3]rC h<Xµ A handler is a subscriber factory that doesn't produce any normal
output. It returns None. A handler is unlike adapters in that it does
all of its work when the factory is called.rD
rE }rF (hjB h j? ubaubh@)rG }rH (hhhhCh}rI (h
]h ]h]h ]h
]uhMyhh hXE To register a handler, simply provide None as the provided interface:rJ h j/ h3]rK h<XE To register a handler, simply provide None as the provided interface:rL
rM }rN (hjJ h jG ubaubhj)rO }rP (hhhhmh}rQ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rR hrah ]hs}h]uhM{hh hX >>> def handler(event):
... print 'handler', event
>>> registry.subscribe([IR1], None, handler)
>>> registry.subscriptions([IR1], None) == [handler]
Trueh j/ h3]rS h<X >>> def handler(event):
... print 'handler', event
>>> registry.subscribe([IR1], None, handler)
>>> registry.subscriptions([IR1], None) == [handler]
TruerT
rU }rV (hU h jO ubaubeubeubeubh3]rW (h5)rX }rY (hhhh8h}rZ (h
]h ]h]h ]h
]uhMahh hX Multi-adaptersr[ h h%h3]r\ h<X Multi-adaptersr]
r^ }r_ (hj[ h jX ubaubh@)r` }ra (hhhhCh}rb (h
]h ]h]h ]h
]uhMchh hX& You can adapt multiple specifications:rc h h%h3]rd h<X& You can adapt multiple specifications:re
rf }rg (hjc h j` ubaubhj)rh }ri (hhhhmh}rj (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rk hrah ]hs}h]uhMehh hX >>> registry.register([IR1, IQ], IP2, '', '1q2')
>>> registry.lookup([IR1, IQ], IP2, '')
'1q2'
>>> registry.lookup([IR2, IQ], IP1, '')
'1q2'
>>> class IS(zope.interface.Interface):
... pass
>>> registry.lookup([IR2, IS], IP1, '')
>>> class IQ2(IQ):
... pass
>>> registry.lookup([IR2, IQ2], IP1, '')
'1q2'
>>> registry.register([IR1, IQ2], IP2, '', '1q22')
>>> registry.lookup([IR2, IQ2], IP1, '')
'1q22'h h%h3]rl h<X >>> registry.register([IR1, IQ], IP2, '', '1q2')
>>> registry.lookup([IR1, IQ], IP2, '')
'1q2'
>>> registry.lookup([IR2, IQ], IP1, '')
'1q2'
>>> class IS(zope.interface.Interface):
... pass
>>> registry.lookup([IR2, IS], IP1, '')
>>> class IQ2(IQ):
... pass
>>> registry.lookup([IR2, IQ2], IP1, '')
'1q2'
>>> registry.register([IR1, IQ2], IP2, '', '1q22')
>>> registry.lookup([IR2, IQ2], IP1, '')
'1q22'rm
rn }ro (hU h jh ubaubh )rp }rq (hhhh h}rr (h
]h ]h]rs X multi-adaptationrt ah ]ru Umulti-adaptationrv ah
]uhM|hh hU h h%h3]rw (h5)rx }ry (hhhh8h}rz (h
]h ]h]h ]h
]uhM|hh hX Multi-adaptationr{ h jp h3]r| h<X Multi-adaptationr}
r~ }r (hj{ h jx ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhM~hh hX You can adapt multiple objects:r h jp h3]r h<X You can adapt multiple objects:r
r }r (hj h j ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhMhh hX2 >>> class Q:
... zope.interface.implements(IQ)h jp h3]r h<X2 >>> class Q:
... zope.interface.implements(IQ)r
r }r (hU h j ubaubh@)r }r (hhhhCh}r (h
]h ]h]h ]h
]uhM
hh hXG As with single adapters, we register a factory, which is often a class:r h jp h3]r h<XG As with single adapters, we register a factory, which is often a class:r
r }r (hj h j ubaubhj)r }r (hhhhmh}r (h ]hohph
]U testnodetypeX doctesth
]Ugroups]r hrah ]hs}h]uhMhh hXÖ >>> class IM(zope.interface.Interface):
... pass
>>> class M:
... zope.interface.implements(IM)
... def __init__(self, x, q):
... self.x, self.q = x, q
>>> registry.register([IR, IQ], IM, '', M)h jp h3]r h<XÖ >>> class IM(zope.interface.Interface):
... pass
>>> class M:
... zope.interface.implements(IM)
... def __init__(self, x, q):
... self.x, self.q = x, q
>>> registry.register([IR, IQ], IM, '', M)r
r }r (hU h j ubaubh@)r }r¡ (hhhhCh}r¢ (h
]h ]h]h ]h
]uhMhh hX? And then we can call `queryMultiAdapter` to compute an adapter:r£ h jp h3]r¤ (h<X And then we can call r¥
r¦ }r§ (hX And then we can call h j ubj¿ )r¨ }r© (hX `queryMultiAdapter`hj h}rª (h
]h ]h]h ]h
]uh j h3]r« h<X queryMultiAdapterr¬
r }r® (hU h j¨ ubaubh<X to compute an adapter:r¯
r° }r± (hX to compute an adapter:h j ubeubhj)r² }r³ (hhhhmh}r´ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rµ hrah ]hs}h]uhMhh hXv >>> q = Q()
>>> m = registry.queryMultiAdapter((x, q), IM)
>>> m.__class__.__name__
'M'
>>> m.x is x and m.q is q
Trueh jp h3]r¶ h<Xv >>> q = Q()
>>> m = registry.queryMultiAdapter((x, q), IM)
>>> m.__class__.__name__
'M'
>>> m.x is x and m.q is q
Truer·
r¸ }r¹ (hU h j² ubaubh@)rº }r» (hhhhCh}r¼ (h
]h ]h]h ]h
]uhMhh hX! and, of course, we can use names:r½ h jp h3]r¾ h<X! and, of course, we can use names:r¿
rÀ }rÁ (hj½ h jº ubaubhj)r }rà (hhhhmh}rÄ (h ]hohph
]U testnodetypeX doctesth
]Ugroups]rÅ hrah ]hs}h]uhMhh hX¿ >>> class M2(M):
... pass
>>> registry.register([IR, IQ], IM, 'bob', M2)
>>> m = registry.queryMultiAdapter((x, q), IM, 'bob')
>>> m.__class__.__name__
'M2'
>>> m.x is x and m.q is q
Trueh jp h3]rÆ h<X¿ >>> class M2(M):
... pass
>>> registry.register([IR, IQ], IM, 'bob', M2)
>>> m = registry.queryMultiAdapter((x, q), IM, 'bob')
>>> m.__class__.__name__
'M2'
>>> m.x is x and m.q is q
TruerÇ
rÈ }rÉ (hU h j ubaubeubh eubj5 Kh3]rÊ (h5)rË }rÌ (hhhh8h}rÍ (h
]h ]h]h ]h
]uhMªhh hX Default AdaptersrÎ h h h3]rÏ h<X Default AdaptersrÐ
rÑ }rÒ (hjÎ h jË ubaubh@)rÓ }rÔ (hhhhCh}rÕ (h
]h ]h]h ]h
]uhM¬hh hXj As with single adapters, you can define default adapters by specifying
None for the *first* specification:h h h3]rÖ (h<XT As with single adapters, you can define default adapters by specifying
None for the r×
rØ }rÙ (hXT As with single adapters, you can define default adapters by specifying
None for the h jÓ ubcdocutils.nodes
emphasis
rÚ )rÛ }rÜ (hX *first*hUemphasisrÝ h}rÞ (h
]h ]h]h ]h
]uh jÓ h3]rß h<X firstrà
rá }râ (hU h jÛ ubaubh<X specification:rã
rä }rå (hX specification:h jÓ ubeubhj)ræ }rç (hhhhmh}rè (h ]hohph
]U testnodetypeX doctesth
]Ugroups]ré hrah ]hs}h]uhM¯hh hX\ >>> registry.register([None, IQ], IP2, '', 'q2')
>>> registry.lookup([IS, IQ], IP2, '')
'q2'h h h3]rê h<X\ >>> registry.register([None, IQ], IP2, '', 'q2')
>>> registry.lookup([IS, IQ], IP2, '')
'q2'rë
rì }rí (hU h jæ ubaubeubh3]rî h@)rï }rð (hU hhCh}rñ (h
]h ]h]h ]h
]uh hh3]rò h<X3 Duplicate implicit target name: "default adapters".ró
rô }rõ (hU h jï ubaubaubaU
decorationrö NU citationsr÷ ]rø hU U nametypesrù }rú (js Nj; Nh0Nj Nj³ Nj| Nh)Nj NjÛ Nj3 Njû NjT Nj NX default adaptersrû Njt NjÓ NhVNuUsettingsrü (cdocutils.frontend
Values
rý orþ }rÿ (Upep_referencesr NU output_encoding_error_handlerr Ustrictr U
halt_levelr KU
source_urlr NU
dump_settingsr NUdoctitle_xformr Udump_pseudo_xmlr NU tab_widthr KU id_prefixr U h8NUembed_stylesheetr
U
docinfo_xformr KUfootnote_backlinksr KUerror_encodingr
UUTF-8r Uauto_id_prefixr Uidr U
language_coder Uenr U datestampr NUdump_transformsr NUoutput_encodingr Uutf-8r Uexit_status_levelr KUstrict_visitorr NU_disable_configr NUfile_insertion_enabledr U tracebackr Urecord_dependenciesr NUstrip_commentsr NUdebugr NU generatorr NUgettext_compactr Uenvr! NU
strip_classesr" NUpep_file_url_templater# Upep-%04dr$ U input_encoding_error_handlerr% j Uexpose_internalsr& NUrfc_referencesr' NU
toc_backlinksr( Uentryr) U trim_footnote_reference_spacer* U_sourcer+ h Uwarning_streamr, NUinput_encodingr- U utf-8-sigr. Usectsubtitle_xformr/ U source_linkr0 NUconfigr1 NU
sectnum_xformr2 KU error_encoding_error_handlerr3 Ubackslashreplacer4 U
_config_filesr5 ]Udump_internalsr6 NU smart_quotesr7 Ucloak_email_addressesr8 U raw_enabledr9 KUstrip_elements_with_classesr: NU pep_base_urlr; U https://www.python.org/dev/peps/r< U report_levelr= KU rfc_base_urlr> U https://tools.ietf.org/html/r? U _destinationr@ NUsyntax_highlightrA UlongrB ubUautofootnote_refsrC ]rD U
footnote_refsrE }rF Uid_startrG KU
citation_refsrH }rI Usymbol_footnote_refsrJ ]rK Utransform_messagesrL ]rM U footnotesrN ]rO UnameidsrP }rQ (js ju j; j= h0h2j j j³ jµ j| j~ h)h+j j jÛ jÝ j3 j5 jû jý jT jV j j jû Njt jv jÓ jÕ hVhXuUrefnamesrR }rS U transformerrT NUidsrU }rV (h2h,j5 j/ hXhRj j j~ jx jý j÷ jµ j¯ h+h%j4 j/ jÕ jÏ ju jo jV jP jÝ j× hh j= j7 j j jv jp j jÿ uUsymbol_footnotesrW ]rX hhUindirect_targetsrY ]rZ Usubstitution_namesr[ }r\ U current_liner] NUsubstitution_defsr^ }r_ Usymbol_footnote_startr` K Uautofootnote_startra KU
autofootnotesrb ]rc h3]rd h,aUcurrent_sourcere NUrefidsrf }rg ub.