3
,�W A � @ s� d Z ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlm Z dd lm
Z
dd
lm Z dd lm Z dd lm
Z
dd
lmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ ddlmZ G dd� de�ZG dd � d e�Z G d d � d e�Z G d d � d e�Z G d!d"� d"e �Z G d#d$� d$e �Z!G d%d&� d&e�Z"d'S )(z0Component and Component Architecture Interfaces
� )� Attribute)� Interface)�
implements)�ComponentLookupError)�Invalid)� IObjectEvent)� ObjectEvent)�IComponentLookup)�
IRegistration)�IUtilityRegistration)�_IBaseAdapterRegistration)�IAdapterRegistration)� ISubscriptionAdapterRegistration)�IHandlerRegistration)�IRegistrationEvent)�RegistrationEvent)� IRegistered)�
Registered)�
IUnregistered)� Unregistered)�IComponentRegistry)� IComponents)�_BLANKc @ s� e Zd ZdZdd� Zd.dd�Zd/dd �Zd0d
d �Zd1d d
�Zd2dd�Z d3dd�Z
d4dd�Z e e
dfdd�Zdd� Ze ddfdd�Ze e
ddfdd�Zd5d d �Ze e
ddfd d �Zd6d d!�Zd7d"d#�Zd$d%� Zd&d'� Zd(d)� Zd8d*d+�Zd9d,d-�ZdS ):�IComponentArchitecturez�The Component Architecture is defined by two key components: Adapters
and Utiltities. Both are managed by site managers. All other components
build on top of them.
c C s dS )z�Return the global site manager.
This function should never fail and always return an object that
provides `IGlobalSiteManager`.
N� r r r � /usr/lib/python3.6/interfaces.py�getGlobalSiteManager3 s z+IComponentArchitecture.getGlobalSiteManagerNc C s dS )aH Get the nearest site manager in the given context.
If `context` is `None`, return the global site manager.
If the `context` is not `None`, it is expected that an adapter
from the `context` to `IComponentLookup` can be found. If no
adapter is found, a `ComponentLookupError` is raised.
Nr )�contextr r r �getSiteManager: s z%IComponentArchitecture.getSiteManager� c C s dS )z�Get the utility that provides interface
Returns the nearest utility to the context that implements the
specified interface. If one is not found, raises
ComponentLookupError.
Nr )� interface�namer r r r �
getUtilityG s z!IComponentArchitecture.getUtilityc C s dS )z�Look for the utility that provides interface
Returns the nearest utility to the context that implements
the specified interface. If one is not found, returns default.
Nr )r r! �defaultr r r r � queryUtilityO s z#IComponentArchitecture.queryUtilityc C s dS )z�Query for the next available utility.
Find the next available utility providing `interface` and having the
specified name. If no utility was found, return the specified `default`
value.
Nr )r r r! r# r r r �queryNextUtilityV s z'IComponentArchitecture.queryNextUtilityc C s dS )zrGet the next available utility.
If no utility was found, a `ComponentLookupError` is raised.
Nr )r r r! r r r �getNextUtility^ s z%IComponentArchitecture.getNextUtilityc C s dS )zuReturn the utilities that provide an interface
An iterable of utility name-value pairs is returned.
Nr )r r r r r �getUtilitiesFord s z&IComponentArchitecture.getUtilitiesForc C s dS )z�Return all registered utilities for an interface
This includes overridden utilities.
An iterable of utility instances is returned. No names are
returned.
Nr )r r r r r � getAllUtilitiesRegisteredForj s z3IComponentArchitecture.getAllUtilitiesRegisteredForc C s dS )a� Get a named adapter to an interface for an object
Returns an adapter that can adapt object to interface. If a matching
adapter cannot be found, raises ComponentLookupError.
If context is None, an application-defined policy is used to choose
an appropriate service manager from which to get an 'Adapters' service.
If 'context' is not None, context is adapted to IServiceService,
and this adapter's 'Adapters' service is used.
Nr )�objectr r! r r r r �
getAdapteru s z!IComponentArchitecture.getAdapterc C s dS )a) Get a special adapter to an interface for an object
NOTE: This method should only be used if a custom context
needs to be provided to provide custom component
lookup. Otherwise, call the interface, as in::
interface(object)
Returns an adapter that can adapt object to interface. If a matching
adapter cannot be found, raises ComponentLookupError.
Context is adapted to IServiceService, and this adapter's
'Adapters' service is used.
If the object has a __conform__ method, this method will be
called with the requested interface. If the method returns a
non-None value, that value will be returned. Otherwise, if the
object already implements the interface, the object will be
returned.
Nr )r) r r r r r �getAdapterInContext� s z*IComponentArchitecture.getAdapterInContextc C s dS )a� Look for a multi-adapter to an interface for an objects
Returns a multi-adapter that can adapt objects to interface. If a
matching adapter cannot be found, raises ComponentLookupError.
If context is None, an application-defined policy is used to choose
an appropriate service manager from which to get an 'Adapters' service.
If 'context' is not None, context is adapted to IServiceService,
and this adapter's 'Adapters' service is used.
The name consisting of an empty string is reserved for unnamed
adapters. The unnamed adapter methods will often call the
named adapter methods with an empty string for a name.
Nr )�objectsr r! r r r r �getMultiAdapter� s z&IComponentArchitecture.getMultiAdapterc C s dS )a� Look for a named adapter to an interface for an object
Returns an adapter that can adapt object to interface. If a matching
adapter cannot be found, returns the default.
If context is None, an application-defined policy is used to choose
an appropriate service manager from which to get an 'Adapters' service.
If 'context' is not None, context is adapted to IServiceService,
and this adapter's 'Adapters' service is used.
Nr )r) r r! r# r r r r � queryAdapter� s z#IComponentArchitecture.queryAdapterc C s dS )a/ Look for a special adapter to an interface for an object
NOTE: This method should only be used if a custom context
needs to be provided to provide custom component
lookup. Otherwise, call the interface, as in::
interface(object, default)
Returns an adapter that can adapt object to interface. If a matching
adapter cannot be found, returns the default.
Context is adapted to IServiceService, and this adapter's
'Adapters' service is used.
If the object has a __conform__ method, this method will be
called with the requested interface. If the method returns a
non-None value, that value will be returned. Otherwise, if the
object already implements the interface, the object will be
returned.
Nr )r) r r r# r r r �queryAdapterInContext� s z,IComponentArchitecture.queryAdapterInContextc C s dS )a� Look for a multi-adapter to an interface for objects
Returns a multi-adapter that can adapt objects to interface. If a
matching adapter cannot be found, returns the default.
If context is None, an application-defined policy is used to choose
an appropriate service manager from which to get an 'Adapters' service.
If 'context' is not None, context is adapted to IServiceService,
and this adapter's 'Adapters' service is used.
The name consisting of an empty string is reserved for unnamed
adapters. The unnamed adapter methods will often call the
named adapter methods with an empty string for a name.
Nr )r, r r! r# r r r r �queryMultiAdapter� s z(IComponentArchitecture.queryMultiAdapterc C s dS )a� Look for all matching adapters to a provided interface for objects
Return a list of adapters that match. If an adapter is named, only the
most specific adapter of a given name is returned.
If context is None, an application-defined policy is used to choose
an appropriate service manager from which to get an 'Adapters'
service.
If 'context' is not None, context is adapted to IServiceService,
and this adapter's 'Adapters' service is used.
Nr )r, �providedr r r r � getAdapters� s z"IComponentArchitecture.getAdaptersc C s dS )a� Get subscribers
Subscribers are returned that provide the provided interface
and that depend on and are computed from the sequence of
required objects.
If context is None, an application-defined policy is used to choose
an appropriate service manager from which to get an 'Adapters'
service.
If 'context' is not None, context is adapted to IServiceService,
and this adapter's 'Adapters' service is used.
Nr )Zrequiredr1 r r r r � subscribers� s z"IComponentArchitecture.subscribersc G s dS )z�Call all of the handlers for the given objects
Handlers are subscription adapter factories that don't produce
anything. They do all of their work when called. Handlers
are typically used to handle events.
Nr )r, r r r �handle s z IComponentArchitecture.handlec G s dS )z�Declare that a class adapts the given interfaces.
This function can only be used in a class definition.
(TODO, allow classes to be passed as well as interfaces.)
Nr )Z
interfacesr r r �adapts s z IComponentArchitecture.adaptsc O s dS )a� Create an object using a factory
Finds the named factory in the current site and calls it with
the given arguments. If a matching factory cannot be found
raises ComponentLookupError. Returns the created object.
A context keyword argument can be provided to cause the
factory to be looked up in a location other than the current
site. (Of course, this means that it is impossible to pass a
keyword argument named "context" to the factory.
Nr )Z factory_name�args�kwargsr r r � createObject s z#IComponentArchitecture.createObjectc C s dS )z�Get interfaces implemented by a factory
Finds the factory of the given name that is nearest to the
context, and returns the interface or interface tuple that
object instances created by the named factory will implement.
Nr )r! r r r r �getFactoryInterfaces# s z+IComponentArchitecture.getFactoryInterfacesc C s dS )z�Return a tuple (name, factory) of registered factories that
create objects which implement the given interface.
Nr )r r r r r �getFactoriesFor+ s z&IComponentArchitecture.getFactoriesFor)N)r N)r NN)r N)r )N)N)N)N)N)N)N)�__name__�
__module__� __qualname__�__doc__r r r" r$ r% r& r' r( r r r* r+ r- r. r/ r0 r2 r3 r4 r5 r8 r9 r: r r r r r , s6
r c @ s e Zd ZdZdd� ZdS )� IRegistryz,Object that supports component registry
c C s dS )z6Return an iterable of component registrations
Nr r r r r �
registrations5 s zIRegistry.registrationsN)r; r< r= r> r@ r r r r r? 1 s r? c @ sB e Zd ZdZdefdd�Zddefdd�Zd dd�Zd d d
�ZdS )
�!IComponentRegistrationConveniencez�API for registering components.
CAUTION: This API should only be used from test or
application-setup code. This api shouldn't be used by regular
library modules, as component registration is a configuration
activity.
Nc C s dS )aB Register a utility globally
A utility is registered to provide an interface with a
name. If a component provides only one interface, then the
provides argument can be omitted and the provided interface
will be used. (In this case, provides argument can still be
provided to provide a less specific interface.)
CAUTION: This API should only be used from test or
application-setup code. This API shouldn't be used by regular
library modules, as component registration is a configuration
activity.
Nr )Z component�providesr! r r r �provideUtilityB s z0IComponentRegistrationConvenience.provideUtilityc C s dS )a= Register an adapter globally
An adapter is registered to provide an interface with a name
for some number of object types. If a factory implements only
one interface, then the provides argument can be omitted and
the provided interface will be used. (In this case, a provides
argument can still be provided to provide a less specific
interface.)
If the factory has an adapts declaration, then the adapts
argument can be omitted and the declaration will be used. (An
adapts argument can be provided to override the declaration.)
CAUTION: This API should only be used from test or
application-setup code. This API shouldn't be used by regular
library modules, as component registration is a configuration
activity.
Nr )�factoryr5 rB r! r r r �provideAdapterR s z0IComponentRegistrationConvenience.provideAdapterc C s dS )a@ Register a subscription adapter
A subscription adapter is registered to provide an interface
for some number of object types. If a factory implements only
one interface, then the provides argument can be omitted and
the provided interface will be used. (In this case, a provides
argument can still be provided to provide a less specific
interface.)
If the factory has an adapts declaration, then the adapts
argument can be omitted and the declaration will be used. (An
adapts argument can be provided to override the declaration.)
CAUTION: This API should only be used from test or
application-setup code. This API shouldn't be used by regular
library modules, as component registration is a configuration
activity.
Nr )rD r5 rB r r r �provideSubscriptionAdapterf s z<IComponentRegistrationConvenience.provideSubscriptionAdapterc C s dS )a~ Register a handler
Handlers are subscription adapter factories that don't produce
anything. They do all of their work when called. Handlers
are typically used to handle events.
If the handler has an adapts declaration, then the adapts
argument can be omitted and the declaration will be used. (An
adapts argument can be provided to override the declaration.)
CAUTION: This API should only be used from test or
application-setup code. This API shouldn't be used by regular
library modules, as component registration is a configuration
activity.
Nr )Zhandlerr5 r r r �provideHandlerz s z0IComponentRegistrationConvenience.provideHandler)NN)N) r; r< r= r> r rC rE rF rG r r r r rA 9 s
rA c @ s e Zd ZdZdd� Zdd� ZdS )�
IPossibleSitez$An object that could be a site.
c C s dS )z/Sets the site manager for this object.
Nr )Z sitemanagerr r r �setSiteManager� s z IPossibleSite.setSiteManagerc C s dS )z}Returns the site manager contained in this object.
If there isn't a site manager, raise a component lookup.
Nr r r r r r � s z IPossibleSite.getSiteManagerN)r; r< r= r> rI r r r r r rH � s rH c @ s e Zd ZdZdS )�ISitez0Marker interface to indicate that we have a siteN)r; r< r= r> r r r r rJ � s rJ c @ s e Zd ZdZdS )�Misusedz?A component is being used (registered) for the wrong interface.N)r; r< r= r> r r r r rK � s rK c @ s0 e Zd ZdZed�Zed�Zdd� Zdd� ZdS ) �IFactoryz7A factory is responsible for creating other components.zThe factory title.z#A brief description of the factory.c O s dS )z6Return an instance of the objects we're a factory for.Nr )r6 �kwr r r �__call__� s zIFactory.__call__c C s dS )a Get the interfaces implemented by the factory
Return the interface(s), as an instance of Implements, that objects
created by this factory will implement. If the callable's Implements
instance cannot be created, an empty Implements instance is returned.
Nr r r r r �
getInterfaces� s zIFactory.getInterfacesN) r; r< r= r> r �title� descriptionrN rO r r r r rL � s
rL N)#r> Zzope.interfacer r r Zzope.interface.interfacesr r r r r r
r r r
r r r r r r r r r r Zzope.component._compatr r r? rA rH rJ � ExceptionrK rL r r r r �<module> s@ S