From 12371b90a6005a3a7874e13e40e3d2f820ee468c Mon Sep 17 00:00:00 2001 From: Tres Seaver Date: Tue, 6 Dec 2016 07:20:52 -0500 Subject: [PATCH] Document API for adapter registry. Closes: #41. --- docs/adapter.rst | 2 ++ docs/api.rst | 19 +++++++++++++++++++ src/zope/interface/adapter.py | 4 ++++ 3 files changed, 25 insertions(+) diff --git a/docs/adapter.rst b/docs/adapter.rst index c5c65e5d..b1caee37 100644 --- a/docs/adapter.rst +++ b/docs/adapter.rst @@ -1,3 +1,5 @@ +.. _adapter-registry: + ================ Adapter Registry ================ diff --git a/docs/api.rst b/docs/api.rst index c51624f4..2ff65a1a 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -1059,3 +1059,22 @@ For example: When registering an adapter or utility component, the registry looks for the ``__component_name__`` attribute and uses it, if no name was explicitly provided. + + +:class:`zope.interface.adapter.AdapterRegistry` +----------------------------------------------- + +API ++++ + +The adapter registry's API is defined by +:class:`zope.interface.interfaces.IAdapterRegistry`: + +.. autointerface:: zope.interface.adapter.IAdapterRegistry + :members: + :member-order: bysource + +Usage ++++++ + +See :ref:`adapter-registry`. diff --git a/src/zope/interface/adapter.py b/src/zope/interface/adapter.py index db2a49b6..f8fdb006 100644 --- a/src/zope/interface/adapter.py +++ b/src/zope/interface/adapter.py @@ -15,9 +15,11 @@ """ import weakref +from zope.interface import implementer from zope.interface import providedBy from zope.interface import Interface from zope.interface import ro +from zope.interface.interfaces import IAdapterRegistry from zope.interface._compat import _normalize_name @@ -605,6 +607,7 @@ def subscribers(self, objects, provided): class AdapterLookup(AdapterLookupBase, LookupBase): pass +@implementer(IAdapterRegistry) class AdapterRegistry(BaseAdapterRegistry): LookupClass = AdapterLookup @@ -644,6 +647,7 @@ def changed(self, originally_changed): class VerifyingAdapterLookup(AdapterLookupBase, VerifyingBase): pass +@implementer(IAdapterRegistry) class VerifyingAdapterRegistry(BaseAdapterRegistry): LookupClass = VerifyingAdapterLookup