test_registry.py 110 KB

1234567891011121314151617181920212223242526272829303132333435363738394041424344454647484950515253545556575859606162636465666768697071727374757677787980818283848586878889909192939495969798991001011021031041051061071081091101111121131141151161171181191201211221231241251261271281291301311321331341351361371381391401411421431441451461471481491501511521531541551561571581591601611621631641651661671681691701711721731741751761771781791801811821831841851861871881891901911921931941951961971981992002012022032042052062072082092102112122132142152162172182192202212222232242252262272282292302312322332342352362372382392402412422432442452462472482492502512522532542552562572582592602612622632642652662672682692702712722732742752762772782792802812822832842852862872882892902912922932942952962972982993003013023033043053063073083093103113123133143153163173183193203213223233243253263273283293303313323333343353363373383393403413423433443453463473483493503513523533543553563573583593603613623633643653663673683693703713723733743753763773783793803813823833843853863873883893903913923933943953963973983994004014024034044054064074084094104114124134144154164174184194204214224234244254264274284294304314324334344354364374384394404414424434444454464474484494504514524534544554564574584594604614624634644654664674684694704714724734744754764774784794804814824834844854864874884894904914924934944954964974984995005015025035045055065075085095105115125135145155165175185195205215225235245255265275285295305315325335345355365375385395405415425435445455465475485495505515525535545555565575585595605615625635645655665675685695705715725735745755765775785795805815825835845855865875885895905915925935945955965975985996006016026036046056066076086096106116126136146156166176186196206216226236246256266276286296306316326336346356366376386396406416426436446456466476486496506516526536546556566576586596606616626636646656666676686696706716726736746756766776786796806816826836846856866876886896906916926936946956966976986997007017027037047057067077087097107117127137147157167177187197207217227237247257267277287297307317327337347357367377387397407417427437447457467477487497507517527537547557567577587597607617627637647657667677687697707717727737747757767777787797807817827837847857867877887897907917927937947957967977987998008018028038048058068078088098108118128138148158168178188198208218228238248258268278288298308318328338348358368378388398408418428438448458468478488498508518528538548558568578588598608618628638648658668678688698708718728738748758768778788798808818828838848858868878888898908918928938948958968978988999009019029039049059069079089099109119129139149159169179189199209219229239249259269279289299309319329339349359369379389399409419429439449459469479489499509519529539549559569579589599609619629639649659669679689699709719729739749759769779789799809819829839849859869879889899909919929939949959969979989991000100110021003100410051006100710081009101010111012101310141015101610171018101910201021102210231024102510261027102810291030103110321033103410351036103710381039104010411042104310441045104610471048104910501051105210531054105510561057105810591060106110621063106410651066106710681069107010711072107310741075107610771078107910801081108210831084108510861087108810891090109110921093109410951096109710981099110011011102110311041105110611071108110911101111111211131114111511161117111811191120112111221123112411251126112711281129113011311132113311341135113611371138113911401141114211431144114511461147114811491150115111521153115411551156115711581159116011611162116311641165116611671168116911701171117211731174117511761177117811791180118111821183118411851186118711881189119011911192119311941195119611971198119912001201120212031204120512061207120812091210121112121213121412151216121712181219122012211222122312241225122612271228122912301231123212331234123512361237123812391240124112421243124412451246124712481249125012511252125312541255125612571258125912601261126212631264126512661267126812691270127112721273127412751276127712781279128012811282128312841285128612871288128912901291129212931294129512961297129812991300130113021303130413051306130713081309131013111312131313141315131613171318131913201321132213231324132513261327132813291330133113321333133413351336133713381339134013411342134313441345134613471348134913501351135213531354135513561357135813591360136113621363136413651366136713681369137013711372137313741375137613771378137913801381138213831384138513861387138813891390139113921393139413951396139713981399140014011402140314041405140614071408140914101411141214131414141514161417141814191420142114221423142414251426142714281429143014311432143314341435143614371438143914401441144214431444144514461447144814491450145114521453145414551456145714581459146014611462146314641465146614671468146914701471147214731474147514761477147814791480148114821483148414851486148714881489149014911492149314941495149614971498149915001501150215031504150515061507150815091510151115121513151415151516151715181519152015211522152315241525152615271528152915301531153215331534153515361537153815391540154115421543154415451546154715481549155015511552155315541555155615571558155915601561156215631564156515661567156815691570157115721573157415751576157715781579158015811582158315841585158615871588158915901591159215931594159515961597159815991600160116021603160416051606160716081609161016111612161316141615161616171618161916201621162216231624162516261627162816291630163116321633163416351636163716381639164016411642164316441645164616471648164916501651165216531654165516561657165816591660166116621663166416651666166716681669167016711672167316741675167616771678167916801681168216831684168516861687168816891690169116921693169416951696169716981699170017011702170317041705170617071708170917101711171217131714171517161717171817191720172117221723172417251726172717281729173017311732173317341735173617371738173917401741174217431744174517461747174817491750175117521753175417551756175717581759176017611762176317641765176617671768176917701771177217731774177517761777177817791780178117821783178417851786178717881789179017911792179317941795179617971798179918001801180218031804180518061807180818091810181118121813181418151816181718181819182018211822182318241825182618271828182918301831183218331834183518361837183818391840184118421843184418451846184718481849185018511852185318541855185618571858185918601861186218631864186518661867186818691870187118721873187418751876187718781879188018811882188318841885188618871888188918901891189218931894189518961897189818991900190119021903190419051906190719081909191019111912191319141915191619171918191919201921192219231924192519261927192819291930193119321933193419351936193719381939194019411942194319441945194619471948194919501951195219531954195519561957195819591960196119621963196419651966196719681969197019711972197319741975197619771978197919801981198219831984198519861987198819891990199119921993199419951996199719981999200020012002200320042005200620072008200920102011201220132014201520162017201820192020202120222023202420252026202720282029203020312032203320342035203620372038203920402041204220432044204520462047204820492050205120522053205420552056205720582059206020612062206320642065206620672068206920702071207220732074207520762077207820792080208120822083208420852086208720882089209020912092209320942095209620972098209921002101210221032104210521062107210821092110211121122113211421152116211721182119212021212122212321242125212621272128212921302131213221332134213521362137213821392140214121422143214421452146214721482149215021512152215321542155215621572158215921602161216221632164216521662167216821692170217121722173217421752176217721782179218021812182218321842185218621872188218921902191219221932194219521962197219821992200220122022203220422052206220722082209221022112212221322142215221622172218221922202221222222232224222522262227222822292230223122322233223422352236223722382239224022412242224322442245224622472248224922502251225222532254225522562257225822592260226122622263226422652266226722682269227022712272227322742275227622772278227922802281228222832284228522862287228822892290229122922293229422952296229722982299230023012302230323042305230623072308230923102311231223132314231523162317231823192320232123222323232423252326232723282329233023312332233323342335233623372338233923402341234223432344234523462347234823492350235123522353235423552356235723582359236023612362236323642365236623672368236923702371237223732374237523762377237823792380238123822383238423852386238723882389239023912392239323942395239623972398239924002401240224032404240524062407240824092410241124122413241424152416241724182419242024212422242324242425242624272428242924302431243224332434243524362437243824392440244124422443244424452446244724482449245024512452245324542455245624572458245924602461246224632464246524662467246824692470247124722473247424752476247724782479248024812482248324842485248624872488248924902491249224932494249524962497249824992500250125022503250425052506250725082509251025112512251325142515251625172518251925202521252225232524252525262527252825292530253125322533253425352536253725382539254025412542254325442545254625472548254925502551255225532554255525562557255825592560256125622563256425652566256725682569257025712572257325742575257625772578257925802581258225832584258525862587258825892590259125922593259425952596259725982599260026012602260326042605260626072608260926102611261226132614261526162617261826192620262126222623262426252626262726282629263026312632263326342635263626372638263926402641264226432644264526462647264826492650265126522653265426552656265726582659266026612662266326642665266626672668266926702671267226732674267526762677267826792680268126822683268426852686268726882689269026912692269326942695269626972698269927002701270227032704270527062707270827092710271127122713271427152716271727182719272027212722272327242725272627272728272927302731273227332734273527362737273827392740274127422743274427452746274727482749275027512752275327542755275627572758275927602761276227632764276527662767276827692770277127722773277427752776277727782779278027812782278327842785278627872788278927902791279227932794279527962797279827992800280128022803280428052806280728082809281028112812281328142815281628172818281928202821282228232824282528262827282828292830283128322833283428352836283728382839284028412842284328442845284628472848284928502851285228532854285528562857285828592860286128622863286428652866286728682869287028712872287328742875287628772878287928802881288228832884288528862887288828892890289128922893289428952896289728982899290029012902290329042905290629072908290929102911291229132914291529162917291829192920292129222923292429252926292729282929293029312932293329342935293629372938293929402941294229432944294529462947294829492950295129522953295429552956295729582959296029612962296329642965296629672968296929702971297229732974297529762977297829792980298129822983298429852986298729882989299029912992299329942995299629972998299930003001300230033004300530063007300830093010301130123013301430153016301730183019302030213022302330243025302630273028302930303031303230333034303530363037303830393040304130423043304430453046304730483049305030513052305330543055305630573058305930603061306230633064306530663067306830693070307130723073307430753076307730783079308030813082308330843085308630873088308930903091309230933094309530963097309830993100310131023103310431053106310731083109311031113112311331143115311631173118311931203121312231233124312531263127312831293130313131323133313431353136313731383139314031413142314331443145314631473148314931503151315231533154315531563157315831593160316131623163316431653166316731683169317031713172317331743175317631773178317931803181318231833184318531863187318831893190319131923193319431953196319731983199320032013202320332043205320632073208320932103211321232133214321532163217321832193220322132223223322432253226322732283229323032313232323332343235323632373238323932403241324232433244324532463247324832493250325132523253325432553256325732583259326032613262326332643265326632673268326932703271327232733274327532763277327832793280328132823283328432853286328732883289329032913292329332943295329632973298329933003301330233033304330533063307330833093310331133123313331433153316331733183319332033213322332333243325332633273328332933303331333233333334333533363337333833393340334133423343334433453346334733483349335033513352335333543355335633573358335933603361336233633364336533663367336833693370337133723373337433753376337733783379338033813382338333843385338633873388338933903391
  1. ##############################################################################
  2. #
  3. # Copyright (c) 2001, 2002, 2009 Zope Foundation and Contributors.
  4. # All Rights Reserved.
  5. #
  6. # This software is subject to the provisions of the Zope Public License,
  7. # Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
  8. # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
  9. # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
  10. # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
  11. # FOR A PARTICULAR PURPOSE.
  12. #
  13. ##############################################################################
  14. """Component Registry Tests"""
  15. # pylint:disable=protected-access
  16. import unittest
  17. from zope.interface import Interface
  18. from zope.interface.adapter import VerifyingAdapterRegistry
  19. from zope.interface.registry import Components
  20. class ComponentsTests(unittest.TestCase):
  21. def _getTargetClass(self):
  22. return Components
  23. def _makeOne(self, name='test', *args, **kw):
  24. return self._getTargetClass()(name, *args, **kw)
  25. def _wrapEvents(self):
  26. from zope.interface import registry
  27. _events = []
  28. def _notify(*args, **kw):
  29. _events.append((args, kw))
  30. _monkey = _Monkey(registry, notify=_notify)
  31. return _monkey, _events
  32. def test_ctor_no_bases(self):
  33. from zope.interface.adapter import AdapterRegistry
  34. comp = self._makeOne('testing')
  35. self.assertEqual(comp.__name__, 'testing')
  36. self.assertEqual(comp.__bases__, ())
  37. self.assertIsInstance(comp.adapters, AdapterRegistry)
  38. self.assertIsInstance(comp.utilities, AdapterRegistry)
  39. self.assertEqual(comp.adapters.__bases__, ())
  40. self.assertEqual(comp.utilities.__bases__, ())
  41. self.assertEqual(comp._utility_registrations, {})
  42. self.assertEqual(comp._adapter_registrations, {})
  43. self.assertEqual(comp._subscription_registrations, [])
  44. self.assertEqual(comp._handler_registrations, [])
  45. def test_ctor_w_base(self):
  46. base = self._makeOne('base')
  47. comp = self._makeOne('testing', (base,))
  48. self.assertEqual(comp.__name__, 'testing')
  49. self.assertEqual(comp.__bases__, (base,))
  50. self.assertEqual(comp.adapters.__bases__, (base.adapters,))
  51. self.assertEqual(comp.utilities.__bases__, (base.utilities,))
  52. def test___repr__(self):
  53. comp = self._makeOne('testing')
  54. self.assertEqual(repr(comp), '<Components testing>')
  55. # test _init_registries / _init_registrations via only caller, __init__.
  56. def test_assign_to___bases__(self):
  57. base1 = self._makeOne('base1')
  58. base2 = self._makeOne('base2')
  59. comp = self._makeOne()
  60. comp.__bases__ = (base1, base2)
  61. self.assertEqual(comp.__bases__, (base1, base2))
  62. self.assertEqual(comp.adapters.__bases__,
  63. (base1.adapters, base2.adapters))
  64. self.assertEqual(comp.utilities.__bases__,
  65. (base1.utilities, base2.utilities))
  66. def test_registerUtility_with_component_name(self):
  67. from zope.interface.declarations import InterfaceClass
  68. from zope.interface.declarations import named
  69. class IFoo(InterfaceClass):
  70. pass
  71. ifoo = IFoo('IFoo')
  72. @named('foo')
  73. class Foo:
  74. pass
  75. foo = Foo()
  76. _info = 'info'
  77. comp = self._makeOne()
  78. comp.registerUtility(foo, ifoo, info=_info)
  79. self.assertEqual(
  80. comp._utility_registrations[ifoo, 'foo'],
  81. (foo, _info, None))
  82. def test_registerUtility_both_factory_and_component(self):
  83. def _factory():
  84. raise NotImplementedError()
  85. _to_reg = object()
  86. comp = self._makeOne()
  87. self.assertRaises(TypeError, comp.registerUtility,
  88. component=_to_reg, factory=_factory)
  89. def test_registerUtility_w_component(self):
  90. from zope.interface.declarations import InterfaceClass
  91. from zope.interface.interfaces import Registered
  92. from zope.interface.registry import UtilityRegistration
  93. class IFoo(InterfaceClass):
  94. pass
  95. ifoo = IFoo('IFoo')
  96. _info = 'info'
  97. _name = 'name'
  98. _to_reg = object()
  99. comp = self._makeOne()
  100. _monkey, _events = self._wrapEvents()
  101. with _monkey:
  102. comp.registerUtility(_to_reg, ifoo, _name, _info)
  103. self.assertIs(comp.utilities._adapters[0][ifoo][_name], _to_reg)
  104. self.assertEqual(comp._utility_registrations[ifoo, _name],
  105. (_to_reg, _info, None))
  106. self.assertEqual(comp.utilities._subscribers[0][ifoo][''], (_to_reg,))
  107. self.assertEqual(len(_events), 1)
  108. args, kw = _events[0]
  109. event, = args
  110. self.assertEqual(kw, {})
  111. self.assertIsInstance(event, Registered)
  112. self.assertIsInstance(event.object, UtilityRegistration)
  113. self.assertIs(event.object.registry, comp)
  114. self.assertIs(event.object.provided, ifoo)
  115. self.assertIs(event.object.name, _name)
  116. self.assertIs(event.object.component, _to_reg)
  117. self.assertIs(event.object.info, _info)
  118. self.assertIsNone(event.object.factory)
  119. def test_registerUtility_w_factory(self):
  120. from zope.interface.declarations import InterfaceClass
  121. from zope.interface.interfaces import Registered
  122. from zope.interface.registry import UtilityRegistration
  123. class IFoo(InterfaceClass):
  124. pass
  125. ifoo = IFoo('IFoo')
  126. _info = 'info'
  127. _name = 'name'
  128. _to_reg = object()
  129. def _factory():
  130. return _to_reg
  131. comp = self._makeOne()
  132. _monkey, _events = self._wrapEvents()
  133. with _monkey:
  134. comp.registerUtility(None, ifoo, _name, _info, factory=_factory)
  135. self.assertEqual(len(_events), 1)
  136. args, kw = _events[0]
  137. event, = args
  138. self.assertEqual(kw, {})
  139. self.assertIsInstance(event, Registered)
  140. self.assertIsInstance(event.object, UtilityRegistration)
  141. self.assertIs(event.object.registry, comp)
  142. self.assertIs(event.object.provided, ifoo)
  143. self.assertIs(event.object.name, _name)
  144. self.assertIs(event.object.component, _to_reg)
  145. self.assertIs(event.object.info, _info)
  146. self.assertIs(event.object.factory, _factory)
  147. def test_registerUtility_no_provided_available(self):
  148. class Foo:
  149. pass
  150. _info = 'info'
  151. _name = 'name'
  152. _to_reg = Foo()
  153. comp = self._makeOne()
  154. self.assertRaises(TypeError,
  155. comp.registerUtility, _to_reg, None, _name, _info)
  156. def test_registerUtility_wo_provided(self):
  157. from zope.interface.declarations import InterfaceClass
  158. from zope.interface.declarations import directlyProvides
  159. from zope.interface.interfaces import Registered
  160. from zope.interface.registry import UtilityRegistration
  161. class IFoo(InterfaceClass):
  162. pass
  163. class Foo:
  164. pass
  165. ifoo = IFoo('IFoo')
  166. _info = 'info'
  167. _name = 'name'
  168. _to_reg = Foo()
  169. directlyProvides(_to_reg, ifoo)
  170. comp = self._makeOne()
  171. _monkey, _events = self._wrapEvents()
  172. with _monkey:
  173. comp.registerUtility(_to_reg, None, _name, _info)
  174. self.assertEqual(len(_events), 1)
  175. args, kw = _events[0]
  176. event, = args
  177. self.assertEqual(kw, {})
  178. self.assertIsInstance(event, Registered)
  179. self.assertIsInstance(event.object, UtilityRegistration)
  180. self.assertIs(event.object.registry, comp)
  181. self.assertIs(event.object.provided, ifoo)
  182. self.assertIs(event.object.name, _name)
  183. self.assertIs(event.object.component, _to_reg)
  184. self.assertIs(event.object.info, _info)
  185. self.assertIsNone(event.object.factory)
  186. def test_registerUtility_duplicates_existing_reg(self):
  187. from zope.interface.declarations import InterfaceClass
  188. class IFoo(InterfaceClass):
  189. pass
  190. ifoo = IFoo('IFoo')
  191. _info = 'info'
  192. _name = 'name'
  193. _to_reg = object()
  194. comp = self._makeOne()
  195. comp.registerUtility(_to_reg, ifoo, _name, _info)
  196. _monkey, _events = self._wrapEvents()
  197. with _monkey:
  198. comp.registerUtility(_to_reg, ifoo, _name, _info)
  199. self.assertEqual(len(_events), 0)
  200. def test_registerUtility_w_different_info(self):
  201. from zope.interface.declarations import InterfaceClass
  202. class IFoo(InterfaceClass):
  203. pass
  204. ifoo = IFoo('IFoo')
  205. _info1 = 'info1'
  206. _info2 = 'info2'
  207. _name = 'name'
  208. _to_reg = object()
  209. comp = self._makeOne()
  210. comp.registerUtility(_to_reg, ifoo, _name, _info1)
  211. _monkey, _events = self._wrapEvents()
  212. with _monkey:
  213. comp.registerUtility(_to_reg, ifoo, _name, _info2)
  214. self.assertEqual(len(_events), 2) # unreg, reg
  215. self.assertEqual(comp._utility_registrations[(ifoo, _name)],
  216. (_to_reg, _info2, None)) # replaced
  217. self.assertEqual(comp.utilities._subscribers[0][ifoo][''],
  218. (_to_reg,))
  219. def test_registerUtility_w_different_names_same_component(self):
  220. from zope.interface.declarations import InterfaceClass
  221. class IFoo(InterfaceClass):
  222. pass
  223. ifoo = IFoo('IFoo')
  224. _info = 'info'
  225. _name1 = 'name1'
  226. _name2 = 'name2'
  227. _other_reg = object()
  228. _to_reg = object()
  229. comp = self._makeOne()
  230. comp.registerUtility(_other_reg, ifoo, _name1, _info)
  231. _monkey, _events = self._wrapEvents()
  232. with _monkey:
  233. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  234. self.assertEqual(len(_events), 1) # reg
  235. self.assertEqual(comp._utility_registrations[(ifoo, _name1)],
  236. (_other_reg, _info, None))
  237. self.assertEqual(comp._utility_registrations[(ifoo, _name2)],
  238. (_to_reg, _info, None))
  239. self.assertEqual(comp.utilities._subscribers[0][ifoo][''],
  240. (_other_reg, _to_reg,))
  241. def test_registerUtility_replaces_existing_reg(self):
  242. from zope.interface.declarations import InterfaceClass
  243. from zope.interface.interfaces import Registered
  244. from zope.interface.interfaces import Unregistered
  245. from zope.interface.registry import UtilityRegistration
  246. class IFoo(InterfaceClass):
  247. pass
  248. ifoo = IFoo('IFoo')
  249. _info = 'info'
  250. _name = 'name'
  251. _before, _after = object(), object()
  252. comp = self._makeOne()
  253. comp.registerUtility(_before, ifoo, _name, _info)
  254. _monkey, _events = self._wrapEvents()
  255. with _monkey:
  256. comp.registerUtility(_after, ifoo, _name, _info)
  257. self.assertEqual(len(_events), 2)
  258. args, kw = _events[0]
  259. event, = args
  260. self.assertEqual(kw, {})
  261. self.assertIsInstance(event, Unregistered)
  262. self.assertIsInstance(event.object, UtilityRegistration)
  263. self.assertIs(event.object.registry, comp)
  264. self.assertIs(event.object.provided, ifoo)
  265. self.assertIs(event.object.name, _name)
  266. self.assertIs(event.object.component, _before)
  267. self.assertIs(event.object.info, _info)
  268. self.assertIsNone(event.object.factory)
  269. args, kw = _events[1]
  270. event, = args
  271. self.assertEqual(kw, {})
  272. self.assertIsInstance(event, Registered)
  273. self.assertIsInstance(event.object, UtilityRegistration)
  274. self.assertIs(event.object.registry, comp)
  275. self.assertIs(event.object.provided, ifoo)
  276. self.assertIs(event.object.name, _name)
  277. self.assertIs(event.object.component, _after)
  278. self.assertIs(event.object.info, _info)
  279. self.assertIsNone(event.object.factory)
  280. def test_registerUtility_w_existing_subscr(self):
  281. from zope.interface.declarations import InterfaceClass
  282. class IFoo(InterfaceClass):
  283. pass
  284. ifoo = IFoo('IFoo')
  285. _info = 'info'
  286. _name1 = 'name1'
  287. _name2 = 'name2'
  288. _to_reg = object()
  289. comp = self._makeOne()
  290. comp.registerUtility(_to_reg, ifoo, _name1, _info)
  291. _monkey, _events = self._wrapEvents()
  292. with _monkey:
  293. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  294. self.assertEqual(comp.utilities._subscribers[0][ifoo][''], (_to_reg,))
  295. def test_registerUtility_wo_event(self):
  296. from zope.interface.declarations import InterfaceClass
  297. class IFoo(InterfaceClass):
  298. pass
  299. ifoo = IFoo('IFoo')
  300. _info = 'info'
  301. _name = 'name'
  302. _to_reg = object()
  303. comp = self._makeOne()
  304. _monkey, _events = self._wrapEvents()
  305. with _monkey:
  306. comp.registerUtility(_to_reg, ifoo, _name, _info, False)
  307. self.assertEqual(len(_events), 0)
  308. def test_registerUtility_changes_object_identity_after(self):
  309. # If a subclass changes the identity of the _utility_registrations,
  310. # the cache is updated and the right thing still happens.
  311. class CompThatChangesAfter1Reg(self._getTargetClass()):
  312. reg_count = 0
  313. def registerUtility(self, *args):
  314. self.reg_count += 1
  315. super().registerUtility(*args)
  316. if self.reg_count == 1:
  317. self._utility_registrations = dict(
  318. self._utility_registrations
  319. )
  320. comp = CompThatChangesAfter1Reg()
  321. comp.registerUtility(object(), Interface)
  322. self.assertEqual(len(list(comp.registeredUtilities())), 1)
  323. class IFoo(Interface):
  324. pass
  325. comp.registerUtility(object(), IFoo)
  326. self.assertEqual(len(list(comp.registeredUtilities())), 2)
  327. def test_registerUtility_changes_object_identity_before(self):
  328. # If a subclass changes the identity of the _utility_registrations,
  329. # the cache is updated and the right thing still happens.
  330. class CompThatChangesAfter2Reg(self._getTargetClass()):
  331. reg_count = 0
  332. def registerUtility(self, *args):
  333. self.reg_count += 1
  334. if self.reg_count == 2:
  335. self._utility_registrations = dict(
  336. self._utility_registrations
  337. )
  338. super().registerUtility(*args)
  339. comp = CompThatChangesAfter2Reg()
  340. comp.registerUtility(object(), Interface)
  341. self.assertEqual(len(list(comp.registeredUtilities())), 1)
  342. class IFoo(Interface):
  343. pass
  344. comp.registerUtility(object(), IFoo)
  345. self.assertEqual(len(list(comp.registeredUtilities())), 2)
  346. class IBar(Interface):
  347. pass
  348. comp.registerUtility(object(), IBar)
  349. self.assertEqual(len(list(comp.registeredUtilities())), 3)
  350. def test_unregisterUtility_wo_factory_nor_component_nor_provided(self):
  351. comp = self._makeOne()
  352. self.assertRaises(TypeError, comp.unregisterUtility,
  353. component=None, provided=None, factory=None)
  354. def test_unregisterUtility_both_factory_and_component(self):
  355. def _factory():
  356. raise NotImplementedError()
  357. _to_reg = object()
  358. comp = self._makeOne()
  359. self.assertRaises(TypeError, comp.unregisterUtility,
  360. component=_to_reg, factory=_factory)
  361. def test_unregisterUtility_w_component_miss(self):
  362. from zope.interface.declarations import InterfaceClass
  363. class IFoo(InterfaceClass):
  364. pass
  365. ifoo = IFoo('IFoo')
  366. _name = 'name'
  367. _to_reg = object()
  368. comp = self._makeOne()
  369. _monkey, _events = self._wrapEvents()
  370. with _monkey:
  371. unreg = comp.unregisterUtility(_to_reg, ifoo, _name)
  372. self.assertFalse(unreg)
  373. self.assertFalse(_events)
  374. def test_unregisterUtility_w_component(self):
  375. from zope.interface.declarations import InterfaceClass
  376. from zope.interface.interfaces import Unregistered
  377. from zope.interface.registry import UtilityRegistration
  378. class IFoo(InterfaceClass):
  379. pass
  380. ifoo = IFoo('IFoo')
  381. _name = 'name'
  382. _to_reg = object()
  383. comp = self._makeOne()
  384. comp.registerUtility(_to_reg, ifoo, _name)
  385. _monkey, _events = self._wrapEvents()
  386. with _monkey:
  387. unreg = comp.unregisterUtility(_to_reg, ifoo, _name)
  388. self.assertTrue(unreg)
  389. self.assertFalse(comp.utilities._adapters) # all erased
  390. self.assertNotIn((ifoo, _name), comp._utility_registrations)
  391. self.assertFalse(comp.utilities._subscribers)
  392. self.assertEqual(len(_events), 1)
  393. args, kw = _events[0]
  394. event, = args
  395. self.assertEqual(kw, {})
  396. self.assertIsInstance(event, Unregistered)
  397. self.assertIsInstance(event.object, UtilityRegistration)
  398. self.assertIs(event.object.registry, comp)
  399. self.assertIs(event.object.provided, ifoo)
  400. self.assertIs(event.object.name, _name)
  401. self.assertIs(event.object.component, _to_reg)
  402. self.assertIsNone(event.object.factory)
  403. def test_unregisterUtility_w_factory(self):
  404. from zope.interface.declarations import InterfaceClass
  405. from zope.interface.interfaces import Unregistered
  406. from zope.interface.registry import UtilityRegistration
  407. class IFoo(InterfaceClass):
  408. pass
  409. ifoo = IFoo('IFoo')
  410. _info = 'info'
  411. _name = 'name'
  412. _to_reg = object()
  413. def _factory():
  414. return _to_reg
  415. comp = self._makeOne()
  416. comp.registerUtility(None, ifoo, _name, _info, factory=_factory)
  417. _monkey, _events = self._wrapEvents()
  418. with _monkey:
  419. unreg = comp.unregisterUtility(None, ifoo, _name, factory=_factory)
  420. self.assertTrue(unreg)
  421. self.assertEqual(len(_events), 1)
  422. args, kw = _events[0]
  423. event, = args
  424. self.assertEqual(kw, {})
  425. self.assertIsInstance(event, Unregistered)
  426. self.assertIsInstance(event.object, UtilityRegistration)
  427. self.assertIs(event.object.registry, comp)
  428. self.assertIs(event.object.provided, ifoo)
  429. self.assertIs(event.object.name, _name)
  430. self.assertIs(event.object.component, _to_reg)
  431. self.assertIs(event.object.factory, _factory)
  432. def test_unregisterUtility_wo_explicit_provided(self):
  433. from zope.interface.declarations import InterfaceClass
  434. from zope.interface.declarations import directlyProvides
  435. from zope.interface.interfaces import Unregistered
  436. from zope.interface.registry import UtilityRegistration
  437. class IFoo(InterfaceClass):
  438. pass
  439. class Foo:
  440. pass
  441. ifoo = IFoo('IFoo')
  442. _info = 'info'
  443. _name = 'name'
  444. _to_reg = Foo()
  445. directlyProvides(_to_reg, ifoo)
  446. comp = self._makeOne()
  447. comp.registerUtility(_to_reg, ifoo, _name, _info)
  448. _monkey, _events = self._wrapEvents()
  449. with _monkey:
  450. unreg = comp.unregisterUtility(_to_reg, None, _name)
  451. self.assertTrue(unreg)
  452. self.assertEqual(len(_events), 1)
  453. args, kw = _events[0]
  454. event, = args
  455. self.assertEqual(kw, {})
  456. self.assertIsInstance(event, Unregistered)
  457. self.assertIsInstance(event.object, UtilityRegistration)
  458. self.assertIs(event.object.registry, comp)
  459. self.assertIs(event.object.provided, ifoo)
  460. self.assertIs(event.object.name, _name)
  461. self.assertIs(event.object.component, _to_reg)
  462. self.assertIs(event.object.info, _info)
  463. self.assertIsNone(event.object.factory)
  464. def test_unregisterUtility_wo_component_or_factory(self):
  465. from zope.interface.declarations import InterfaceClass
  466. from zope.interface.declarations import directlyProvides
  467. from zope.interface.interfaces import Unregistered
  468. from zope.interface.registry import UtilityRegistration
  469. class IFoo(InterfaceClass):
  470. pass
  471. class Foo:
  472. pass
  473. ifoo = IFoo('IFoo')
  474. _info = 'info'
  475. _name = 'name'
  476. _to_reg = Foo()
  477. directlyProvides(_to_reg, ifoo)
  478. comp = self._makeOne()
  479. comp.registerUtility(_to_reg, ifoo, _name, _info)
  480. _monkey, _events = self._wrapEvents()
  481. with _monkey:
  482. # Just pass the interface / name
  483. unreg = comp.unregisterUtility(provided=ifoo, name=_name)
  484. self.assertTrue(unreg)
  485. self.assertEqual(len(_events), 1)
  486. args, kw = _events[0]
  487. event, = args
  488. self.assertEqual(kw, {})
  489. self.assertIsInstance(event, Unregistered)
  490. self.assertIsInstance(event.object, UtilityRegistration)
  491. self.assertIs(event.object.registry, comp)
  492. self.assertIs(event.object.provided, ifoo)
  493. self.assertIs(event.object.name, _name)
  494. self.assertIs(event.object.component, _to_reg)
  495. self.assertIs(event.object.info, _info)
  496. self.assertIsNone(event.object.factory)
  497. def test_unregisterUtility_w_existing_subscr(self):
  498. from zope.interface.declarations import InterfaceClass
  499. class IFoo(InterfaceClass):
  500. pass
  501. ifoo = IFoo('IFoo')
  502. _info = 'info'
  503. _name1 = 'name1'
  504. _name2 = 'name2'
  505. _to_reg = object()
  506. comp = self._makeOne()
  507. comp.registerUtility(_to_reg, ifoo, _name1, _info)
  508. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  509. _monkey, _events = self._wrapEvents()
  510. with _monkey:
  511. comp.unregisterUtility(_to_reg, ifoo, _name2)
  512. self.assertEqual(comp.utilities._subscribers[0][ifoo][''], (_to_reg,))
  513. def test_unregisterUtility_w_existing_subscr_non_hashable(self):
  514. from zope.interface.declarations import InterfaceClass
  515. class IFoo(InterfaceClass):
  516. pass
  517. ifoo = IFoo('IFoo')
  518. _info = 'info'
  519. _name1 = 'name1'
  520. _name2 = 'name2'
  521. _to_reg = dict()
  522. comp = self._makeOne()
  523. comp.registerUtility(_to_reg, ifoo, _name1, _info)
  524. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  525. _monkey, _events = self._wrapEvents()
  526. with _monkey:
  527. comp.unregisterUtility(_to_reg, ifoo, _name2)
  528. self.assertEqual(comp.utilities._subscribers[0][ifoo][''], (_to_reg,))
  529. def test_unregisterUtility_w_existing_subs_non_hashable_fresh_cache(self):
  530. # We correctly populate the cache of registrations if it has gone away
  531. # (for example, the Components was unpickled)
  532. from zope.interface.declarations import InterfaceClass
  533. from zope.interface.registry import _UtilityRegistrations
  534. class IFoo(InterfaceClass):
  535. pass
  536. ifoo = IFoo('IFoo')
  537. _info = 'info'
  538. _name1 = 'name1'
  539. _name2 = 'name2'
  540. _to_reg = dict()
  541. comp = self._makeOne()
  542. comp.registerUtility(_to_reg, ifoo, _name1, _info)
  543. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  544. _monkey, _events = self._wrapEvents()
  545. with _monkey:
  546. comp.unregisterUtility(_to_reg, ifoo, _name2)
  547. self.assertEqual(comp.utilities._subscribers[0][ifoo][''], (_to_reg,))
  548. def test_unregisterUtility_w_existing_subscr_non_hashable_reinitted(self):
  549. # We correctly populate the cache of registrations if the base objects
  550. # change out from under us
  551. from zope.interface.declarations import InterfaceClass
  552. class IFoo(InterfaceClass):
  553. pass
  554. ifoo = IFoo('IFoo')
  555. _info = 'info'
  556. _name1 = 'name1'
  557. _name2 = 'name2'
  558. _to_reg = dict()
  559. comp = self._makeOne()
  560. comp.registerUtility(_to_reg, ifoo, _name1, _info)
  561. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  562. # zope.component.testing does this
  563. comp.__init__('base')
  564. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  565. _monkey, _events = self._wrapEvents()
  566. with _monkey:
  567. # Nothing to do, but we don't break either
  568. comp.unregisterUtility(_to_reg, ifoo, _name2)
  569. self.assertEqual(0, len(comp.utilities._subscribers))
  570. def test_unregisterUtility_w_existing_subscr_other_component(self):
  571. from zope.interface.declarations import InterfaceClass
  572. class IFoo(InterfaceClass):
  573. pass
  574. ifoo = IFoo('IFoo')
  575. _info = 'info'
  576. _name1 = 'name1'
  577. _name2 = 'name2'
  578. _other_reg = object()
  579. _to_reg = object()
  580. comp = self._makeOne()
  581. comp.registerUtility(_other_reg, ifoo, _name1, _info)
  582. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  583. _monkey, _events = self._wrapEvents()
  584. with _monkey:
  585. comp.unregisterUtility(_to_reg, ifoo, _name2)
  586. self.assertEqual(comp.utilities._subscribers[0][ifoo][''],
  587. (_other_reg,))
  588. def test_unregisterUtility_w_existing_subscr_oter_comp_mixed_hash(self):
  589. from zope.interface.declarations import InterfaceClass
  590. class IFoo(InterfaceClass):
  591. pass
  592. ifoo = IFoo('IFoo')
  593. _info = 'info'
  594. _name1 = 'name1'
  595. _name2 = 'name2'
  596. # First register something hashable
  597. _other_reg = object()
  598. # Then it transfers to something unhashable
  599. _to_reg = dict()
  600. comp = self._makeOne()
  601. comp.registerUtility(_other_reg, ifoo, _name1, _info)
  602. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  603. _monkey, _events = self._wrapEvents()
  604. with _monkey:
  605. comp.unregisterUtility(_to_reg, ifoo, _name2)
  606. self.assertEqual(comp.utilities._subscribers[0][ifoo][''],
  607. (_other_reg,))
  608. def test_registeredUtilities_empty(self):
  609. comp = self._makeOne()
  610. self.assertEqual(list(comp.registeredUtilities()), [])
  611. def test_registeredUtilities_notempty(self):
  612. from zope.interface.declarations import InterfaceClass
  613. from zope.interface.registry import UtilityRegistration
  614. class IFoo(InterfaceClass):
  615. pass
  616. ifoo = IFoo('IFoo')
  617. _info = 'info'
  618. _name1 = 'name1'
  619. _name2 = 'name2'
  620. _to_reg = object()
  621. comp = self._makeOne()
  622. comp.registerUtility(_to_reg, ifoo, _name1, _info)
  623. comp.registerUtility(_to_reg, ifoo, _name2, _info)
  624. reg = sorted(comp.registeredUtilities(), key=lambda r: r.name)
  625. self.assertEqual(len(reg), 2)
  626. self.assertIsInstance(reg[0], UtilityRegistration)
  627. self.assertIs(reg[0].registry, comp)
  628. self.assertIs(reg[0].provided, ifoo)
  629. self.assertIs(reg[0].name, _name1)
  630. self.assertIs(reg[0].component, _to_reg)
  631. self.assertIs(reg[0].info, _info)
  632. self.assertIsNone(reg[0].factory)
  633. self.assertIsInstance(reg[1], UtilityRegistration)
  634. self.assertIs(reg[1].registry, comp)
  635. self.assertIs(reg[1].provided, ifoo)
  636. self.assertIs(reg[1].name, _name2)
  637. self.assertIs(reg[1].component, _to_reg)
  638. self.assertIs(reg[1].info, _info)
  639. self.assertIsNone(reg[1].factory)
  640. def test_queryUtility_miss_no_default(self):
  641. from zope.interface.declarations import InterfaceClass
  642. class IFoo(InterfaceClass):
  643. pass
  644. ifoo = IFoo('IFoo')
  645. comp = self._makeOne()
  646. self.assertIsNone(comp.queryUtility(ifoo))
  647. def test_queryUtility_miss_w_default(self):
  648. from zope.interface.declarations import InterfaceClass
  649. class IFoo(InterfaceClass):
  650. pass
  651. ifoo = IFoo('IFoo')
  652. comp = self._makeOne()
  653. _default = object()
  654. self.assertIs(comp.queryUtility(ifoo, default=_default), _default)
  655. def test_queryUtility_hit(self):
  656. from zope.interface.declarations import InterfaceClass
  657. class IFoo(InterfaceClass):
  658. pass
  659. ifoo = IFoo('IFoo')
  660. _to_reg = object()
  661. comp = self._makeOne()
  662. comp.registerUtility(_to_reg, ifoo)
  663. self.assertIs(comp.queryUtility(ifoo), _to_reg)
  664. def test_getUtility_miss(self):
  665. from zope.interface.declarations import InterfaceClass
  666. from zope.interface.interfaces import ComponentLookupError
  667. class IFoo(InterfaceClass):
  668. pass
  669. ifoo = IFoo('IFoo')
  670. comp = self._makeOne()
  671. self.assertRaises(ComponentLookupError, comp.getUtility, ifoo)
  672. def test_getUtility_hit(self):
  673. from zope.interface.declarations import InterfaceClass
  674. class IFoo(InterfaceClass):
  675. pass
  676. ifoo = IFoo('IFoo')
  677. _to_reg = object()
  678. comp = self._makeOne()
  679. comp.registerUtility(_to_reg, ifoo)
  680. self.assertIs(comp.getUtility(ifoo), _to_reg)
  681. def test_getUtilitiesFor_miss(self):
  682. from zope.interface.declarations import InterfaceClass
  683. class IFoo(InterfaceClass):
  684. pass
  685. ifoo = IFoo('IFoo')
  686. comp = self._makeOne()
  687. self.assertEqual(list(comp.getUtilitiesFor(ifoo)), [])
  688. def test_getUtilitiesFor_hit(self):
  689. from zope.interface.declarations import InterfaceClass
  690. class IFoo(InterfaceClass):
  691. pass
  692. ifoo = IFoo('IFoo')
  693. _name1 = 'name1'
  694. _name2 = 'name2'
  695. _to_reg = object()
  696. comp = self._makeOne()
  697. comp.registerUtility(_to_reg, ifoo, name=_name1)
  698. comp.registerUtility(_to_reg, ifoo, name=_name2)
  699. self.assertEqual(sorted(comp.getUtilitiesFor(ifoo)),
  700. [(_name1, _to_reg), (_name2, _to_reg)])
  701. def test_getAllUtilitiesRegisteredFor_miss(self):
  702. from zope.interface.declarations import InterfaceClass
  703. class IFoo(InterfaceClass):
  704. pass
  705. ifoo = IFoo('IFoo')
  706. comp = self._makeOne()
  707. self.assertEqual(list(comp.getAllUtilitiesRegisteredFor(ifoo)), [])
  708. def test_getAllUtilitiesRegisteredFor_hit(self):
  709. from zope.interface.declarations import InterfaceClass
  710. class IFoo(InterfaceClass):
  711. pass
  712. ifoo = IFoo('IFoo')
  713. _name1 = 'name1'
  714. _name2 = 'name2'
  715. _to_reg = object()
  716. comp = self._makeOne()
  717. comp.registerUtility(_to_reg, ifoo, name=_name1)
  718. comp.registerUtility(_to_reg, ifoo, name=_name2)
  719. self.assertEqual(list(comp.getAllUtilitiesRegisteredFor(ifoo)),
  720. [_to_reg])
  721. def test_registerAdapter_with_component_name(self):
  722. from zope.interface.declarations import InterfaceClass
  723. from zope.interface.declarations import named
  724. class IFoo(InterfaceClass):
  725. pass
  726. ifoo = IFoo('IFoo')
  727. ibar = IFoo('IBar')
  728. @named('foo')
  729. class Foo:
  730. pass
  731. _info = 'info'
  732. comp = self._makeOne()
  733. comp.registerAdapter(Foo, (ibar,), ifoo, info=_info)
  734. self.assertEqual(
  735. comp._adapter_registrations[(ibar,), ifoo, 'foo'],
  736. (Foo, _info))
  737. def test_registerAdapter_w_explicit_provided_and_required(self):
  738. from zope.interface.declarations import InterfaceClass
  739. from zope.interface.interfaces import Registered
  740. from zope.interface.registry import AdapterRegistration
  741. class IFoo(InterfaceClass):
  742. pass
  743. ifoo = IFoo('IFoo')
  744. ibar = IFoo('IBar')
  745. _info = 'info'
  746. _name = 'name'
  747. def _factory(context):
  748. raise NotImplementedError()
  749. comp = self._makeOne()
  750. _monkey, _events = self._wrapEvents()
  751. with _monkey:
  752. comp.registerAdapter(_factory, (ibar,), ifoo, _name, _info)
  753. self.assertIs(
  754. comp.adapters._adapters[1][ibar][ifoo][_name],
  755. _factory
  756. )
  757. self.assertEqual(comp._adapter_registrations[(ibar,), ifoo, _name],
  758. (_factory, _info))
  759. self.assertEqual(len(_events), 1)
  760. args, kw = _events[0]
  761. event, = args
  762. self.assertEqual(kw, {})
  763. self.assertIsInstance(event, Registered)
  764. self.assertIsInstance(event.object, AdapterRegistration)
  765. self.assertIs(event.object.registry, comp)
  766. self.assertIs(event.object.provided, ifoo)
  767. self.assertEqual(event.object.required, (ibar,))
  768. self.assertIs(event.object.name, _name)
  769. self.assertIs(event.object.info, _info)
  770. self.assertIs(event.object.factory, _factory)
  771. def test_registerAdapter_no_provided_available(self):
  772. from zope.interface.declarations import InterfaceClass
  773. class IFoo(InterfaceClass):
  774. pass
  775. ibar = IFoo('IBar')
  776. _info = 'info'
  777. _name = 'name'
  778. class _Factory:
  779. pass
  780. comp = self._makeOne()
  781. self.assertRaises(TypeError, comp.registerAdapter, _Factory, (ibar,),
  782. name=_name, info=_info)
  783. def test_registerAdapter_wo_explicit_provided(self):
  784. from zope.interface.declarations import InterfaceClass
  785. from zope.interface.declarations import implementer
  786. from zope.interface.interfaces import Registered
  787. from zope.interface.registry import AdapterRegistration
  788. class IFoo(InterfaceClass):
  789. pass
  790. ifoo = IFoo('IFoo')
  791. ibar = IFoo('IBar')
  792. _info = 'info'
  793. _name = 'name'
  794. @implementer(ifoo)
  795. class _Factory:
  796. pass
  797. comp = self._makeOne()
  798. _monkey, _events = self._wrapEvents()
  799. with _monkey:
  800. comp.registerAdapter(_Factory, (ibar,), name=_name, info=_info)
  801. self.assertIs(
  802. comp.adapters._adapters[1][ibar][ifoo][_name],
  803. _Factory
  804. )
  805. self.assertEqual(comp._adapter_registrations[(ibar,), ifoo, _name],
  806. (_Factory, _info))
  807. self.assertEqual(len(_events), 1)
  808. args, kw = _events[0]
  809. event, = args
  810. self.assertEqual(kw, {})
  811. self.assertIsInstance(event, Registered)
  812. self.assertIsInstance(event.object, AdapterRegistration)
  813. self.assertIs(event.object.registry, comp)
  814. self.assertIs(event.object.provided, ifoo)
  815. self.assertEqual(event.object.required, (ibar,))
  816. self.assertIs(event.object.name, _name)
  817. self.assertIs(event.object.info, _info)
  818. self.assertIs(event.object.factory, _Factory)
  819. def test_registerAdapter_no_required_available(self):
  820. from zope.interface.declarations import InterfaceClass
  821. class IFoo(InterfaceClass):
  822. pass
  823. ifoo = IFoo('IFoo')
  824. _info = 'info'
  825. _name = 'name'
  826. class _Factory:
  827. pass
  828. comp = self._makeOne()
  829. self.assertRaises(TypeError, comp.registerAdapter, _Factory,
  830. provided=ifoo, name=_name, info=_info)
  831. def test_registerAdapter_w_invalid_required(self):
  832. from zope.interface.declarations import InterfaceClass
  833. class IFoo(InterfaceClass):
  834. pass
  835. ifoo = IFoo('IFoo')
  836. ibar = IFoo('IBar')
  837. _info = 'info'
  838. _name = 'name'
  839. class _Factory:
  840. pass
  841. comp = self._makeOne()
  842. self.assertRaises(TypeError, comp.registerAdapter, _Factory,
  843. ibar, provided=ifoo, name=_name, info=_info)
  844. def test_registerAdapter_w_required_containing_None(self):
  845. from zope.interface.declarations import InterfaceClass
  846. from zope.interface.interface import Interface
  847. from zope.interface.interfaces import Registered
  848. from zope.interface.registry import AdapterRegistration
  849. class IFoo(InterfaceClass):
  850. pass
  851. ifoo = IFoo('IFoo')
  852. _info = 'info'
  853. _name = 'name'
  854. class _Factory:
  855. pass
  856. comp = self._makeOne()
  857. _monkey, _events = self._wrapEvents()
  858. with _monkey:
  859. comp.registerAdapter(_Factory, [None], provided=ifoo,
  860. name=_name, info=_info)
  861. self.assertIs(
  862. comp.adapters._adapters[1][Interface][ifoo][_name],
  863. _Factory
  864. )
  865. self.assertEqual(
  866. comp._adapter_registrations[(Interface,), ifoo, _name],
  867. (_Factory, _info)
  868. )
  869. self.assertEqual(len(_events), 1)
  870. args, kw = _events[0]
  871. event, = args
  872. self.assertEqual(kw, {})
  873. self.assertIsInstance(event, Registered)
  874. self.assertIsInstance(event.object, AdapterRegistration)
  875. self.assertIs(event.object.registry, comp)
  876. self.assertIs(event.object.provided, ifoo)
  877. self.assertEqual(event.object.required, (Interface,))
  878. self.assertIs(event.object.name, _name)
  879. self.assertIs(event.object.info, _info)
  880. self.assertIs(event.object.factory, _Factory)
  881. def test_registerAdapter_w_required_containing_class(self):
  882. from zope.interface.declarations import InterfaceClass
  883. from zope.interface.declarations import implementedBy
  884. from zope.interface.declarations import implementer
  885. from zope.interface.interfaces import Registered
  886. from zope.interface.registry import AdapterRegistration
  887. class IFoo(InterfaceClass):
  888. pass
  889. ifoo = IFoo('IFoo')
  890. ibar = IFoo('IBar')
  891. _info = 'info'
  892. _name = 'name'
  893. class _Factory:
  894. pass
  895. @implementer(ibar)
  896. class _Context:
  897. pass
  898. _ctx_impl = implementedBy(_Context)
  899. comp = self._makeOne()
  900. _monkey, _events = self._wrapEvents()
  901. with _monkey:
  902. comp.registerAdapter(_Factory, [_Context], provided=ifoo,
  903. name=_name, info=_info)
  904. self.assertIs(
  905. comp.adapters._adapters[1][_ctx_impl][ifoo][_name],
  906. _Factory
  907. )
  908. self.assertEqual(
  909. comp._adapter_registrations[(_ctx_impl,), ifoo, _name],
  910. (_Factory, _info)
  911. )
  912. self.assertEqual(len(_events), 1)
  913. args, kw = _events[0]
  914. event, = args
  915. self.assertEqual(kw, {})
  916. self.assertIsInstance(event, Registered)
  917. self.assertIsInstance(event.object, AdapterRegistration)
  918. self.assertIs(event.object.registry, comp)
  919. self.assertIs(event.object.provided, ifoo)
  920. self.assertEqual(event.object.required, (_ctx_impl,))
  921. self.assertIs(event.object.name, _name)
  922. self.assertIs(event.object.info, _info)
  923. self.assertIs(event.object.factory, _Factory)
  924. def test_registerAdapter_w_required_containing_junk(self):
  925. from zope.interface.declarations import InterfaceClass
  926. class IFoo(InterfaceClass):
  927. pass
  928. ifoo = IFoo('IFoo')
  929. _info = 'info'
  930. _name = 'name'
  931. class _Factory:
  932. pass
  933. comp = self._makeOne()
  934. with self.assertRaises(TypeError):
  935. comp.registerAdapter(
  936. _Factory, [object()], provided=ifoo, name=_name, info=_info,
  937. )
  938. def test_registerAdapter_wo_explicit_required(self):
  939. from zope.interface.declarations import InterfaceClass
  940. from zope.interface.interfaces import Registered
  941. from zope.interface.registry import AdapterRegistration
  942. class IFoo(InterfaceClass):
  943. pass
  944. ifoo = IFoo('IFoo')
  945. ibar = IFoo('IBar')
  946. _info = 'info'
  947. _name = 'name'
  948. class _Factory:
  949. __component_adapts__ = (ibar,)
  950. comp = self._makeOne()
  951. _monkey, _events = self._wrapEvents()
  952. with _monkey:
  953. comp.registerAdapter(_Factory, provided=ifoo, name=_name,
  954. info=_info)
  955. self.assertIs(
  956. comp.adapters._adapters[1][ibar][ifoo][_name],
  957. _Factory
  958. )
  959. self.assertEqual(comp._adapter_registrations[(ibar,), ifoo, _name],
  960. (_Factory, _info))
  961. self.assertEqual(len(_events), 1)
  962. args, kw = _events[0]
  963. event, = args
  964. self.assertEqual(kw, {})
  965. self.assertIsInstance(event, Registered)
  966. self.assertIsInstance(event.object, AdapterRegistration)
  967. self.assertIs(event.object.registry, comp)
  968. self.assertIs(event.object.provided, ifoo)
  969. self.assertEqual(event.object.required, (ibar,))
  970. self.assertIs(event.object.name, _name)
  971. self.assertIs(event.object.info, _info)
  972. self.assertIs(event.object.factory, _Factory)
  973. def test_registerAdapter_wo_event(self):
  974. from zope.interface.declarations import InterfaceClass
  975. class IFoo(InterfaceClass):
  976. pass
  977. ifoo = IFoo('IFoo')
  978. ibar = IFoo('IBar')
  979. _info = 'info'
  980. _name = 'name'
  981. def _factory(context):
  982. raise NotImplementedError()
  983. comp = self._makeOne()
  984. _monkey, _events = self._wrapEvents()
  985. with _monkey:
  986. comp.registerAdapter(_factory, (ibar,), ifoo, _name, _info,
  987. event=False)
  988. self.assertEqual(len(_events), 0)
  989. def test_unregisterAdapter_neither_factory_nor_provided(self):
  990. comp = self._makeOne()
  991. self.assertRaises(TypeError, comp.unregisterAdapter,
  992. factory=None, provided=None)
  993. def test_unregisterAdapter_neither_factory_nor_required(self):
  994. from zope.interface.declarations import InterfaceClass
  995. class IFoo(InterfaceClass):
  996. pass
  997. ifoo = IFoo('IFoo')
  998. comp = self._makeOne()
  999. self.assertRaises(TypeError, comp.unregisterAdapter,
  1000. factory=None, provided=ifoo, required=None)
  1001. def test_unregisterAdapter_miss(self):
  1002. from zope.interface.declarations import InterfaceClass
  1003. class IFoo(InterfaceClass):
  1004. pass
  1005. ifoo = IFoo('IFoo')
  1006. ibar = IFoo('IBar')
  1007. class _Factory:
  1008. pass
  1009. comp = self._makeOne()
  1010. _monkey, _events = self._wrapEvents()
  1011. with _monkey:
  1012. unreg = comp.unregisterAdapter(_Factory, (ibar,), ifoo)
  1013. self.assertFalse(unreg)
  1014. def test_unregisterAdapter_hit_w_explicit_provided_and_required(self):
  1015. from zope.interface.declarations import InterfaceClass
  1016. from zope.interface.interfaces import Unregistered
  1017. from zope.interface.registry import AdapterRegistration
  1018. class IFoo(InterfaceClass):
  1019. pass
  1020. ifoo = IFoo('IFoo')
  1021. ibar = IFoo('IBar')
  1022. class _Factory:
  1023. pass
  1024. comp = self._makeOne()
  1025. comp.registerAdapter(_Factory, (ibar,), ifoo)
  1026. _monkey, _events = self._wrapEvents()
  1027. with _monkey:
  1028. unreg = comp.unregisterAdapter(_Factory, (ibar,), ifoo)
  1029. self.assertTrue(unreg)
  1030. self.assertFalse(comp.adapters._adapters)
  1031. self.assertFalse(comp._adapter_registrations)
  1032. self.assertEqual(len(_events), 1)
  1033. args, kw = _events[0]
  1034. event, = args
  1035. self.assertEqual(kw, {})
  1036. self.assertIsInstance(event, Unregistered)
  1037. self.assertIsInstance(event.object, AdapterRegistration)
  1038. self.assertIs(event.object.registry, comp)
  1039. self.assertIs(event.object.provided, ifoo)
  1040. self.assertEqual(event.object.required, (ibar,))
  1041. self.assertEqual(event.object.name, '')
  1042. self.assertEqual(event.object.info, '')
  1043. self.assertIs(event.object.factory, _Factory)
  1044. def test_unregisterAdapter_wo_explicit_provided(self):
  1045. from zope.interface.declarations import InterfaceClass
  1046. from zope.interface.declarations import implementer
  1047. from zope.interface.interfaces import Unregistered
  1048. from zope.interface.registry import AdapterRegistration
  1049. class IFoo(InterfaceClass):
  1050. pass
  1051. ifoo = IFoo('IFoo')
  1052. ibar = IFoo('IBar')
  1053. @implementer(ifoo)
  1054. class _Factory:
  1055. pass
  1056. comp = self._makeOne()
  1057. comp.registerAdapter(_Factory, (ibar,), ifoo)
  1058. _monkey, _events = self._wrapEvents()
  1059. with _monkey:
  1060. unreg = comp.unregisterAdapter(_Factory, (ibar,))
  1061. self.assertTrue(unreg)
  1062. self.assertEqual(len(_events), 1)
  1063. args, kw = _events[0]
  1064. event, = args
  1065. self.assertEqual(kw, {})
  1066. self.assertIsInstance(event, Unregistered)
  1067. self.assertIsInstance(event.object, AdapterRegistration)
  1068. self.assertIs(event.object.registry, comp)
  1069. self.assertIs(event.object.provided, ifoo)
  1070. self.assertEqual(event.object.required, (ibar,))
  1071. self.assertEqual(event.object.name, '')
  1072. self.assertEqual(event.object.info, '')
  1073. self.assertIs(event.object.factory, _Factory)
  1074. def test_unregisterAdapter_wo_explicit_required(self):
  1075. from zope.interface.declarations import InterfaceClass
  1076. from zope.interface.interfaces import Unregistered
  1077. from zope.interface.registry import AdapterRegistration
  1078. class IFoo(InterfaceClass):
  1079. pass
  1080. ifoo = IFoo('IFoo')
  1081. ibar = IFoo('IBar')
  1082. class _Factory:
  1083. __component_adapts__ = (ibar,)
  1084. comp = self._makeOne()
  1085. comp.registerAdapter(_Factory, (ibar,), ifoo)
  1086. _monkey, _events = self._wrapEvents()
  1087. with _monkey:
  1088. unreg = comp.unregisterAdapter(_Factory, provided=ifoo)
  1089. self.assertTrue(unreg)
  1090. self.assertEqual(len(_events), 1)
  1091. args, kw = _events[0]
  1092. event, = args
  1093. self.assertEqual(kw, {})
  1094. self.assertIsInstance(event, Unregistered)
  1095. self.assertIsInstance(event.object, AdapterRegistration)
  1096. self.assertIs(event.object.registry, comp)
  1097. self.assertIs(event.object.provided, ifoo)
  1098. self.assertEqual(event.object.required, (ibar,))
  1099. self.assertEqual(event.object.name, '')
  1100. self.assertEqual(event.object.info, '')
  1101. self.assertIs(event.object.factory, _Factory)
  1102. def test_registeredAdapters_empty(self):
  1103. comp = self._makeOne()
  1104. self.assertEqual(list(comp.registeredAdapters()), [])
  1105. def test_registeredAdapters_notempty(self):
  1106. from zope.interface.declarations import InterfaceClass
  1107. from zope.interface.registry import AdapterRegistration
  1108. class IFoo(InterfaceClass):
  1109. pass
  1110. ifoo = IFoo('IFoo')
  1111. ibar = IFoo('IFoo')
  1112. _info = 'info'
  1113. _name1 = 'name1'
  1114. _name2 = 'name2'
  1115. class _Factory:
  1116. pass
  1117. comp = self._makeOne()
  1118. comp.registerAdapter(_Factory, (ibar,), ifoo, _name1, _info)
  1119. comp.registerAdapter(_Factory, (ibar,), ifoo, _name2, _info)
  1120. reg = sorted(comp.registeredAdapters(), key=lambda r: r.name)
  1121. self.assertEqual(len(reg), 2)
  1122. self.assertIsInstance(reg[0], AdapterRegistration)
  1123. self.assertIs(reg[0].registry, comp)
  1124. self.assertIs(reg[0].provided, ifoo)
  1125. self.assertEqual(reg[0].required, (ibar,))
  1126. self.assertIs(reg[0].name, _name1)
  1127. self.assertIs(reg[0].info, _info)
  1128. self.assertIs(reg[0].factory, _Factory)
  1129. self.assertIsInstance(reg[1], AdapterRegistration)
  1130. self.assertIs(reg[1].registry, comp)
  1131. self.assertIs(reg[1].provided, ifoo)
  1132. self.assertEqual(reg[1].required, (ibar,))
  1133. self.assertIs(reg[1].name, _name2)
  1134. self.assertIs(reg[1].info, _info)
  1135. self.assertIs(reg[1].factory, _Factory)
  1136. def test_queryAdapter_miss_no_default(self):
  1137. from zope.interface.declarations import InterfaceClass
  1138. class IFoo(InterfaceClass):
  1139. pass
  1140. ifoo = IFoo('IFoo')
  1141. comp = self._makeOne()
  1142. _context = object()
  1143. self.assertIsNone(comp.queryAdapter(_context, ifoo))
  1144. def test_queryAdapter_miss_w_default(self):
  1145. from zope.interface.declarations import InterfaceClass
  1146. class IFoo(InterfaceClass):
  1147. pass
  1148. ifoo = IFoo('IFoo')
  1149. comp = self._makeOne()
  1150. _context = object()
  1151. _default = object()
  1152. self.assertIs(
  1153. comp.queryAdapter(_context, ifoo, default=_default),
  1154. _default
  1155. )
  1156. def test_queryAdapter_hit(self):
  1157. from zope.interface.declarations import InterfaceClass
  1158. from zope.interface.declarations import implementer
  1159. class IFoo(InterfaceClass):
  1160. pass
  1161. ifoo = IFoo('IFoo')
  1162. ibar = IFoo('IBar')
  1163. class _Factory:
  1164. def __init__(self, context):
  1165. self.context = context
  1166. @implementer(ibar)
  1167. class _Context:
  1168. pass
  1169. _context = _Context()
  1170. comp = self._makeOne()
  1171. comp.registerAdapter(_Factory, (ibar,), ifoo)
  1172. adapter = comp.queryAdapter(_context, ifoo)
  1173. self.assertIsInstance(adapter, _Factory)
  1174. self.assertIs(adapter.context, _context)
  1175. def test_getAdapter_miss(self):
  1176. from zope.interface.declarations import InterfaceClass
  1177. from zope.interface.declarations import implementer
  1178. from zope.interface.interfaces import ComponentLookupError
  1179. class IFoo(InterfaceClass):
  1180. pass
  1181. ifoo = IFoo('IFoo')
  1182. ibar = IFoo('IBar')
  1183. @implementer(ibar)
  1184. class _Context:
  1185. pass
  1186. _context = _Context()
  1187. comp = self._makeOne()
  1188. self.assertRaises(ComponentLookupError,
  1189. comp.getAdapter, _context, ifoo)
  1190. def test_getAdapter_hit(self):
  1191. from zope.interface.declarations import InterfaceClass
  1192. from zope.interface.declarations import implementer
  1193. class IFoo(InterfaceClass):
  1194. pass
  1195. ifoo = IFoo('IFoo')
  1196. ibar = IFoo('IBar')
  1197. class _Factory:
  1198. def __init__(self, context):
  1199. self.context = context
  1200. @implementer(ibar)
  1201. class _Context:
  1202. pass
  1203. _context = _Context()
  1204. comp = self._makeOne()
  1205. comp.registerAdapter(_Factory, (ibar,), ifoo)
  1206. adapter = comp.getAdapter(_context, ifoo)
  1207. self.assertIsInstance(adapter, _Factory)
  1208. self.assertIs(adapter.context, _context)
  1209. def test_getAdapter_hit_super(self):
  1210. from zope.interface import Interface
  1211. from zope.interface.declarations import implementer
  1212. class IBase(Interface):
  1213. pass
  1214. class IDerived(IBase):
  1215. pass
  1216. class IFoo(Interface):
  1217. pass
  1218. @implementer(IBase)
  1219. class Base:
  1220. pass
  1221. @implementer(IDerived)
  1222. class Derived(Base):
  1223. pass
  1224. class AdapterBase:
  1225. def __init__(self, context):
  1226. self.context = context
  1227. class AdapterDerived:
  1228. def __init__(self, context):
  1229. self.context = context
  1230. comp = self._makeOne()
  1231. comp.registerAdapter(AdapterDerived, (IDerived,), IFoo)
  1232. comp.registerAdapter(AdapterBase, (IBase,), IFoo)
  1233. self._should_not_change(comp)
  1234. derived = Derived()
  1235. adapter = comp.getAdapter(derived, IFoo)
  1236. self.assertIsInstance(adapter, AdapterDerived)
  1237. self.assertIs(adapter.context, derived)
  1238. supe = super(Derived, derived)
  1239. adapter = comp.getAdapter(supe, IFoo)
  1240. self.assertIsInstance(adapter, AdapterBase)
  1241. self.assertIs(adapter.context, derived)
  1242. def test_getAdapter_hit_super_w_parent_implements_interface_diamond(self):
  1243. from zope.interface import Interface
  1244. from zope.interface.declarations import implementer
  1245. class IBase(Interface):
  1246. pass
  1247. class IDerived(IBase):
  1248. pass
  1249. class IFoo(Interface):
  1250. pass
  1251. class Base:
  1252. pass
  1253. class Child1(Base):
  1254. pass
  1255. @implementer(IBase)
  1256. class Child2(Base):
  1257. pass
  1258. @implementer(IDerived)
  1259. class Derived(Child1, Child2):
  1260. pass
  1261. class AdapterBase:
  1262. def __init__(self, context):
  1263. self.context = context
  1264. class AdapterDerived:
  1265. def __init__(self, context):
  1266. self.context = context
  1267. comp = self._makeOne()
  1268. comp.registerAdapter(AdapterDerived, (IDerived,), IFoo)
  1269. comp.registerAdapter(AdapterBase, (IBase,), IFoo)
  1270. self._should_not_change(comp)
  1271. derived = Derived()
  1272. adapter = comp.getAdapter(derived, IFoo)
  1273. self.assertIsInstance(adapter, AdapterDerived)
  1274. self.assertIs(adapter.context, derived)
  1275. supe = super(Derived, derived)
  1276. adapter = comp.getAdapter(supe, IFoo)
  1277. self.assertIsInstance(adapter, AdapterBase)
  1278. self.assertIs(adapter.context, derived)
  1279. def test_queryMultiAdapter_miss(self):
  1280. from zope.interface.declarations import InterfaceClass
  1281. from zope.interface.declarations import implementer
  1282. class IFoo(InterfaceClass):
  1283. pass
  1284. ifoo = IFoo('IFoo')
  1285. ibar = IFoo('IBar')
  1286. ibaz = IFoo('IBaz')
  1287. @implementer(ibar)
  1288. class _Context1:
  1289. pass
  1290. @implementer(ibaz)
  1291. class _Context2:
  1292. pass
  1293. _context1 = _Context1()
  1294. _context2 = _Context2()
  1295. comp = self._makeOne()
  1296. self.assertEqual(comp.queryMultiAdapter((_context1, _context2), ifoo),
  1297. None)
  1298. def test_queryMultiAdapter_miss_w_default(self):
  1299. from zope.interface.declarations import InterfaceClass
  1300. from zope.interface.declarations import implementer
  1301. class IFoo(InterfaceClass):
  1302. pass
  1303. ifoo = IFoo('IFoo')
  1304. ibar = IFoo('IBar')
  1305. ibaz = IFoo('IBaz')
  1306. @implementer(ibar)
  1307. class _Context1:
  1308. pass
  1309. @implementer(ibaz)
  1310. class _Context2:
  1311. pass
  1312. _context1 = _Context1()
  1313. _context2 = _Context2()
  1314. _default = object()
  1315. comp = self._makeOne()
  1316. self.assertIs(
  1317. comp.queryMultiAdapter((_context1, _context2), ifoo,
  1318. default=_default),
  1319. _default
  1320. )
  1321. def test_queryMultiAdapter_hit(self):
  1322. from zope.interface.declarations import InterfaceClass
  1323. from zope.interface.declarations import implementer
  1324. class IFoo(InterfaceClass):
  1325. pass
  1326. ifoo = IFoo('IFoo')
  1327. ibar = IFoo('IBar')
  1328. ibaz = IFoo('IBaz')
  1329. @implementer(ibar)
  1330. class _Context1:
  1331. pass
  1332. @implementer(ibaz)
  1333. class _Context2:
  1334. pass
  1335. _context1 = _Context1()
  1336. _context2 = _Context2()
  1337. class _Factory:
  1338. def __init__(self, context1, context2):
  1339. self.context = context1, context2
  1340. comp = self._makeOne()
  1341. comp.registerAdapter(_Factory, (ibar, ibaz), ifoo)
  1342. adapter = comp.queryMultiAdapter((_context1, _context2), ifoo)
  1343. self.assertIsInstance(adapter, _Factory)
  1344. self.assertEqual(adapter.context, (_context1, _context2))
  1345. def test_getMultiAdapter_miss(self):
  1346. from zope.interface.declarations import InterfaceClass
  1347. from zope.interface.declarations import implementer
  1348. from zope.interface.interfaces import ComponentLookupError
  1349. class IFoo(InterfaceClass):
  1350. pass
  1351. ifoo = IFoo('IFoo')
  1352. ibar = IFoo('IBar')
  1353. ibaz = IFoo('IBaz')
  1354. @implementer(ibar)
  1355. class _Context1:
  1356. pass
  1357. @implementer(ibaz)
  1358. class _Context2:
  1359. pass
  1360. _context1 = _Context1()
  1361. _context2 = _Context2()
  1362. comp = self._makeOne()
  1363. self.assertRaises(ComponentLookupError,
  1364. comp.getMultiAdapter, (_context1, _context2), ifoo)
  1365. def test_getMultiAdapter_hit(self):
  1366. from zope.interface.declarations import InterfaceClass
  1367. from zope.interface.declarations import implementer
  1368. class IFoo(InterfaceClass):
  1369. pass
  1370. ifoo = IFoo('IFoo')
  1371. ibar = IFoo('IBar')
  1372. ibaz = IFoo('IBaz')
  1373. @implementer(ibar)
  1374. class _Context1:
  1375. pass
  1376. @implementer(ibaz)
  1377. class _Context2:
  1378. pass
  1379. _context1 = _Context1()
  1380. _context2 = _Context2()
  1381. class _Factory:
  1382. def __init__(self, context1, context2):
  1383. self.context = context1, context2
  1384. comp = self._makeOne()
  1385. comp.registerAdapter(_Factory, (ibar, ibaz), ifoo)
  1386. adapter = comp.getMultiAdapter((_context1, _context2), ifoo)
  1387. self.assertIsInstance(adapter, _Factory)
  1388. self.assertEqual(adapter.context, (_context1, _context2))
  1389. def _should_not_change(self, comp):
  1390. # Be sure that none of the underlying structures
  1391. # get told that they have changed during this process
  1392. # because that invalidates caches.
  1393. def no_changes(*args):
  1394. self.fail("Nothing should get changed")
  1395. comp.changed = no_changes
  1396. comp.adapters.changed = no_changes
  1397. comp.adapters._v_lookup.changed = no_changes
  1398. def test_getMultiAdapter_hit_super(self):
  1399. from zope.interface import Interface
  1400. from zope.interface.declarations import implementer
  1401. class IBase(Interface):
  1402. pass
  1403. class IDerived(IBase):
  1404. pass
  1405. class IFoo(Interface):
  1406. pass
  1407. @implementer(IBase)
  1408. class Base:
  1409. pass
  1410. @implementer(IDerived)
  1411. class Derived(Base):
  1412. pass
  1413. class AdapterBase:
  1414. def __init__(self, context1, context2):
  1415. self.context1 = context1
  1416. self.context2 = context2
  1417. class AdapterDerived(AdapterBase):
  1418. pass
  1419. comp = self._makeOne()
  1420. comp.registerAdapter(AdapterDerived, (IDerived, IDerived), IFoo)
  1421. comp.registerAdapter(AdapterBase, (IBase, IDerived), IFoo)
  1422. self._should_not_change(comp)
  1423. derived = Derived()
  1424. adapter = comp.getMultiAdapter((derived, derived), IFoo)
  1425. self.assertIsInstance(adapter, AdapterDerived)
  1426. self.assertIs(adapter.context1, derived)
  1427. self.assertIs(adapter.context2, derived)
  1428. supe = super(Derived, derived)
  1429. adapter = comp.getMultiAdapter((supe, derived), IFoo)
  1430. self.assertIsInstance(adapter, AdapterBase)
  1431. self.assertNotIsInstance(adapter, AdapterDerived)
  1432. self.assertIs(adapter.context1, derived)
  1433. self.assertIs(adapter.context2, derived)
  1434. def test_getAdapters_empty(self):
  1435. from zope.interface.declarations import InterfaceClass
  1436. from zope.interface.declarations import implementer
  1437. class IFoo(InterfaceClass):
  1438. pass
  1439. ifoo = IFoo('IFoo')
  1440. ibar = IFoo('IBar')
  1441. ibaz = IFoo('IBaz')
  1442. @implementer(ibar)
  1443. class _Context1:
  1444. pass
  1445. @implementer(ibaz)
  1446. class _Context2:
  1447. pass
  1448. _context1 = _Context1()
  1449. _context2 = _Context2()
  1450. comp = self._makeOne()
  1451. self.assertEqual(
  1452. list(comp.getAdapters((_context1, _context2), ifoo)), [])
  1453. def test_getAdapters_factory_returns_None(self):
  1454. from zope.interface.declarations import InterfaceClass
  1455. from zope.interface.declarations import implementer
  1456. class IFoo(InterfaceClass):
  1457. pass
  1458. ifoo = IFoo('IFoo')
  1459. ibar = IFoo('IBar')
  1460. ibaz = IFoo('IBaz')
  1461. @implementer(ibar)
  1462. class _Context1:
  1463. pass
  1464. @implementer(ibaz)
  1465. class _Context2:
  1466. pass
  1467. _context1 = _Context1()
  1468. _context2 = _Context2()
  1469. comp = self._makeOne()
  1470. _called_with = []
  1471. def _side_effect_only(context1, context2):
  1472. _called_with.append((context1, context2))
  1473. return None
  1474. comp.registerAdapter(_side_effect_only, (ibar, ibaz), ifoo)
  1475. self.assertEqual(
  1476. list(comp.getAdapters((_context1, _context2), ifoo)), [])
  1477. self.assertEqual(_called_with, [(_context1, _context2)])
  1478. def test_getAdapters_non_empty(self):
  1479. from zope.interface.declarations import InterfaceClass
  1480. from zope.interface.declarations import implementer
  1481. class IFoo(InterfaceClass):
  1482. pass
  1483. ifoo = IFoo('IFoo')
  1484. ibar = IFoo('IBar')
  1485. ibaz = IFoo('IBaz')
  1486. @implementer(ibar)
  1487. class _Context1:
  1488. pass
  1489. @implementer(ibaz)
  1490. class _Context2:
  1491. pass
  1492. _context1 = _Context1()
  1493. _context2 = _Context2()
  1494. class _Factory1:
  1495. def __init__(self, context1, context2):
  1496. self.context = context1, context2
  1497. class _Factory2:
  1498. def __init__(self, context1, context2):
  1499. self.context = context1, context2
  1500. _name1 = 'name1'
  1501. _name2 = 'name2'
  1502. comp = self._makeOne()
  1503. comp.registerAdapter(_Factory1, (ibar, ibaz), ifoo, name=_name1)
  1504. comp.registerAdapter(_Factory2, (ibar, ibaz), ifoo, name=_name2)
  1505. found = sorted(comp.getAdapters((_context1, _context2), ifoo))
  1506. self.assertEqual(len(found), 2)
  1507. self.assertEqual(found[0][0], _name1)
  1508. self.assertIsInstance(found[0][1], _Factory1)
  1509. self.assertEqual(found[1][0], _name2)
  1510. self.assertIsInstance(found[1][1], _Factory2)
  1511. def test_registerSubscriptionAdapter_w_nonblank_name(self):
  1512. from zope.interface.declarations import InterfaceClass
  1513. class IFoo(InterfaceClass):
  1514. pass
  1515. ifoo = IFoo('IFoo')
  1516. ibar = IFoo('IBar')
  1517. _name = 'name'
  1518. _info = 'info'
  1519. def _factory(context):
  1520. raise NotImplementedError()
  1521. comp = self._makeOne()
  1522. self.assertRaises(TypeError, comp.registerSubscriptionAdapter,
  1523. _factory, (ibar,), ifoo, _name, _info)
  1524. def test_registerSubscriptionAdapter_w_explicit_provided_n_required(self):
  1525. from zope.interface.declarations import InterfaceClass
  1526. from zope.interface.interfaces import Registered
  1527. from zope.interface.registry import SubscriptionRegistration
  1528. class IFoo(InterfaceClass):
  1529. pass
  1530. ifoo = IFoo('IFoo')
  1531. ibar = IFoo('IBar')
  1532. _blank = ''
  1533. _info = 'info'
  1534. def _factory(context):
  1535. raise NotImplementedError()
  1536. comp = self._makeOne()
  1537. _monkey, _events = self._wrapEvents()
  1538. with _monkey:
  1539. comp.registerSubscriptionAdapter(_factory, (ibar,), ifoo,
  1540. info=_info)
  1541. reg = comp.adapters._subscribers[1][ibar][ifoo][_blank]
  1542. self.assertEqual(len(reg), 1)
  1543. self.assertIs(reg[0], _factory)
  1544. self.assertEqual(comp._subscription_registrations,
  1545. [((ibar,), ifoo, _blank, _factory, _info)])
  1546. self.assertEqual(len(_events), 1)
  1547. args, kw = _events[0]
  1548. event, = args
  1549. self.assertEqual(kw, {})
  1550. self.assertIsInstance(event, Registered)
  1551. self.assertIsInstance(event.object, SubscriptionRegistration)
  1552. self.assertIs(event.object.registry, comp)
  1553. self.assertIs(event.object.provided, ifoo)
  1554. self.assertEqual(event.object.required, (ibar,))
  1555. self.assertEqual(event.object.name, _blank)
  1556. self.assertIs(event.object.info, _info)
  1557. self.assertIs(event.object.factory, _factory)
  1558. def test_registerSubscriptionAdapter_wo_explicit_provided(self):
  1559. from zope.interface.declarations import InterfaceClass
  1560. from zope.interface.declarations import implementer
  1561. from zope.interface.interfaces import Registered
  1562. from zope.interface.registry import SubscriptionRegistration
  1563. class IFoo(InterfaceClass):
  1564. pass
  1565. ifoo = IFoo('IFoo')
  1566. ibar = IFoo('IBar')
  1567. _info = 'info'
  1568. _blank = ''
  1569. @implementer(ifoo)
  1570. class _Factory:
  1571. pass
  1572. comp = self._makeOne()
  1573. _monkey, _events = self._wrapEvents()
  1574. with _monkey:
  1575. comp.registerSubscriptionAdapter(_Factory, (ibar,), info=_info)
  1576. reg = comp.adapters._subscribers[1][ibar][ifoo][_blank]
  1577. self.assertEqual(len(reg), 1)
  1578. self.assertIs(reg[0], _Factory)
  1579. self.assertEqual(comp._subscription_registrations,
  1580. [((ibar,), ifoo, _blank, _Factory, _info)])
  1581. self.assertEqual(len(_events), 1)
  1582. args, kw = _events[0]
  1583. event, = args
  1584. self.assertEqual(kw, {})
  1585. self.assertIsInstance(event, Registered)
  1586. self.assertIsInstance(event.object, SubscriptionRegistration)
  1587. self.assertIs(event.object.registry, comp)
  1588. self.assertIs(event.object.provided, ifoo)
  1589. self.assertEqual(event.object.required, (ibar,))
  1590. self.assertEqual(event.object.name, _blank)
  1591. self.assertIs(event.object.info, _info)
  1592. self.assertIs(event.object.factory, _Factory)
  1593. def test_registerSubscriptionAdapter_wo_explicit_required(self):
  1594. from zope.interface.declarations import InterfaceClass
  1595. from zope.interface.interfaces import Registered
  1596. from zope.interface.registry import SubscriptionRegistration
  1597. class IFoo(InterfaceClass):
  1598. pass
  1599. ifoo = IFoo('IFoo')
  1600. ibar = IFoo('IBar')
  1601. _info = 'info'
  1602. _blank = ''
  1603. class _Factory:
  1604. __component_adapts__ = (ibar,)
  1605. comp = self._makeOne()
  1606. _monkey, _events = self._wrapEvents()
  1607. with _monkey:
  1608. comp.registerSubscriptionAdapter(
  1609. _Factory, provided=ifoo, info=_info,
  1610. )
  1611. reg = comp.adapters._subscribers[1][ibar][ifoo][_blank]
  1612. self.assertEqual(len(reg), 1)
  1613. self.assertIs(reg[0], _Factory)
  1614. self.assertEqual(comp._subscription_registrations,
  1615. [((ibar,), ifoo, _blank, _Factory, _info)])
  1616. self.assertEqual(len(_events), 1)
  1617. args, kw = _events[0]
  1618. event, = args
  1619. self.assertEqual(kw, {})
  1620. self.assertIsInstance(event, Registered)
  1621. self.assertIsInstance(event.object, SubscriptionRegistration)
  1622. self.assertIs(event.object.registry, comp)
  1623. self.assertIs(event.object.provided, ifoo)
  1624. self.assertEqual(event.object.required, (ibar,))
  1625. self.assertEqual(event.object.name, _blank)
  1626. self.assertIs(event.object.info, _info)
  1627. self.assertIs(event.object.factory, _Factory)
  1628. def test_registerSubscriptionAdapter_wo_event(self):
  1629. from zope.interface.declarations import InterfaceClass
  1630. class IFoo(InterfaceClass):
  1631. pass
  1632. ifoo = IFoo('IFoo')
  1633. ibar = IFoo('IBar')
  1634. _info = 'info'
  1635. def _factory(context):
  1636. raise NotImplementedError()
  1637. comp = self._makeOne()
  1638. _monkey, _events = self._wrapEvents()
  1639. with _monkey:
  1640. comp.registerSubscriptionAdapter(_factory, (ibar,), ifoo,
  1641. info=_info, event=False)
  1642. self.assertEqual(len(_events), 0)
  1643. def test_registeredSubscriptionAdapters_empty(self):
  1644. comp = self._makeOne()
  1645. self.assertEqual(list(comp.registeredSubscriptionAdapters()), [])
  1646. def test_registeredSubscriptionAdapters_notempty(self):
  1647. from zope.interface.declarations import InterfaceClass
  1648. from zope.interface.registry import SubscriptionRegistration
  1649. class IFoo(InterfaceClass):
  1650. pass
  1651. ifoo = IFoo('IFoo')
  1652. ibar = IFoo('IFoo')
  1653. _info = 'info'
  1654. _blank = ''
  1655. class _Factory:
  1656. pass
  1657. comp = self._makeOne()
  1658. comp.registerSubscriptionAdapter(_Factory, (ibar,), ifoo, info=_info)
  1659. comp.registerSubscriptionAdapter(_Factory, (ibar,), ifoo, info=_info)
  1660. reg = list(comp.registeredSubscriptionAdapters())
  1661. self.assertEqual(len(reg), 2)
  1662. self.assertIsInstance(reg[0], SubscriptionRegistration)
  1663. self.assertIs(reg[0].registry, comp)
  1664. self.assertIs(reg[0].provided, ifoo)
  1665. self.assertEqual(reg[0].required, (ibar,))
  1666. self.assertEqual(reg[0].name, _blank)
  1667. self.assertIs(reg[0].info, _info)
  1668. self.assertIs(reg[0].factory, _Factory)
  1669. self.assertIsInstance(reg[1], SubscriptionRegistration)
  1670. self.assertIs(reg[1].registry, comp)
  1671. self.assertIs(reg[1].provided, ifoo)
  1672. self.assertEqual(reg[1].required, (ibar,))
  1673. self.assertEqual(reg[1].name, _blank)
  1674. self.assertIs(reg[1].info, _info)
  1675. self.assertIs(reg[1].factory, _Factory)
  1676. def test_unregisterSubscriptionAdapter_w_nonblank_name(self):
  1677. from zope.interface.declarations import InterfaceClass
  1678. class IFoo(InterfaceClass):
  1679. pass
  1680. ifoo = IFoo('IFoo')
  1681. ibar = IFoo('IBar')
  1682. _nonblank = 'nonblank'
  1683. comp = self._makeOne()
  1684. self.assertRaises(TypeError, comp.unregisterSubscriptionAdapter,
  1685. required=ifoo, provided=ibar, name=_nonblank)
  1686. def test_unregisterSubscriptionAdapter_neither_factory_nor_provided(self):
  1687. comp = self._makeOne()
  1688. self.assertRaises(TypeError, comp.unregisterSubscriptionAdapter,
  1689. factory=None, provided=None)
  1690. def test_unregisterSubscriptionAdapter_neither_factory_nor_required(self):
  1691. from zope.interface.declarations import InterfaceClass
  1692. class IFoo(InterfaceClass):
  1693. pass
  1694. ifoo = IFoo('IFoo')
  1695. comp = self._makeOne()
  1696. self.assertRaises(TypeError, comp.unregisterSubscriptionAdapter,
  1697. factory=None, provided=ifoo, required=None)
  1698. def test_unregisterSubscriptionAdapter_miss(self):
  1699. from zope.interface.declarations import InterfaceClass
  1700. class IFoo(InterfaceClass):
  1701. pass
  1702. ifoo = IFoo('IFoo')
  1703. ibar = IFoo('IBar')
  1704. class _Factory:
  1705. pass
  1706. comp = self._makeOne()
  1707. _monkey, _events = self._wrapEvents()
  1708. with _monkey:
  1709. unreg = comp.unregisterSubscriptionAdapter(_Factory, (ibar,), ifoo)
  1710. self.assertFalse(unreg)
  1711. self.assertFalse(_events)
  1712. def test_unregisterSubscriptionAdapter_hit_wo_factory(self):
  1713. from zope.interface.declarations import InterfaceClass
  1714. from zope.interface.interfaces import Unregistered
  1715. from zope.interface.registry import SubscriptionRegistration
  1716. class IFoo(InterfaceClass):
  1717. pass
  1718. ifoo = IFoo('IFoo')
  1719. ibar = IFoo('IBar')
  1720. class _Factory:
  1721. pass
  1722. comp = self._makeOne()
  1723. comp.registerSubscriptionAdapter(_Factory, (ibar,), ifoo)
  1724. _monkey, _events = self._wrapEvents()
  1725. with _monkey:
  1726. unreg = comp.unregisterSubscriptionAdapter(None, (ibar,), ifoo)
  1727. self.assertTrue(unreg)
  1728. self.assertFalse(comp.adapters._subscribers)
  1729. self.assertFalse(comp._subscription_registrations)
  1730. self.assertEqual(len(_events), 1)
  1731. args, kw = _events[0]
  1732. event, = args
  1733. self.assertEqual(kw, {})
  1734. self.assertIsInstance(event, Unregistered)
  1735. self.assertIsInstance(event.object, SubscriptionRegistration)
  1736. self.assertIs(event.object.registry, comp)
  1737. self.assertIs(event.object.provided, ifoo)
  1738. self.assertEqual(event.object.required, (ibar,))
  1739. self.assertEqual(event.object.name, '')
  1740. self.assertEqual(event.object.info, '')
  1741. self.assertIsNone(event.object.factory)
  1742. def test_unregisterSubscriptionAdapter_hit_w_factory(self):
  1743. from zope.interface.declarations import InterfaceClass
  1744. from zope.interface.interfaces import Unregistered
  1745. from zope.interface.registry import SubscriptionRegistration
  1746. class IFoo(InterfaceClass):
  1747. pass
  1748. ifoo = IFoo('IFoo')
  1749. ibar = IFoo('IBar')
  1750. class _Factory:
  1751. pass
  1752. comp = self._makeOne()
  1753. comp.registerSubscriptionAdapter(_Factory, (ibar,), ifoo)
  1754. _monkey, _events = self._wrapEvents()
  1755. with _monkey:
  1756. unreg = comp.unregisterSubscriptionAdapter(_Factory, (ibar,), ifoo)
  1757. self.assertTrue(unreg)
  1758. self.assertFalse(comp.adapters._subscribers)
  1759. self.assertFalse(comp._subscription_registrations)
  1760. self.assertEqual(len(_events), 1)
  1761. args, kw = _events[0]
  1762. event, = args
  1763. self.assertEqual(kw, {})
  1764. self.assertIsInstance(event, Unregistered)
  1765. self.assertIsInstance(event.object, SubscriptionRegistration)
  1766. self.assertIs(event.object.registry, comp)
  1767. self.assertIs(event.object.provided, ifoo)
  1768. self.assertEqual(event.object.required, (ibar,))
  1769. self.assertEqual(event.object.name, '')
  1770. self.assertEqual(event.object.info, '')
  1771. self.assertIs(event.object.factory, _Factory)
  1772. def test_unregisterSubscriptionAdapter_wo_explicit_provided(self):
  1773. from zope.interface.declarations import InterfaceClass
  1774. from zope.interface.declarations import implementer
  1775. from zope.interface.interfaces import Unregistered
  1776. from zope.interface.registry import SubscriptionRegistration
  1777. class IFoo(InterfaceClass):
  1778. pass
  1779. ifoo = IFoo('IFoo')
  1780. ibar = IFoo('IBar')
  1781. @implementer(ifoo)
  1782. class _Factory:
  1783. pass
  1784. comp = self._makeOne()
  1785. comp.registerSubscriptionAdapter(_Factory, (ibar,), ifoo)
  1786. _monkey, _events = self._wrapEvents()
  1787. with _monkey:
  1788. unreg = comp.unregisterSubscriptionAdapter(_Factory, (ibar,))
  1789. self.assertTrue(unreg)
  1790. self.assertEqual(len(_events), 1)
  1791. args, kw = _events[0]
  1792. event, = args
  1793. self.assertEqual(kw, {})
  1794. self.assertIsInstance(event, Unregistered)
  1795. self.assertIsInstance(event.object, SubscriptionRegistration)
  1796. self.assertIs(event.object.registry, comp)
  1797. self.assertIs(event.object.provided, ifoo)
  1798. self.assertEqual(event.object.required, (ibar,))
  1799. self.assertEqual(event.object.name, '')
  1800. self.assertEqual(event.object.info, '')
  1801. self.assertIs(event.object.factory, _Factory)
  1802. def test_unregisterSubscriptionAdapter_wo_explicit_required(self):
  1803. from zope.interface.declarations import InterfaceClass
  1804. from zope.interface.interfaces import Unregistered
  1805. from zope.interface.registry import SubscriptionRegistration
  1806. class IFoo(InterfaceClass):
  1807. pass
  1808. ifoo = IFoo('IFoo')
  1809. ibar = IFoo('IBar')
  1810. class _Factory:
  1811. __component_adapts__ = (ibar,)
  1812. comp = self._makeOne()
  1813. comp.registerSubscriptionAdapter(_Factory, (ibar,), ifoo)
  1814. _monkey, _events = self._wrapEvents()
  1815. with _monkey:
  1816. unreg = comp.unregisterSubscriptionAdapter(_Factory, provided=ifoo)
  1817. self.assertTrue(unreg)
  1818. self.assertEqual(len(_events), 1)
  1819. args, kw = _events[0]
  1820. event, = args
  1821. self.assertEqual(kw, {})
  1822. self.assertIsInstance(event, Unregistered)
  1823. self.assertIsInstance(event.object, SubscriptionRegistration)
  1824. self.assertIs(event.object.registry, comp)
  1825. self.assertIs(event.object.provided, ifoo)
  1826. self.assertEqual(event.object.required, (ibar,))
  1827. self.assertEqual(event.object.name, '')
  1828. self.assertEqual(event.object.info, '')
  1829. self.assertIs(event.object.factory, _Factory)
  1830. def test_subscribers_empty(self):
  1831. from zope.interface.declarations import InterfaceClass
  1832. from zope.interface.declarations import implementer
  1833. class IFoo(InterfaceClass):
  1834. pass
  1835. ifoo = IFoo('IFoo')
  1836. ibar = IFoo('IBar')
  1837. comp = self._makeOne()
  1838. @implementer(ibar)
  1839. class Bar:
  1840. pass
  1841. bar = Bar()
  1842. self.assertEqual(list(comp.subscribers((bar,), ifoo)), [])
  1843. def test_subscribers_non_empty(self):
  1844. from zope.interface.declarations import InterfaceClass
  1845. from zope.interface.declarations import implementer
  1846. class IFoo(InterfaceClass):
  1847. pass
  1848. ifoo = IFoo('IFoo')
  1849. ibar = IFoo('IBar')
  1850. class _Factory:
  1851. __component_adapts__ = (ibar,)
  1852. def __init__(self, context):
  1853. self._context = context
  1854. class _Derived(_Factory):
  1855. pass
  1856. comp = self._makeOne()
  1857. comp.registerSubscriptionAdapter(_Factory, (ibar,), ifoo)
  1858. comp.registerSubscriptionAdapter(_Derived, (ibar,), ifoo)
  1859. @implementer(ibar)
  1860. class Bar:
  1861. pass
  1862. bar = Bar()
  1863. subscribers = comp.subscribers((bar,), ifoo)
  1864. def _klassname(x):
  1865. return x.__class__.__name__
  1866. subscribers = sorted(subscribers, key=_klassname)
  1867. self.assertEqual(len(subscribers), 2)
  1868. self.assertIsInstance(subscribers[0], _Derived)
  1869. self.assertIsInstance(subscribers[1], _Factory)
  1870. def test_registerHandler_w_nonblank_name(self):
  1871. from zope.interface.declarations import InterfaceClass
  1872. class IFoo(InterfaceClass):
  1873. pass
  1874. ifoo = IFoo('IFoo')
  1875. _nonblank = 'nonblank'
  1876. comp = self._makeOne()
  1877. def _factory(context):
  1878. raise NotImplementedError()
  1879. self.assertRaises(TypeError, comp.registerHandler, _factory,
  1880. required=ifoo, name=_nonblank)
  1881. def test_registerHandler_w_explicit_required(self):
  1882. from zope.interface.declarations import InterfaceClass
  1883. from zope.interface.interfaces import Registered
  1884. from zope.interface.registry import HandlerRegistration
  1885. class IFoo(InterfaceClass):
  1886. pass
  1887. ifoo = IFoo('IFoo')
  1888. _blank = ''
  1889. _info = 'info'
  1890. def _factory(context):
  1891. raise NotImplementedError()
  1892. comp = self._makeOne()
  1893. _monkey, _events = self._wrapEvents()
  1894. with _monkey:
  1895. comp.registerHandler(_factory, (ifoo,), info=_info)
  1896. reg = comp.adapters._subscribers[1][ifoo][None][_blank]
  1897. self.assertEqual(len(reg), 1)
  1898. self.assertIs(reg[0], _factory)
  1899. self.assertEqual(comp._handler_registrations,
  1900. [((ifoo,), _blank, _factory, _info)])
  1901. self.assertEqual(len(_events), 1)
  1902. args, kw = _events[0]
  1903. event, = args
  1904. self.assertEqual(kw, {})
  1905. self.assertIsInstance(event, Registered)
  1906. self.assertIsInstance(event.object, HandlerRegistration)
  1907. self.assertIs(event.object.registry, comp)
  1908. self.assertEqual(event.object.required, (ifoo,))
  1909. self.assertEqual(event.object.name, _blank)
  1910. self.assertIs(event.object.info, _info)
  1911. self.assertIs(event.object.factory, _factory)
  1912. def test_registerHandler_wo_explicit_required_no_event(self):
  1913. from zope.interface.declarations import InterfaceClass
  1914. class IFoo(InterfaceClass):
  1915. pass
  1916. ifoo = IFoo('IFoo')
  1917. _info = 'info'
  1918. _blank = ''
  1919. class _Factory:
  1920. __component_adapts__ = (ifoo,)
  1921. pass
  1922. comp = self._makeOne()
  1923. _monkey, _events = self._wrapEvents()
  1924. with _monkey:
  1925. comp.registerHandler(_Factory, info=_info, event=False)
  1926. reg = comp.adapters._subscribers[1][ifoo][None][_blank]
  1927. self.assertEqual(len(reg), 1)
  1928. self.assertIs(reg[0], _Factory)
  1929. self.assertEqual(comp._handler_registrations,
  1930. [((ifoo,), _blank, _Factory, _info)])
  1931. self.assertEqual(len(_events), 0)
  1932. def test_registeredHandlers_empty(self):
  1933. comp = self._makeOne()
  1934. self.assertFalse(list(comp.registeredHandlers()))
  1935. def test_registeredHandlers_non_empty(self):
  1936. from zope.interface.declarations import InterfaceClass
  1937. from zope.interface.registry import HandlerRegistration
  1938. class IFoo(InterfaceClass):
  1939. pass
  1940. ifoo = IFoo('IFoo')
  1941. def _factory1(context):
  1942. raise NotImplementedError()
  1943. def _factory2(context):
  1944. raise NotImplementedError()
  1945. comp = self._makeOne()
  1946. comp.registerHandler(_factory1, (ifoo,))
  1947. comp.registerHandler(_factory2, (ifoo,))
  1948. def _factory_name(x):
  1949. return x.factory.__code__.co_name
  1950. subscribers = sorted(comp.registeredHandlers(), key=_factory_name)
  1951. self.assertEqual(len(subscribers), 2)
  1952. self.assertIsInstance(subscribers[0], HandlerRegistration)
  1953. self.assertEqual(subscribers[0].required, (ifoo,))
  1954. self.assertEqual(subscribers[0].name, '')
  1955. self.assertEqual(subscribers[0].factory, _factory1)
  1956. self.assertEqual(subscribers[0].info, '')
  1957. self.assertIsInstance(subscribers[1], HandlerRegistration)
  1958. self.assertEqual(subscribers[1].required, (ifoo,))
  1959. self.assertEqual(subscribers[1].name, '')
  1960. self.assertEqual(subscribers[1].factory, _factory2)
  1961. self.assertEqual(subscribers[1].info, '')
  1962. def test_unregisterHandler_w_nonblank_name(self):
  1963. from zope.interface.declarations import InterfaceClass
  1964. class IFoo(InterfaceClass):
  1965. pass
  1966. ifoo = IFoo('IFoo')
  1967. _nonblank = 'nonblank'
  1968. comp = self._makeOne()
  1969. self.assertRaises(TypeError, comp.unregisterHandler,
  1970. required=(ifoo,), name=_nonblank)
  1971. def test_unregisterHandler_neither_factory_nor_required(self):
  1972. comp = self._makeOne()
  1973. self.assertRaises(TypeError, comp.unregisterHandler)
  1974. def test_unregisterHandler_miss(self):
  1975. from zope.interface.declarations import InterfaceClass
  1976. class IFoo(InterfaceClass):
  1977. pass
  1978. ifoo = IFoo('IFoo')
  1979. comp = self._makeOne()
  1980. unreg = comp.unregisterHandler(required=(ifoo,))
  1981. self.assertFalse(unreg)
  1982. def test_unregisterHandler_hit_w_factory_and_explicit_provided(self):
  1983. from zope.interface.declarations import InterfaceClass
  1984. from zope.interface.interfaces import Unregistered
  1985. from zope.interface.registry import HandlerRegistration
  1986. class IFoo(InterfaceClass):
  1987. pass
  1988. ifoo = IFoo('IFoo')
  1989. comp = self._makeOne()
  1990. def _factory(context):
  1991. raise NotImplementedError()
  1992. comp = self._makeOne()
  1993. comp.registerHandler(_factory, (ifoo,))
  1994. _monkey, _events = self._wrapEvents()
  1995. with _monkey:
  1996. unreg = comp.unregisterHandler(_factory, (ifoo,))
  1997. self.assertTrue(unreg)
  1998. self.assertEqual(len(_events), 1)
  1999. args, kw = _events[0]
  2000. event, = args
  2001. self.assertEqual(kw, {})
  2002. self.assertIsInstance(event, Unregistered)
  2003. self.assertIsInstance(event.object, HandlerRegistration)
  2004. self.assertIs(event.object.registry, comp)
  2005. self.assertEqual(event.object.required, (ifoo,))
  2006. self.assertEqual(event.object.name, '')
  2007. self.assertIs(event.object.factory, _factory)
  2008. def test_unregisterHandler_hit_w_only_explicit_provided(self):
  2009. from zope.interface.declarations import InterfaceClass
  2010. from zope.interface.interfaces import Unregistered
  2011. from zope.interface.registry import HandlerRegistration
  2012. class IFoo(InterfaceClass):
  2013. pass
  2014. ifoo = IFoo('IFoo')
  2015. comp = self._makeOne()
  2016. def _factory(context):
  2017. raise NotImplementedError()
  2018. comp = self._makeOne()
  2019. comp.registerHandler(_factory, (ifoo,))
  2020. _monkey, _events = self._wrapEvents()
  2021. with _monkey:
  2022. unreg = comp.unregisterHandler(required=(ifoo,))
  2023. self.assertTrue(unreg)
  2024. self.assertEqual(len(_events), 1)
  2025. args, kw = _events[0]
  2026. event, = args
  2027. self.assertEqual(kw, {})
  2028. self.assertIsInstance(event, Unregistered)
  2029. self.assertIsInstance(event.object, HandlerRegistration)
  2030. self.assertIs(event.object.registry, comp)
  2031. self.assertEqual(event.object.required, (ifoo,))
  2032. self.assertEqual(event.object.name, '')
  2033. self.assertIsNone(event.object.factory)
  2034. def test_unregisterHandler_wo_explicit_required(self):
  2035. from zope.interface.declarations import InterfaceClass
  2036. from zope.interface.interfaces import Unregistered
  2037. from zope.interface.registry import HandlerRegistration
  2038. class IFoo(InterfaceClass):
  2039. pass
  2040. ifoo = IFoo('IFoo')
  2041. class _Factory:
  2042. __component_adapts__ = (ifoo,)
  2043. comp = self._makeOne()
  2044. comp.registerHandler(_Factory)
  2045. _monkey, _events = self._wrapEvents()
  2046. with _monkey:
  2047. unreg = comp.unregisterHandler(_Factory)
  2048. self.assertTrue(unreg)
  2049. self.assertEqual(len(_events), 1)
  2050. args, kw = _events[0]
  2051. event, = args
  2052. self.assertEqual(kw, {})
  2053. self.assertIsInstance(event, Unregistered)
  2054. self.assertIsInstance(event.object, HandlerRegistration)
  2055. self.assertIs(event.object.registry, comp)
  2056. self.assertEqual(event.object.required, (ifoo,))
  2057. self.assertEqual(event.object.name, '')
  2058. self.assertEqual(event.object.info, '')
  2059. self.assertIs(event.object.factory, _Factory)
  2060. def test_handle_empty(self):
  2061. from zope.interface.declarations import InterfaceClass
  2062. from zope.interface.declarations import implementer
  2063. class IFoo(InterfaceClass):
  2064. pass
  2065. ifoo = IFoo('IFoo')
  2066. comp = self._makeOne()
  2067. @implementer(ifoo)
  2068. class Bar:
  2069. pass
  2070. bar = Bar()
  2071. comp.handle((bar,)) # doesn't raise
  2072. def test_handle_non_empty(self):
  2073. from zope.interface.declarations import InterfaceClass
  2074. from zope.interface.declarations import implementer
  2075. class IFoo(InterfaceClass):
  2076. pass
  2077. ifoo = IFoo('IFoo')
  2078. _called_1 = []
  2079. def _factory_1(context):
  2080. _called_1.append(context)
  2081. _called_2 = []
  2082. def _factory_2(context):
  2083. _called_2.append(context)
  2084. comp = self._makeOne()
  2085. comp.registerHandler(_factory_1, (ifoo,))
  2086. comp.registerHandler(_factory_2, (ifoo,))
  2087. @implementer(ifoo)
  2088. class Bar:
  2089. pass
  2090. bar = Bar()
  2091. comp.handle(bar)
  2092. self.assertEqual(_called_1, [bar])
  2093. self.assertEqual(_called_2, [bar])
  2094. def test_register_unregister_identical_objects_provided(
  2095. self, identical=True,
  2096. ):
  2097. # https://github.com/zopefoundation/zope.interface/issues/227
  2098. class IFoo(Interface):
  2099. pass
  2100. comp = self._makeOne()
  2101. first = object()
  2102. second = first if identical else object()
  2103. comp.registerUtility(first, provided=IFoo)
  2104. comp.registerUtility(second, provided=IFoo, name='bar')
  2105. self.assertEqual(len(comp.utilities._subscribers), 1)
  2106. self.assertEqual(comp.utilities._subscribers, [{
  2107. IFoo: {'': (first, ) if identical else (first, second)}
  2108. }])
  2109. self.assertEqual(comp.utilities._provided, {
  2110. IFoo: 3 if identical else 4
  2111. })
  2112. res = comp.unregisterUtility(first, provided=IFoo)
  2113. self.assertTrue(res)
  2114. res = comp.unregisterUtility(second, provided=IFoo, name='bar')
  2115. self.assertTrue(res)
  2116. self.assertEqual(comp.utilities._provided, {})
  2117. self.assertEqual(len(comp.utilities._subscribers), 0)
  2118. def test_register_unregister_nonequal_objects_provided(self):
  2119. self.test_register_unregister_identical_objects_provided(
  2120. identical=False,
  2121. )
  2122. def test_rebuildUtilityRegistryFromLocalCache(self):
  2123. class IFoo(Interface):
  2124. "Does nothing"
  2125. class UtilityImplementingFoo:
  2126. "Does nothing"
  2127. comps = self._makeOne()
  2128. for i in range(30):
  2129. comps.registerUtility(
  2130. UtilityImplementingFoo(), IFoo, name=f'{i}'
  2131. )
  2132. orig_generation = comps.utilities._generation
  2133. orig_adapters = comps.utilities._adapters
  2134. self.assertEqual(len(orig_adapters), 1)
  2135. self.assertEqual(len(orig_adapters[0]), 1)
  2136. self.assertEqual(len(orig_adapters[0][IFoo]), 30)
  2137. orig_subscribers = comps.utilities._subscribers
  2138. self.assertEqual(len(orig_subscribers), 1)
  2139. self.assertEqual(len(orig_subscribers[0]), 1)
  2140. self.assertEqual(len(orig_subscribers[0][IFoo]), 1)
  2141. self.assertEqual(len(orig_subscribers[0][IFoo]['']), 30)
  2142. # Blow a bunch of them away, creating artificial corruption
  2143. new_adapters = comps.utilities._adapters = type(orig_adapters)()
  2144. new_adapters.append({})
  2145. d = new_adapters[0][IFoo] = {}
  2146. for name in range(10):
  2147. name = str(str(name))
  2148. d[name] = orig_adapters[0][IFoo][name]
  2149. self.assertNotEqual(orig_adapters, new_adapters)
  2150. new_subs = comps.utilities._subscribers = type(orig_subscribers)()
  2151. new_subs.append({})
  2152. d = new_subs[0][IFoo] = {}
  2153. d[''] = ()
  2154. for name in range(5, 12): # 12 - 5 = 7
  2155. name = str(str(name))
  2156. comp = orig_adapters[0][IFoo][name]
  2157. d[''] += (comp,)
  2158. # We can preflight (by default) and nothing changes
  2159. rebuild_preflight = comps.rebuildUtilityRegistryFromLocalCache()
  2160. self.assertEqual(comps.utilities._generation, orig_generation)
  2161. self.assertEqual(rebuild_preflight, {
  2162. 'did_not_register': 10,
  2163. 'needed_registered': 20,
  2164. 'did_not_subscribe': 7,
  2165. 'needed_subscribed': 23,
  2166. })
  2167. # Now for real
  2168. rebuild_results = comps.rebuildUtilityRegistryFromLocalCache(
  2169. rebuild=True,
  2170. )
  2171. # The generation only got incremented once
  2172. self.assertEqual(comps.utilities._generation, orig_generation + 1)
  2173. # The result was the same
  2174. self.assertEqual(rebuild_preflight, rebuild_results)
  2175. self.assertEqual(new_adapters, orig_adapters)
  2176. self.assertEqual(
  2177. len(new_subs[0][IFoo]['']),
  2178. len(orig_subscribers[0][IFoo]['']))
  2179. for orig_subscriber in orig_subscribers[0][IFoo]['']:
  2180. self.assertIn(orig_subscriber, new_subs[0][IFoo][''])
  2181. # Preflighting, rebuilding again produce no changes.
  2182. preflight_after = comps.rebuildUtilityRegistryFromLocalCache()
  2183. self.assertEqual(preflight_after, {
  2184. 'did_not_register': 30,
  2185. 'needed_registered': 0,
  2186. 'did_not_subscribe': 30,
  2187. 'needed_subscribed': 0,
  2188. })
  2189. rebuild_after = comps.rebuildUtilityRegistryFromLocalCache(
  2190. rebuild=True,
  2191. )
  2192. self.assertEqual(rebuild_after, preflight_after)
  2193. self.assertEqual(comps.utilities._generation, orig_generation + 1)
  2194. class UnhashableComponentsTests(ComponentsTests):
  2195. def _getTargetClass(self):
  2196. # Mimic what pyramid does to create an unhashable
  2197. # registry
  2198. class Components(
  2199. super(UnhashableComponentsTests, self)._getTargetClass(), dict,
  2200. ):
  2201. pass
  2202. return Components
  2203. # Test _getUtilityProvided, _getAdapterProvided, _getAdapterRequired via their
  2204. # callers (Component.registerUtility, Component.registerAdapter).
  2205. class UtilityRegistrationTests(unittest.TestCase):
  2206. def _getTargetClass(self):
  2207. from zope.interface.registry import UtilityRegistration
  2208. return UtilityRegistration
  2209. def _makeOne(self, component=None, factory=None):
  2210. from zope.interface.declarations import InterfaceClass
  2211. class InterfaceClassSubclass(InterfaceClass):
  2212. pass
  2213. ifoo = InterfaceClassSubclass('IFoo')
  2214. class _Registry:
  2215. def __repr__(self):
  2216. return '_REGISTRY'
  2217. registry = _Registry()
  2218. name = 'name'
  2219. doc = 'DOCSTRING'
  2220. klass = self._getTargetClass()
  2221. return (
  2222. klass(registry, ifoo, name, component, doc, factory),
  2223. registry,
  2224. name,
  2225. )
  2226. def test_class_conforms_to_IUtilityRegistration(self):
  2227. from zope.interface.interfaces import IUtilityRegistration
  2228. from zope.interface.verify import verifyClass
  2229. verifyClass(IUtilityRegistration, self._getTargetClass())
  2230. def test_instance_conforms_to_IUtilityRegistration(self):
  2231. from zope.interface.interfaces import IUtilityRegistration
  2232. from zope.interface.verify import verifyObject
  2233. ur, _, _ = self._makeOne()
  2234. verifyObject(IUtilityRegistration, ur)
  2235. def test___repr__(self):
  2236. class _Component:
  2237. __name__ = 'TEST'
  2238. _component = _Component()
  2239. ur, _registry, _name = self._makeOne(_component)
  2240. self.assertEqual(
  2241. repr(ur), (
  2242. "UtilityRegistration("
  2243. "_REGISTRY, IFoo, %r, TEST, None, 'DOCSTRING')"
  2244. ) % (_name)
  2245. )
  2246. def test___repr___provided_wo_name(self):
  2247. class _Component:
  2248. def __repr__(self):
  2249. return 'TEST'
  2250. _component = _Component()
  2251. ur, _registry, _name = self._makeOne(_component)
  2252. ur.provided = object()
  2253. self.assertEqual(
  2254. repr(ur), (
  2255. "UtilityRegistration("
  2256. "_REGISTRY, None, %r, TEST, None, 'DOCSTRING')"
  2257. ) % (_name)
  2258. )
  2259. def test___repr___component_wo_name(self):
  2260. class _Component:
  2261. def __repr__(self):
  2262. return 'TEST'
  2263. _component = _Component()
  2264. ur, _registry, _name = self._makeOne(_component)
  2265. ur.provided = object()
  2266. self.assertEqual(
  2267. repr(ur), (
  2268. "UtilityRegistration("
  2269. "_REGISTRY, None, %r, TEST, None, 'DOCSTRING')"
  2270. ) % (_name)
  2271. )
  2272. def test___hash__(self):
  2273. _component = object()
  2274. ur, _registry, _name = self._makeOne(_component)
  2275. self.assertEqual(ur.__hash__(), id(ur))
  2276. def test___eq___identity(self):
  2277. _component = object()
  2278. ur, _registry, _name = self._makeOne(_component)
  2279. self.assertEqual(ur, ur)
  2280. def test___eq___hit(self):
  2281. _component = object()
  2282. ur, _registry, _name = self._makeOne(_component)
  2283. ur2, _, _ = self._makeOne(_component)
  2284. self.assertEqual(ur, ur2)
  2285. def test___eq___miss(self):
  2286. _component = object()
  2287. _component2 = object()
  2288. ur, _registry, _name = self._makeOne(_component)
  2289. ur2, _, _ = self._makeOne(_component2)
  2290. self.assertNotEqual(ur, ur2)
  2291. def test___ne___identity(self):
  2292. _component = object()
  2293. ur, _registry, _name = self._makeOne(_component)
  2294. self.assertEqual(ur, ur)
  2295. def test___ne___hit(self):
  2296. _component = object()
  2297. ur, _registry, _name = self._makeOne(_component)
  2298. ur2, _, _ = self._makeOne(_component)
  2299. self.assertEqual(ur, ur2)
  2300. def test___ne___miss(self):
  2301. _component = object()
  2302. _component2 = object()
  2303. ur, _registry, _name = self._makeOne(_component)
  2304. ur2, _, _ = self._makeOne(_component2)
  2305. self.assertNotEqual(ur, ur2)
  2306. def test___lt___identity(self):
  2307. _component = object()
  2308. ur, _registry, _name = self._makeOne(_component)
  2309. self.assertFalse(ur < ur)
  2310. def test___lt___hit(self):
  2311. _component = object()
  2312. ur, _registry, _name = self._makeOne(_component)
  2313. ur2, _, _ = self._makeOne(_component)
  2314. self.assertFalse(ur < ur2)
  2315. def test___lt___miss(self):
  2316. _component = object()
  2317. _component2 = object()
  2318. ur, _registry, _name = self._makeOne(_component)
  2319. ur2, _, _ = self._makeOne(_component2)
  2320. ur2.name = _name + '2'
  2321. self.assertLess(ur, ur2)
  2322. def test___le___identity(self):
  2323. _component = object()
  2324. ur, _registry, _name = self._makeOne(_component)
  2325. self.assertLessEqual(ur, ur)
  2326. def test___le___hit(self):
  2327. _component = object()
  2328. ur, _registry, _name = self._makeOne(_component)
  2329. ur2, _, _ = self._makeOne(_component)
  2330. self.assertLessEqual(ur, ur2)
  2331. def test___le___miss(self):
  2332. _component = object()
  2333. _component2 = object()
  2334. ur, _registry, _name = self._makeOne(_component)
  2335. ur2, _, _ = self._makeOne(_component2)
  2336. ur2.name = _name + '2'
  2337. self.assertLessEqual(ur, ur2)
  2338. def test___gt___identity(self):
  2339. _component = object()
  2340. ur, _registry, _name = self._makeOne(_component)
  2341. self.assertFalse(ur > ur)
  2342. def test___gt___hit(self):
  2343. _component = object()
  2344. _component2 = object()
  2345. ur, _registry, _name = self._makeOne(_component)
  2346. ur2, _, _ = self._makeOne(_component2)
  2347. ur2.name = _name + '2'
  2348. self.assertGreater(ur2, ur)
  2349. def test___gt___miss(self):
  2350. _component = object()
  2351. ur, _registry, _name = self._makeOne(_component)
  2352. ur2, _, _ = self._makeOne(_component)
  2353. self.assertFalse(ur2 > ur)
  2354. def test___ge___identity(self):
  2355. _component = object()
  2356. ur, _registry, _name = self._makeOne(_component)
  2357. self.assertGreaterEqual(ur, ur)
  2358. def test___ge___miss(self):
  2359. _component = object()
  2360. _component2 = object()
  2361. ur, _registry, _name = self._makeOne(_component)
  2362. ur2, _, _ = self._makeOne(_component2)
  2363. ur2.name = _name + '2'
  2364. self.assertFalse(ur >= ur2)
  2365. def test___ge___hit(self):
  2366. _component = object()
  2367. ur, _registry, _name = self._makeOne(_component)
  2368. ur2, _, _ = self._makeOne(_component)
  2369. ur2.name = _name + '2'
  2370. self.assertGreaterEqual(ur2, ur)
  2371. class AdapterRegistrationTests(unittest.TestCase):
  2372. def _getTargetClass(self):
  2373. from zope.interface.registry import AdapterRegistration
  2374. return AdapterRegistration
  2375. def _makeOne(self, component=None):
  2376. from zope.interface.declarations import InterfaceClass
  2377. class IFoo(InterfaceClass):
  2378. pass
  2379. ifoo = IFoo('IFoo')
  2380. ibar = IFoo('IBar')
  2381. class _Registry:
  2382. def __repr__(self):
  2383. return '_REGISTRY'
  2384. registry = _Registry()
  2385. name = 'name'
  2386. doc = 'DOCSTRING'
  2387. klass = self._getTargetClass()
  2388. return (
  2389. klass(registry, (ibar,), ifoo, name, component, doc),
  2390. registry,
  2391. name,
  2392. )
  2393. def test_class_conforms_to_IAdapterRegistration(self):
  2394. from zope.interface.interfaces import IAdapterRegistration
  2395. from zope.interface.verify import verifyClass
  2396. verifyClass(IAdapterRegistration, self._getTargetClass())
  2397. def test_instance_conforms_to_IAdapterRegistration(self):
  2398. from zope.interface.interfaces import IAdapterRegistration
  2399. from zope.interface.verify import verifyObject
  2400. ar, _, _ = self._makeOne()
  2401. verifyObject(IAdapterRegistration, ar)
  2402. def test___repr__(self):
  2403. class _Component:
  2404. __name__ = 'TEST'
  2405. _component = _Component()
  2406. ar, _registry, _name = self._makeOne(_component)
  2407. self.assertEqual(
  2408. repr(ar), (
  2409. "AdapterRegistration(_REGISTRY, [IBar], IFoo, %r, TEST, "
  2410. "'DOCSTRING')"
  2411. ) % (_name)
  2412. )
  2413. def test___repr___provided_wo_name(self):
  2414. class _Component:
  2415. def __repr__(self):
  2416. return 'TEST'
  2417. _component = _Component()
  2418. ar, _registry, _name = self._makeOne(_component)
  2419. ar.provided = object()
  2420. self.assertEqual(
  2421. repr(ar), (
  2422. "AdapterRegistration(_REGISTRY, [IBar], None, %r, TEST, "
  2423. "'DOCSTRING')"
  2424. ) % (_name)
  2425. )
  2426. def test___repr___component_wo_name(self):
  2427. class _Component:
  2428. def __repr__(self):
  2429. return 'TEST'
  2430. _component = _Component()
  2431. ar, _registry, _name = self._makeOne(_component)
  2432. ar.provided = object()
  2433. self.assertEqual(
  2434. repr(ar), (
  2435. "AdapterRegistration(_REGISTRY, [IBar], None, %r, TEST, "
  2436. "'DOCSTRING')"
  2437. ) % (_name)
  2438. )
  2439. def test___hash__(self):
  2440. _component = object()
  2441. ar, _registry, _name = self._makeOne(_component)
  2442. self.assertEqual(ar.__hash__(), id(ar))
  2443. def test___eq___identity(self):
  2444. _component = object()
  2445. ar, _registry, _name = self._makeOne(_component)
  2446. self.assertEqual(ar, ar)
  2447. def test___eq___hit(self):
  2448. _component = object()
  2449. ar, _registry, _name = self._makeOne(_component)
  2450. ar2, _, _ = self._makeOne(_component)
  2451. self.assertEqual(ar, ar2)
  2452. def test___eq___miss(self):
  2453. _component = object()
  2454. _component2 = object()
  2455. ar, _registry, _name = self._makeOne(_component)
  2456. ar2, _, _ = self._makeOne(_component2)
  2457. self.assertNotEqual(ar, ar2)
  2458. def test___ne___identity(self):
  2459. _component = object()
  2460. ar, _registry, _name = self._makeOne(_component)
  2461. self.assertEqual(ar, ar)
  2462. def test___ne___miss(self):
  2463. _component = object()
  2464. ar, _registry, _name = self._makeOne(_component)
  2465. ar2, _, _ = self._makeOne(_component)
  2466. self.assertEqual(ar, ar2)
  2467. def test___ne___hit_component(self):
  2468. _component = object()
  2469. _component2 = object()
  2470. ar, _registry, _name = self._makeOne(_component)
  2471. ar2, _, _ = self._makeOne(_component2)
  2472. self.assertNotEqual(ar, ar2)
  2473. def test___ne___hit_provided(self):
  2474. from zope.interface.declarations import InterfaceClass
  2475. class IFoo(InterfaceClass):
  2476. pass
  2477. ibaz = IFoo('IBaz')
  2478. _component = object()
  2479. ar, _registry, _name = self._makeOne(_component)
  2480. ar2, _, _ = self._makeOne(_component)
  2481. ar2.provided = ibaz
  2482. self.assertNotEqual(ar, ar2)
  2483. def test___ne___hit_required(self):
  2484. from zope.interface.declarations import InterfaceClass
  2485. class IFoo(InterfaceClass):
  2486. pass
  2487. ibaz = IFoo('IBaz')
  2488. _component = object()
  2489. _component2 = object()
  2490. ar, _registry, _name = self._makeOne(_component)
  2491. ar2, _, _ = self._makeOne(_component2)
  2492. ar2.required = (ibaz,)
  2493. self.assertNotEqual(ar, ar2)
  2494. def test___lt___identity(self):
  2495. _component = object()
  2496. ar, _registry, _name = self._makeOne(_component)
  2497. self.assertFalse(ar < ar)
  2498. def test___lt___hit(self):
  2499. _component = object()
  2500. ar, _registry, _name = self._makeOne(_component)
  2501. ar2, _, _ = self._makeOne(_component)
  2502. self.assertFalse(ar < ar2)
  2503. def test___lt___miss(self):
  2504. _component = object()
  2505. _component2 = object()
  2506. ar, _registry, _name = self._makeOne(_component)
  2507. ar2, _, _ = self._makeOne(_component2)
  2508. ar2.name = _name + '2'
  2509. self.assertLess(ar, ar2)
  2510. def test___le___identity(self):
  2511. _component = object()
  2512. ar, _registry, _name = self._makeOne(_component)
  2513. self.assertLessEqual(ar, ar)
  2514. def test___le___hit(self):
  2515. _component = object()
  2516. ar, _registry, _name = self._makeOne(_component)
  2517. ar2, _, _ = self._makeOne(_component)
  2518. self.assertLessEqual(ar, ar2)
  2519. def test___le___miss(self):
  2520. _component = object()
  2521. _component2 = object()
  2522. ar, _registry, _name = self._makeOne(_component)
  2523. ar2, _, _ = self._makeOne(_component2)
  2524. ar2.name = _name + '2'
  2525. self.assertLessEqual(ar, ar2)
  2526. def test___gt___identity(self):
  2527. _component = object()
  2528. ar, _registry, _name = self._makeOne(_component)
  2529. self.assertFalse(ar > ar)
  2530. def test___gt___hit(self):
  2531. _component = object()
  2532. _component2 = object()
  2533. ar, _registry, _name = self._makeOne(_component)
  2534. ar2, _, _ = self._makeOne(_component2)
  2535. ar2.name = _name + '2'
  2536. self.assertGreater(ar2, ar)
  2537. def test___gt___miss(self):
  2538. _component = object()
  2539. ar, _registry, _name = self._makeOne(_component)
  2540. ar2, _, _ = self._makeOne(_component)
  2541. self.assertFalse(ar2 > ar)
  2542. def test___ge___identity(self):
  2543. _component = object()
  2544. ar, _registry, _name = self._makeOne(_component)
  2545. self.assertGreaterEqual(ar, ar)
  2546. def test___ge___miss(self):
  2547. _component = object()
  2548. _component2 = object()
  2549. ar, _registry, _name = self._makeOne(_component)
  2550. ar2, _, _ = self._makeOne(_component2)
  2551. ar2.name = _name + '2'
  2552. self.assertFalse(ar >= ar2)
  2553. def test___ge___hit(self):
  2554. _component = object()
  2555. ar, _registry, _name = self._makeOne(_component)
  2556. ar2, _, _ = self._makeOne(_component)
  2557. ar2.name = _name + '2'
  2558. self.assertGreaterEqual(ar2, ar)
  2559. class SubscriptionRegistrationTests(unittest.TestCase):
  2560. def _getTargetClass(self):
  2561. from zope.interface.registry import SubscriptionRegistration
  2562. return SubscriptionRegistration
  2563. def _makeOne(self, component=None):
  2564. from zope.interface.declarations import InterfaceClass
  2565. class IFoo(InterfaceClass):
  2566. pass
  2567. ifoo = IFoo('IFoo')
  2568. ibar = IFoo('IBar')
  2569. class _Registry:
  2570. def __repr__(self): # pragma: no cover
  2571. return '_REGISTRY'
  2572. registry = _Registry()
  2573. name = 'name'
  2574. doc = 'DOCSTRING'
  2575. klass = self._getTargetClass()
  2576. return (
  2577. klass(registry, (ibar,), ifoo, name, component, doc),
  2578. registry,
  2579. name,
  2580. )
  2581. def test_class_conforms_to_ISubscriptionAdapterRegistration(self):
  2582. from zope.interface.interfaces import ISubscriptionAdapterRegistration
  2583. from zope.interface.verify import verifyClass
  2584. verifyClass(ISubscriptionAdapterRegistration, self._getTargetClass())
  2585. def test_instance_conforms_to_ISubscriptionAdapterRegistration(self):
  2586. from zope.interface.interfaces import ISubscriptionAdapterRegistration
  2587. from zope.interface.verify import verifyObject
  2588. sar, _, _ = self._makeOne()
  2589. verifyObject(ISubscriptionAdapterRegistration, sar)
  2590. class HandlerRegistrationTests(unittest.TestCase):
  2591. def _getTargetClass(self):
  2592. from zope.interface.registry import HandlerRegistration
  2593. return HandlerRegistration
  2594. def _makeOne(self, component=None):
  2595. from zope.interface.declarations import InterfaceClass
  2596. class IFoo(InterfaceClass):
  2597. pass
  2598. ifoo = IFoo('IFoo')
  2599. class _Registry:
  2600. def __repr__(self):
  2601. return '_REGISTRY'
  2602. registry = _Registry()
  2603. name = 'name'
  2604. doc = 'DOCSTRING'
  2605. klass = self._getTargetClass()
  2606. return (
  2607. klass(registry, (ifoo,), name, component, doc),
  2608. registry,
  2609. name,
  2610. )
  2611. def test_class_conforms_to_IHandlerRegistration(self):
  2612. from zope.interface.interfaces import IHandlerRegistration
  2613. from zope.interface.verify import verifyClass
  2614. verifyClass(IHandlerRegistration, self._getTargetClass())
  2615. def test_instance_conforms_to_IHandlerRegistration(self):
  2616. from zope.interface.interfaces import IHandlerRegistration
  2617. from zope.interface.verify import verifyObject
  2618. hr, _, _ = self._makeOne()
  2619. verifyObject(IHandlerRegistration, hr)
  2620. def test_properties(self):
  2621. def _factory(context):
  2622. raise NotImplementedError()
  2623. hr, _, _ = self._makeOne(_factory)
  2624. self.assertIs(hr.handler, _factory)
  2625. self.assertIs(hr.factory, hr.handler)
  2626. self.assertIsNone(hr.provided)
  2627. def test___repr___factory_w_name(self):
  2628. class _Factory:
  2629. __name__ = 'TEST'
  2630. hr, _registry, _name = self._makeOne(_Factory())
  2631. self.assertEqual(
  2632. repr(hr), (
  2633. "HandlerRegistration(_REGISTRY, [IFoo], %r, TEST, "
  2634. "'DOCSTRING')"
  2635. ) % (_name))
  2636. def test___repr___factory_wo_name(self):
  2637. class _Factory:
  2638. def __repr__(self):
  2639. return 'TEST'
  2640. hr, _registry, _name = self._makeOne(_Factory())
  2641. self.assertEqual(
  2642. repr(hr), (
  2643. "HandlerRegistration(_REGISTRY, [IFoo], %r, TEST, "
  2644. "'DOCSTRING')"
  2645. ) % (_name)
  2646. )
  2647. class PersistentAdapterRegistry(VerifyingAdapterRegistry):
  2648. def __getstate__(self):
  2649. state = self.__dict__.copy()
  2650. for k in list(state):
  2651. if k in self._delegated or k.startswith('_v'):
  2652. state.pop(k)
  2653. state.pop('ro', None)
  2654. return state
  2655. def __setstate__(self, state):
  2656. bases = state.pop('__bases__', ())
  2657. self.__dict__.update(state)
  2658. self._createLookup()
  2659. self.__bases__ = bases
  2660. self._v_lookup.changed(self)
  2661. class PersistentComponents(Components):
  2662. # Mimic zope.component.persistentregistry.PersistentComponents:
  2663. # we should be picklalable, but not persistent.Persistent ourself.
  2664. def _init_registries(self):
  2665. self.adapters = PersistentAdapterRegistry()
  2666. self.utilities = PersistentAdapterRegistry()
  2667. class PersistentDictComponents(PersistentComponents, dict):
  2668. # Like Pyramid's Registry, we subclass Components and dict
  2669. pass
  2670. class PersistentComponentsDict(dict, PersistentComponents):
  2671. # Like the above, but inheritance is flipped
  2672. def __init__(self, name):
  2673. dict.__init__(self)
  2674. PersistentComponents.__init__(self, name)
  2675. class TestPersistentComponents(unittest.TestCase):
  2676. def _makeOne(self):
  2677. return PersistentComponents('test')
  2678. def _check_equality_after_pickle(self, made):
  2679. pass
  2680. def test_pickles_empty(self):
  2681. import pickle
  2682. comp = self._makeOne()
  2683. pickle.dumps(comp)
  2684. comp2 = pickle.loads(pickle.dumps(comp))
  2685. self.assertEqual(comp2.__name__, 'test')
  2686. def test_pickles_with_utility_registration(self):
  2687. import pickle
  2688. comp = self._makeOne()
  2689. utility = object()
  2690. comp.registerUtility(
  2691. utility,
  2692. Interface)
  2693. self.assertIs(utility,
  2694. comp.getUtility(Interface))
  2695. comp2 = pickle.loads(pickle.dumps(comp))
  2696. self.assertEqual(comp2.__name__, 'test')
  2697. # The utility is still registered
  2698. self.assertIsNotNone(comp2.getUtility(Interface))
  2699. # We can register another one
  2700. comp2.registerUtility(
  2701. utility,
  2702. Interface)
  2703. self.assertIs(utility,
  2704. comp2.getUtility(Interface))
  2705. self._check_equality_after_pickle(comp2)
  2706. class TestPersistentDictComponents(TestPersistentComponents):
  2707. def _getTargetClass(self):
  2708. return PersistentDictComponents
  2709. def _makeOne(self):
  2710. comp = self._getTargetClass()(name='test')
  2711. comp['key'] = 42
  2712. return comp
  2713. def _check_equality_after_pickle(self, made):
  2714. self.assertIn('key', made)
  2715. self.assertEqual(made['key'], 42)
  2716. class TestPersistentComponentsDict(TestPersistentDictComponents):
  2717. def _getTargetClass(self):
  2718. return PersistentComponentsDict
  2719. class _Monkey:
  2720. # context-manager for replacing module names in the scope of a test.
  2721. def __init__(self, module, **kw):
  2722. self.module = module
  2723. self.to_restore = {key: getattr(module, key) for key in kw}
  2724. for key, value in kw.items():
  2725. setattr(module, key, value)
  2726. def __enter__(self):
  2727. return self
  2728. def __exit__(self, exc_type, exc_val, exc_tb):
  2729. for key, value in self.to_restore.items():
  2730. setattr(self.module, key, value)