mercurial-scm/hg: mercurial/thirdparty/zope/interface/declarations.py annotate

annotate mercurial/thirdparty/zope/interface/declarations.py @ 37179:49630e75635d

thirdparty: allow zope.interface.advice to be lazily imported The symbol from this module is only used in functions. Let's access that symbol through its imported module so importing zope.interface.advice can be lazy. Differential Revision: https://phab.mercurial-scm.org/D2931

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Wed, 21 Mar 2018 18:13:40 -0700
parents	68ee61822182
children	b9dd8403d8ff

rev	line source
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1 ##############################################################################
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	2 # Copyright (c) 2003 Zope Foundation and Contributors.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	3 # All Rights Reserved.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	4 #
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	5 # This software is subject to the provisions of the Zope Public License,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	6 # Version 2.1 (ZPL). A copy of the ZPL should accompany this distribution.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	7 # THIS SOFTWARE IS PROVIDED "AS IS" AND ANY AND ALL EXPRESS OR IMPLIED
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	8 # WARRANTIES ARE DISCLAIMED, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	9 # WARRANTIES OF TITLE, MERCHANTABILITY, AGAINST INFRINGEMENT, AND FITNESS
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	10 # FOR A PARTICULAR PURPOSE.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	11 ##############################################################################
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	12 """Implementation of interface declarations
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	13
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	14 There are three flavors of declarations:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	15
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	16 - Declarations are used to simply name declared interfaces.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	17
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	18 - ImplementsDeclarations are used to express the interfaces that a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	19 class implements (that instances of the class provides).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	20
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	21 Implements specifications support inheriting interfaces.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	22
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	23 - ProvidesDeclarations are used to express interfaces directly
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	24 provided by objects.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	25
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	26 """
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	27 from __future__ import absolute_import
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	28
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	29 __docformat__ = 'restructuredtext'
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	30
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	31 import sys
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	32 from types import FunctionType
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	33 from types import MethodType
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	34 from types import ModuleType
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	35 import weakref
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	36
37179 49630e75635d thirdparty: allow zope.interface.advice to be lazily imported Gregory Szorc <gregory.szorc@gmail.com> parents: 37178 diff changeset	37 from . import advice as advicemod
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	38 from .interface import InterfaceClass
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	39 from .interface import SpecificationBase
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	40 from .interface import Specification
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	41 from ._compat import CLASS_TYPES as DescriptorAwareMetaClasses
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	42 from ._compat import PYTHON3
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	43
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	44 # Registry of class-implementation specifications
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	45 BuiltinImplementationSpecifications = {}
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	46
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	47 _ADVICE_ERROR = ('Class advice impossible in Python3. '
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	48 'Use the @%s class decorator instead.')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	49
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	50 _ADVICE_WARNING = ('The %s API is deprecated, and will not work in Python3 '
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	51 'Use the @%s class decorator instead.')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	52
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	53 class named(object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	54
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	55 def __init__(self, name):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	56 self.name = name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	57
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	58 def __call__(self, ob):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	59 ob.__component_name__ = self.name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	60 return ob
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	61
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	62 class Declaration(Specification):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	63 """Interface declarations"""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	64
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	65 def __init__(self, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	66 Specification.__init__(self, _normalizeargs(interfaces))
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	67
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	68 def changed(self, originally_changed):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	69 Specification.changed(self, originally_changed)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	70 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	71 del self._v_attrs
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	72 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	73 pass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	74
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	75 def __contains__(self, interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	76 """Test whether an interface is in the specification
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	77 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	78
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	79 return self.extends(interface) and interface in self.interfaces()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	80
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	81 def __iter__(self):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	82 """Return an iterator for the interfaces in the specification
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	83 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	84 return self.interfaces()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	85
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	86 def flattened(self):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	87 """Return an iterator of all included and extended interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	88 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	89 return iter(self.__iro__)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	90
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	91 def __sub__(self, other):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	92 """Remove interfaces from a specification
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	93 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	94 return Declaration(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	95 *[i for i in self.interfaces()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	96 if not [j for j in other.interfaces()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	97 if i.extends(j, 0)]
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	98 ]
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	99 )
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	100
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	101 def __add__(self, other):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	102 """Add two specifications or a specification and an interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	103 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	104 seen = {}
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	105 result = []
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	106 for i in self.interfaces():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	107 seen[i] = 1
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	108 result.append(i)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	109 for i in other.interfaces():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	110 if i not in seen:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	111 seen[i] = 1
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	112 result.append(i)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	113
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	114 return Declaration(*result)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	115
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	116 __radd__ = __add__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	117
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	118
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	119 ##############################################################################
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	120 #
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	121 # Implementation specifications
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	122 #
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	123 # These specify interfaces implemented by instances of classes
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	124
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	125 class Implements(Declaration):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	126
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	127 # class whose specification should be used as additional base
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	128 inherit = None
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	129
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	130 # interfaces actually declared for a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	131 declared = ()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	132
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	133 __name__ = '?'
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	134
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	135 @classmethod
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	136 def named(cls, name, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	137 # Implementation method: Produce an Implements interface with
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	138 # a fully fleshed out __name__ before calling the constructor, which
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	139 # sets bases to the given interfaces and which may pass this object to
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	140 # other objects (e.g., to adjust dependents). If they're sorting or comparing
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	141 # by name, this needs to be set.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	142 inst = cls.__new__(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	143 inst.__name__ = name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	144 inst.__init__(*interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	145 return inst
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	146
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	147 def __repr__(self):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	148 return '<implementedBy %s>' % (self.__name__)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	149
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	150 def __reduce__(self):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	151 return implementedBy, (self.inherit, )
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	152
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	153 def __cmp(self, other):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	154 # Yes, I did mean to name this __cmp, rather than __cmp__.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	155 # It is a private method used by __lt__ and __gt__.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	156 # This is based on, and compatible with, InterfaceClass.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	157 # (The two must be mutually comparable to be able to work in e.g., BTrees.)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	158 # Instances of this class generally don't have a __module__ other than
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	159 # `zope.interface.declarations`, whereas they do have a __name__ that is the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	160 # fully qualified name of the object they are representing.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	161
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	162 # Note, though, that equality and hashing are still identity based. This
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	163 # accounts for things like nested objects that have the same name (typically
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	164 # only in tests) and is consistent with pickling. As far as comparisons to InterfaceClass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	165 # goes, we'll never have equal name and module to those, so we're still consistent there.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	166 # Instances of this class are essentially intended to be unique and are
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	167 # heavily cached (note how our __reduce__ handles this) so having identity
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	168 # based hash and eq should also work.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	169 if other is None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	170 return -1
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	171
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	172 n1 = (self.__name__, self.__module__)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	173 n2 = (getattr(other, '__name__', ''), getattr(other, '__module__', ''))
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	174
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	175 # This spelling works under Python3, which doesn't have cmp().
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	176 return (n1 > n2) - (n1 < n2)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	177
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	178 def __hash__(self):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	179 return Declaration.__hash__(self)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	180
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	181 # We want equality to be based on identity. However, we can't actually
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	182 # implement __eq__/__ne__ to do this because sometimes we get wrapped in a proxy.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	183 # We need to let the proxy types implement these methods so they can handle unwrapping
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	184 # and then rely on: (1) the interpreter automatically changing `implements == proxy` into
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	185 # `proxy == implements` (which will call proxy.__eq__ to do the unwrapping) and then
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	186 # (2) the default equality semantics being identity based.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	187
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	188 def __lt__(self, other):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	189 c = self.__cmp(other)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	190 return c < 0
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	191
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	192 def __le__(self, other):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	193 c = self.__cmp(other)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	194 return c <= 0
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	195
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	196 def __gt__(self, other):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	197 c = self.__cmp(other)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	198 return c > 0
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	199
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	200 def __ge__(self, other):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	201 c = self.__cmp(other)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	202 return c >= 0
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	203
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	204 def _implements_name(ob):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	205 # Return the __name__ attribute to be used by its __implemented__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	206 # property.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	207 # This must be stable for the "same" object across processes
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	208 # because it is used for sorting. It needn't be unique, though, in cases
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	209 # like nested classes named Foo created by different functions, because
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	210 # equality and hashing is still based on identity.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	211 # It might be nice to use __qualname__ on Python 3, but that would produce
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	212 # different values between Py2 and Py3.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	213 return (getattr(ob, '__module__', '?') or '?') + \
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	214 '.' + (getattr(ob, '__name__', '?') or '?')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	215
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	216 def implementedByFallback(cls):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	217 """Return the interfaces implemented for a class' instances
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	218
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	219 The value returned is an IDeclaration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	220 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	221 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	222 spec = cls.__dict__.get('__implemented__')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	223 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	224
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	225 # we can't get the class dict. This is probably due to a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	226 # security proxy. If this is the case, then probably no
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	227 # descriptor was installed for the class.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	228
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	229 # We don't want to depend directly on zope.security in
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	230 # zope.interface, but we'll try to make reasonable
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	231 # accommodations in an indirect way.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	232
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	233 # We'll check to see if there's an implements:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	234
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	235 spec = getattr(cls, '__implemented__', None)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	236 if spec is None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	237 # There's no spec stred in the class. Maybe its a builtin:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	238 spec = BuiltinImplementationSpecifications.get(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	239 if spec is not None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	240 return spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	241 return _empty
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	242
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	243 if spec.__class__ == Implements:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	244 # we defaulted to _empty or there was a spec. Good enough.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	245 # Return it.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	246 return spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	247
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	248 # TODO: need old style __implements__ compatibility?
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	249 # Hm, there's an __implemented__, but it's not a spec. Must be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	250 # an old-style declaration. Just compute a spec for it
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	251 return Declaration(*_normalizeargs((spec, )))
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	252
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	253 if isinstance(spec, Implements):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	254 return spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	255
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	256 if spec is None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	257 spec = BuiltinImplementationSpecifications.get(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	258 if spec is not None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	259 return spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	260
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	261 # TODO: need old style __implements__ compatibility?
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	262 spec_name = _implements_name(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	263 if spec is not None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	264 # old-style __implemented__ = foo declaration
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	265 spec = (spec, ) # tuplefy, as it might be just an int
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	266 spec = Implements.named(spec_name, *_normalizeargs(spec))
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	267 spec.inherit = None # old-style implies no inherit
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	268 del cls.__implemented__ # get rid of the old-style declaration
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	269 else:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	270 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	271 bases = cls.__bases__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	272 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	273 if not callable(cls):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	274 raise TypeError("ImplementedBy called for non-factory", cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	275 bases = ()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	276
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	277 spec = Implements.named(spec_name, *[implementedBy(c) for c in bases])
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	278 spec.inherit = cls
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	279
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	280 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	281 cls.__implemented__ = spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	282 if not hasattr(cls, '__providedBy__'):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	283 cls.__providedBy__ = objectSpecificationDescriptor
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	284
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	285 if (isinstance(cls, DescriptorAwareMetaClasses)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	286 and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	287 '__provides__' not in cls.__dict__):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	288 # Make sure we get a __provides__ descriptor
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	289 cls.__provides__ = ClassProvides(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	290 cls,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	291 getattr(cls, '__class__', type(cls)),
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	292 )
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	293
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	294 except TypeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	295 if not isinstance(cls, type):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	296 raise TypeError("ImplementedBy called for non-type", cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	297 BuiltinImplementationSpecifications[cls] = spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	298
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	299 return spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	300
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	301 implementedBy = implementedByFallback
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	302
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	303 def classImplementsOnly(cls, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	304 """Declare the only interfaces implemented by instances of a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	305
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	306 The arguments after the class are one or more interfaces or interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	307 specifications (``IDeclaration`` objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	308
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	309 The interfaces given (including the interfaces in the specifications)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	310 replace any previous declarations.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	311 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	312 spec = implementedBy(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	313 spec.declared = ()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	314 spec.inherit = None
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	315 classImplements(cls, *interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	316
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	317 def classImplements(cls, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	318 """Declare additional interfaces implemented for instances of a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	319
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	320 The arguments after the class are one or more interfaces or
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	321 interface specifications (``IDeclaration`` objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	322
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	323 The interfaces given (including the interfaces in the specifications)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	324 are added to any interfaces previously declared.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	325 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	326 spec = implementedBy(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	327 spec.declared += tuple(_normalizeargs(interfaces))
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	328
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	329 # compute the bases
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	330 bases = []
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	331 seen = {}
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	332 for b in spec.declared:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	333 if b not in seen:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	334 seen[b] = 1
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	335 bases.append(b)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	336
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	337 if spec.inherit is not None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	338
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	339 for c in spec.inherit.__bases__:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	340 b = implementedBy(c)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	341 if b not in seen:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	342 seen[b] = 1
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	343 bases.append(b)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	344
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	345 spec.__bases__ = tuple(bases)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	346
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	347 def _implements_advice(cls):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	348 interfaces, classImplements = cls.__dict__['__implements_advice_data__']
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	349 del cls.__implements_advice_data__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	350 classImplements(cls, *interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	351 return cls
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	352
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	353
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	354 class implementer:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	355 """Declare the interfaces implemented by instances of a class.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	356
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	357 This function is called as a class decorator.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	358
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	359 The arguments are one or more interfaces or interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	360 specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	361
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	362 The interfaces given (including the interfaces in the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	363 specifications) are added to any interfaces previously
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	364 declared.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	365
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	366 Previous declarations include declarations for base classes
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	367 unless implementsOnly was used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	368
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	369 This function is provided for convenience. It provides a more
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	370 convenient way to call classImplements. For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	371
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	372 @implementer(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	373 class C(object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	374 pass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	375
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	376 is equivalent to calling::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	377
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	378 classImplements(C, I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	379
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	380 after the class has been created.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	381 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	382
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	383 def __init__(self, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	384 self.interfaces = interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	385
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	386 def __call__(self, ob):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	387 if isinstance(ob, DescriptorAwareMetaClasses):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	388 classImplements(ob, *self.interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	389 return ob
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	390
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	391 spec_name = _implements_name(ob)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	392 spec = Implements.named(spec_name, *self.interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	393 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	394 ob.__implemented__ = spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	395 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	396 raise TypeError("Can't declare implements", ob)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	397 return ob
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	398
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	399 class implementer_only:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	400 """Declare the only interfaces implemented by instances of a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	401
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	402 This function is called as a class decorator.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	403
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	404 The arguments are one or more interfaces or interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	405 specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	406
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	407 Previous declarations including declarations for base classes
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	408 are overridden.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	409
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	410 This function is provided for convenience. It provides a more
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	411 convenient way to call classImplementsOnly. For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	412
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	413 @implementer_only(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	414 class C(object): pass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	415
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	416 is equivalent to calling::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	417
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	418 classImplementsOnly(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	419
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	420 after the class has been created.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	421 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	422
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	423 def __init__(self, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	424 self.interfaces = interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	425
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	426 def __call__(self, ob):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	427 if isinstance(ob, (FunctionType, MethodType)):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	428 # XXX Does this decorator make sense for anything but classes?
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	429 # I don't think so. There can be no inheritance of interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	430 # on a method pr function....
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	431 raise ValueError('The implementer_only decorator is not '
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	432 'supported for methods or functions.')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	433 else:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	434 # Assume it's a class:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	435 classImplementsOnly(ob, *self.interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	436 return ob
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	437
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	438 def _implements(name, interfaces, classImplements):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	439 # This entire approach is invalid under Py3K. Don't even try to fix
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	440 # the coverage for this block there. :(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	441 frame = sys._getframe(2)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	442 locals = frame.f_locals
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	443
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	444 # Try to make sure we were called from a class def. In 2.2.0 we can't
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	445 # check for __module__ since it doesn't seem to be added to the locals
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	446 # until later on.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	447 if locals is frame.f_globals or '__module__' not in locals:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	448 raise TypeError(name+" can be used only from a class definition.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	449
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	450 if '__implements_advice_data__' in locals:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	451 raise TypeError(name+" can be used only once in a class definition.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	452
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	453 locals['__implements_advice_data__'] = interfaces, classImplements
37179 49630e75635d thirdparty: allow zope.interface.advice to be lazily imported Gregory Szorc <gregory.szorc@gmail.com> parents: 37178 diff changeset	454 advicemod.addClassAdvisor(_implements_advice, depth=3)
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	455
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	456 def implements(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	457 """Declare interfaces implemented by instances of a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	458
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	459 This function is called in a class definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	460
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	461 The arguments are one or more interfaces or interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	462 specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	463
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	464 The interfaces given (including the interfaces in the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	465 specifications) are added to any interfaces previously
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	466 declared.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	467
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	468 Previous declarations include declarations for base classes
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	469 unless implementsOnly was used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	470
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	471 This function is provided for convenience. It provides a more
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	472 convenient way to call classImplements. For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	473
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	474 implements(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	475
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	476 is equivalent to calling::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	477
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	478 classImplements(C, I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	479
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	480 after the class has been created.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	481 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	482 # This entire approach is invalid under Py3K. Don't even try to fix
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	483 # the coverage for this block there. :(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	484 if PYTHON3:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	485 raise TypeError(_ADVICE_ERROR % 'implementer')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	486 _implements("implements", interfaces, classImplements)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	487
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	488 def implementsOnly(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	489 """Declare the only interfaces implemented by instances of a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	490
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	491 This function is called in a class definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	492
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	493 The arguments are one or more interfaces or interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	494 specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	495
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	496 Previous declarations including declarations for base classes
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	497 are overridden.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	498
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	499 This function is provided for convenience. It provides a more
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	500 convenient way to call classImplementsOnly. For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	501
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	502 implementsOnly(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	503
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	504 is equivalent to calling::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	505
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	506 classImplementsOnly(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	507
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	508 after the class has been created.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	509 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	510 # This entire approach is invalid under Py3K. Don't even try to fix
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	511 # the coverage for this block there. :(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	512 if PYTHON3:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	513 raise TypeError(_ADVICE_ERROR % 'implementer_only')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	514 _implements("implementsOnly", interfaces, classImplementsOnly)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	515
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	516 ##############################################################################
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	517 #
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	518 # Instance declarations
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	519
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	520 class Provides(Declaration): # Really named ProvidesClass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	521 """Implement __provides__, the instance-specific specification
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	522
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	523 When an object is pickled, we pickle the interfaces that it implements.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	524 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	525
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	526 def __init__(self, cls, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	527 self.__args = (cls, ) + interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	528 self._cls = cls
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	529 Declaration.__init__(self, *(interfaces + (implementedBy(cls), )))
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	530
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	531 def __reduce__(self):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	532 return Provides, self.__args
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	533
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	534 __module__ = 'zope.interface'
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	535
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	536 def __get__(self, inst, cls):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	537 """Make sure that a class __provides__ doesn't leak to an instance
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	538 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	539 if inst is None and cls is self._cls:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	540 # We were accessed through a class, so we are the class'
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	541 # provides spec. Just return this object, but only if we are
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	542 # being called on the same class that we were defined for:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	543 return self
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	544
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	545 raise AttributeError('__provides__')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	546
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	547 ProvidesClass = Provides
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	548
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	549 # Registry of instance declarations
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	550 # This is a memory optimization to allow objects to share specifications.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	551 InstanceDeclarations = weakref.WeakValueDictionary()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	552
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	553 def Provides(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	554 """Cache instance declarations
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	555
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	556 Instance declarations are shared among instances that have the same
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	557 declaration. The declarations are cached in a weak value dictionary.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	558 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	559 spec = InstanceDeclarations.get(interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	560 if spec is None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	561 spec = ProvidesClass(*interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	562 InstanceDeclarations[interfaces] = spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	563
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	564 return spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	565
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	566 Provides.__safe_for_unpickling__ = True
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	567
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	568
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	569 def directlyProvides(object, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	570 """Declare interfaces declared directly for an object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	571
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	572 The arguments after the object are one or more interfaces or interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	573 specifications (``IDeclaration`` objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	574
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	575 The interfaces given (including the interfaces in the specifications)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	576 replace interfaces previously declared for the object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	577 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	578 cls = getattr(object, '__class__', None)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	579 if cls is not None and getattr(cls, '__class__', None) is cls:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	580 # It's a meta class (well, at least it it could be an extension class)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	581 # Note that we can't get here from Py3k tests: there is no normal
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	582 # class which isn't descriptor aware.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	583 if not isinstance(object,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	584 DescriptorAwareMetaClasses):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	585 raise TypeError("Attempt to make an interface declaration on a "
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	586 "non-descriptor-aware class")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	587
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	588 interfaces = _normalizeargs(interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	589 if cls is None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	590 cls = type(object)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	591
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	592 issub = False
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	593 for damc in DescriptorAwareMetaClasses:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	594 if issubclass(cls, damc):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	595 issub = True
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	596 break
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	597 if issub:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	598 # we have a class or type. We'll use a special descriptor
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	599 # that provides some extra caching
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	600 object.__provides__ = ClassProvides(object, cls, *interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	601 else:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	602 object.__provides__ = Provides(cls, *interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	603
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	604
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	605 def alsoProvides(object, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	606 """Declare interfaces declared directly for an object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	607
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	608 The arguments after the object are one or more interfaces or interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	609 specifications (``IDeclaration`` objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	610
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	611 The interfaces given (including the interfaces in the specifications) are
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	612 added to the interfaces previously declared for the object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	613 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	614 directlyProvides(object, directlyProvidedBy(object), *interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	615
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	616 def noLongerProvides(object, interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	617 """ Removes a directly provided interface from an object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	618 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	619 directlyProvides(object, directlyProvidedBy(object) - interface)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	620 if interface.providedBy(object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	621 raise ValueError("Can only remove directly provided interfaces.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	622
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	623 class ClassProvidesBaseFallback(object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	624
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	625 def __get__(self, inst, cls):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	626 if cls is self._cls:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	627 # We only work if called on the class we were defined for
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	628
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	629 if inst is None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	630 # We were accessed through a class, so we are the class'
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	631 # provides spec. Just return this object as is:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	632 return self
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	633
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	634 return self._implements
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	635
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	636 raise AttributeError('__provides__')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	637
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	638 ClassProvidesBasePy = ClassProvidesBaseFallback # BBB
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	639 ClassProvidesBase = ClassProvidesBaseFallback
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	640
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	641 # Try to get C base:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	642 try:
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	643 from . import _zope_interface_coptimizations
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	644 except ImportError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	645 pass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	646 else:
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	647 from ._zope_interface_coptimizations import ClassProvidesBase
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	648
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	649
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	650 class ClassProvides(Declaration, ClassProvidesBase):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	651 """Special descriptor for class __provides__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	652
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	653 The descriptor caches the implementedBy info, so that
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	654 we can get declarations for objects without instance-specific
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	655 interfaces a bit quicker.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	656 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	657 def __init__(self, cls, metacls, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	658 self._cls = cls
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	659 self._implements = implementedBy(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	660 self.__args = (cls, metacls, ) + interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	661 Declaration.__init__(self, *(interfaces + (implementedBy(metacls), )))
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	662
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	663 def __reduce__(self):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	664 return self.__class__, self.__args
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	665
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	666 # Copy base-class method for speed
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	667 __get__ = ClassProvidesBase.__get__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	668
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	669 def directlyProvidedBy(object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	670 """Return the interfaces directly provided by the given object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	671
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	672 The value returned is an ``IDeclaration``.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	673 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	674 provides = getattr(object, "__provides__", None)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	675 if (provides is None # no spec
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	676 or
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	677 # We might have gotten the implements spec, as an
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	678 # optimization. If so, it's like having only one base, that we
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	679 # lop off to exclude class-supplied declarations:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	680 isinstance(provides, Implements)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	681 ):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	682 return _empty
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	683
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	684 # Strip off the class part of the spec:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	685 return Declaration(provides.__bases__[:-1])
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	686
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	687 def classProvides(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	688 """Declare interfaces provided directly by a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	689
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	690 This function is called in a class definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	691
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	692 The arguments are one or more interfaces or interface specifications
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	693 (``IDeclaration`` objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	694
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	695 The given interfaces (including the interfaces in the specifications)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	696 are used to create the class's direct-object interface specification.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	697 An error will be raised if the module class has an direct interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	698 specification. In other words, it is an error to call this function more
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	699 than once in a class definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	700
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	701 Note that the given interfaces have nothing to do with the interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	702 implemented by instances of the class.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	703
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	704 This function is provided for convenience. It provides a more convenient
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	705 way to call directlyProvides for a class. For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	706
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	707 classProvides(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	708
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	709 is equivalent to calling::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	710
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	711 directlyProvides(theclass, I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	712
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	713 after the class has been created.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	714 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	715 # This entire approach is invalid under Py3K. Don't even try to fix
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	716 # the coverage for this block there. :(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	717
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	718 if PYTHON3:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	719 raise TypeError(_ADVICE_ERROR % 'provider')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	720
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	721 frame = sys._getframe(1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	722 locals = frame.f_locals
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	723
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	724 # Try to make sure we were called from a class def
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	725 if (locals is frame.f_globals) or ('__module__' not in locals):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	726 raise TypeError("classProvides can be used only from a "
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	727 "class definition.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	728
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	729 if '__provides__' in locals:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	730 raise TypeError(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	731 "classProvides can only be used once in a class definition.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	732
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	733 locals["__provides__"] = _normalizeargs(interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	734
37179 49630e75635d thirdparty: allow zope.interface.advice to be lazily imported Gregory Szorc <gregory.szorc@gmail.com> parents: 37178 diff changeset	735 advicemod.addClassAdvisor(_classProvides_advice, depth=2)
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	736
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	737 def _classProvides_advice(cls):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	738 # This entire approach is invalid under Py3K. Don't even try to fix
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	739 # the coverage for this block there. :(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	740 interfaces = cls.__dict__['__provides__']
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	741 del cls.__provides__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	742 directlyProvides(cls, *interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	743 return cls
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	744
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	745 class provider:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	746 """Class decorator version of classProvides"""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	747
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	748 def __init__(self, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	749 self.interfaces = interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	750
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	751 def __call__(self, ob):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	752 directlyProvides(ob, *self.interfaces)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	753 return ob
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	754
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	755 def moduleProvides(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	756 """Declare interfaces provided by a module
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	757
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	758 This function is used in a module definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	759
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	760 The arguments are one or more interfaces or interface specifications
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	761 (``IDeclaration`` objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	762
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	763 The given interfaces (including the interfaces in the specifications) are
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	764 used to create the module's direct-object interface specification. An
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	765 error will be raised if the module already has an interface specification.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	766 In other words, it is an error to call this function more than once in a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	767 module definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	768
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	769 This function is provided for convenience. It provides a more convenient
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	770 way to call directlyProvides. For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	771
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	772 moduleImplements(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	773
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	774 is equivalent to::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	775
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	776 directlyProvides(sys.modules[__name__], I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	777 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	778 frame = sys._getframe(1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	779 locals = frame.f_locals
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	780
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	781 # Try to make sure we were called from a class def
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	782 if (locals is not frame.f_globals) or ('__name__' not in locals):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	783 raise TypeError(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	784 "moduleProvides can only be used from a module definition.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	785
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	786 if '__provides__' in locals:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	787 raise TypeError(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	788 "moduleProvides can only be used once in a module definition.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	789
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	790 locals["__provides__"] = Provides(ModuleType,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	791 *_normalizeargs(interfaces))
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	792
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	793 ##############################################################################
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	794 #
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	795 # Declaration querying support
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	796
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	797 # XXX: is this a fossil? Nobody calls it, no unit tests exercise it, no
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	798 # doctests import it, and the package __init__ doesn't import it.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	799 def ObjectSpecification(direct, cls):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	800 """Provide object specifications
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	801
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	802 These combine information for the object and for it's classes.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	803 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	804 return Provides(cls, direct) # pragma: no cover fossil
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	805
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	806 def getObjectSpecificationFallback(ob):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	807
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	808 provides = getattr(ob, '__provides__', None)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	809 if provides is not None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	810 if isinstance(provides, SpecificationBase):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	811 return provides
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	812
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	813 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	814 cls = ob.__class__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	815 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	816 # We can't get the class, so just consider provides
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	817 return _empty
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	818
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	819 return implementedBy(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	820
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	821 getObjectSpecification = getObjectSpecificationFallback
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	822
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	823 def providedByFallback(ob):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	824
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	825 # Here we have either a special object, an old-style declaration
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	826 # or a descriptor
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	827
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	828 # Try to get __providedBy__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	829 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	830 r = ob.__providedBy__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	831 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	832 # Not set yet. Fall back to lower-level thing that computes it
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	833 return getObjectSpecification(ob)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	834
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	835 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	836 # We might have gotten a descriptor from an instance of a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	837 # class (like an ExtensionClass) that doesn't support
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	838 # descriptors. We'll make sure we got one by trying to get
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	839 # the only attribute, which all specs have.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	840 r.extends
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	841
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	842 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	843
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	844 # The object's class doesn't understand descriptors.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	845 # Sigh. We need to get an object descriptor, but we have to be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	846 # careful. We want to use the instance's __provides__, if
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	847 # there is one, but only if it didn't come from the class.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	848
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	849 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	850 r = ob.__provides__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	851 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	852 # No __provides__, so just fall back to implementedBy
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	853 return implementedBy(ob.__class__)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	854
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	855 # We need to make sure we got the __provides__ from the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	856 # instance. We'll do this by making sure we don't get the same
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	857 # thing from the class:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	858
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	859 try:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	860 cp = ob.__class__.__provides__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	861 except AttributeError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	862 # The ob doesn't have a class or the class has no
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	863 # provides, assume we're done:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	864 return r
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	865
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	866 if r is cp:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	867 # Oops, we got the provides from the class. This means
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	868 # the object doesn't have it's own. We should use implementedBy
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	869 return implementedBy(ob.__class__)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	870
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	871 return r
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	872 providedBy = providedByFallback
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	873
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	874 class ObjectSpecificationDescriptorFallback(object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	875 """Implement the `__providedBy__` attribute
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	876
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	877 The `__providedBy__` attribute computes the interfaces peovided by
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	878 an object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	879 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	880
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	881 def __get__(self, inst, cls):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	882 """Get an object specification for an object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	883 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	884 if inst is None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	885 return getObjectSpecification(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	886
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	887 provides = getattr(inst, '__provides__', None)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	888 if provides is not None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	889 return provides
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	890
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	891 return implementedBy(cls)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	892
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	893 ObjectSpecificationDescriptor = ObjectSpecificationDescriptorFallback
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	894
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	895 ##############################################################################
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	896
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	897 def _normalizeargs(sequence, output = None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	898 """Normalize declaration arguments
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	899
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	900 Normalization arguments might contain Declarions, tuples, or single
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	901 interfaces.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	902
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	903 Anything but individial interfaces or implements specs will be expanded.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	904 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	905 if output is None:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	906 output = []
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	907
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	908 cls = sequence.__class__
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	909 if InterfaceClass in cls.__mro__ or Implements in cls.__mro__:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	910 output.append(sequence)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	911 else:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	912 for v in sequence:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	913 _normalizeargs(v, output)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	914
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	915 return output
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	916
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	917 _empty = Declaration()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	918
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	919 try:
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	920 from . import _zope_interface_coptimizations
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	921 except ImportError:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	922 pass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	923 else:
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	924 from ._zope_interface_coptimizations import implementedBy
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	925 from ._zope_interface_coptimizations import providedBy
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	926 from ._zope_interface_coptimizations import (
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	927 getObjectSpecification)
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	928 from ._zope_interface_coptimizations import (
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	929 ObjectSpecificationDescriptor)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	930
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	931 objectSpecificationDescriptor = ObjectSpecificationDescriptor()

Mercurial > public > mercurial-scm > hg

annotate mercurial/thirdparty/zope/interface/declarations.py @ 37179:49630e75635d