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

annotate mercurial/thirdparty/zope/interface/interfaces.py @ 37178:68ee61822182

thirdparty: port zope.interface to relative imports By using relative imports, we're guaranteed to get modules vendored with Mercurial rather than other random modules that might be in sys.path. My editor strips trailing whitespace on save. So some minor source code cleanup was also performed as part of this commit. # no-check-commit because some modified lines have double newlines Differential Revision: https://phab.mercurial-scm.org/D2930

author	Gregory Szorc <gregory.szorc@gmail.com>
date	Wed, 21 Mar 2018 19:52:30 -0700
parents	943d77fc07a3
children

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 #
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	3 # Copyright (c) 2002 Zope Foundation and Contributors.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	4 # All Rights Reserved.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	5 #
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	6 # 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	7 # 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	8 # 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	9 # 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	10 # 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	11 # FOR A PARTICULAR PURPOSE.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	12 #
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 """Interface Package Interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	15 """
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	16
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	17 from __future__ import absolute_import
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	18
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	19 __docformat__ = 'restructuredtext'
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	20
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	21 from .interface import Attribute
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	22 from .interface import Interface
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	23 from .declarations import implementer
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	24
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 _BLANK = u''
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	27
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	28 class IElement(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	29 """Objects that have basic documentation and tagged values.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	32 __name__ = Attribute('__name__', 'The object name')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	33 __doc__ = Attribute('__doc__', 'The object doc string')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	34
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	35 def getTaggedValue(tag):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	36 """Returns the value associated with `tag`.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	37
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	38 Raise a `KeyError` of the tag isn't set.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	39 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	40
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	41 def queryTaggedValue(tag, default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	42 """Returns the value associated with `tag`.
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 Return the default value of the tag isn't set.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	45 """
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 def getTaggedValueTags():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	48 """Returns a list of all tags."""
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 def setTaggedValue(tag, value):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	51 """Associates `value` with `key`."""
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	54 class IAttribute(IElement):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	55 """Attribute descriptors"""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	56
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	57 interface = Attribute('interface',
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	58 'Stores the interface instance in which the '
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	59 'attribute is located.')
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	60
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 IMethod(IAttribute):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	63 """Method attributes"""
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 getSignatureInfo():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	66 """Returns the signature information.
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 This method returns a dictionary with the following keys:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	69
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	70 o `positional` - All positional arguments.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	71
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	72 o `required` - A list of all required arguments.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	73
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	74 o `optional` - A list of all optional arguments.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	75
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	76 o `varargs` - The name of the varargs argument.
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 o `kwargs` - The name of the kwargs argument.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	79 """
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 getSignatureString():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	82 """Return a signature string suitable for inclusion in documentation.
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 This method returns the function signature string. For example, if you
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	85 have `func(a, b, c=1, d='f')`, then the signature string is `(a, b,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	86 c=1, d='f')`.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	87 """
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 class ISpecification(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	90 """Object Behavioral specifications"""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	91
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	92 def providedBy(object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	93 """Test whether the interface is implemented by the object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	94
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	95 Return true of the object asserts that it implements the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	96 interface, including asserting that it implements an extended
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	97 interface.
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 def implementedBy(class_):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	101 """Test whether the interface is implemented by instances of the class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	102
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	103 Return true of the class asserts that its instances implement the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	104 interface, including asserting that they implement an extended
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	105 interface.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	106 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	107
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	108 def isOrExtends(other):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	109 """Test whether the specification is or extends another
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	110 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	111
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	112 def extends(other, strict=True):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	113 """Test whether a specification extends another
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	114
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	115 The specification extends other if it has other as a base
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	116 interface or if one of it's bases extends other.
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 If strict is false, then the specification extends itself.
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 def weakref(callback=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	122 """Return a weakref to the specification
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	123
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	124 This method is, regrettably, needed to allow weakrefs to be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	125 computed to security-proxied specifications. While the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	126 zope.interface package does not require zope.security or
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	127 zope.proxy, it has to be able to coexist with it.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	128
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	131 __bases__ = Attribute("""Base specifications
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 A tuple if specifications from which this specification is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	134 directly derived.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	135
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	136 """)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	137
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	138 __sro__ = Attribute("""Specification-resolution order
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	139
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	140 A tuple of the specification and all of it's ancestor
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	141 specifications from most specific to least specific.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	142
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	143 (This is similar to the method-resolution order for new-style classes.)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	144 """)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	145
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	146 __iro__ = Attribute("""Interface-resolution order
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	147
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	148 A tuple of the of the specification's ancestor interfaces from
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	149 most specific to least specific. The specification itself is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	150 included if it is an interface.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	151
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	152 (This is similar to the method-resolution order for new-style classes.)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	153 """)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	154
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	155 def get(name, default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	156 """Look up the description for a name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	157
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	158 If the named attribute is not defined, the default is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	159 returned.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	160 """
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	163 class IInterface(ISpecification, IElement):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	164 """Interface objects
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	165
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	166 Interface objects describe the behavior of an object by containing
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	167 useful information about the object. This information includes:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	168
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	169 o Prose documentation about the object. In Python terms, this
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	170 is called the "doc string" of the interface. In this element,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	171 you describe how the object works in prose language and any
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	172 other useful information about the object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	173
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	174 o Descriptions of attributes. Attribute descriptions include
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	175 the name of the attribute and prose documentation describing
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	176 the attributes usage.
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 o Descriptions of methods. Method descriptions can include:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	179
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	180 - Prose "doc string" documentation about the method and its
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	181 usage.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	182
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	183 - A description of the methods arguments; how many arguments
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	184 are expected, optional arguments and their default values,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	185 the position or arguments in the signature, whether the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	186 method accepts arbitrary arguments and whether the method
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	187 accepts arbitrary keyword arguments.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	188
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	189 o Optional tagged data. Interface objects (and their attributes and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	190 methods) can have optional, application specific tagged data
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	191 associated with them. Examples uses for this are examples,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	192 security assertions, pre/post conditions, and other possible
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	193 information you may want to associate with an Interface or its
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	194 attributes.
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 Not all of this information is mandatory. For example, you may
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	197 only want the methods of your interface to have prose
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	198 documentation and not describe the arguments of the method in
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	199 exact detail. Interface objects are flexible and let you give or
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	200 take any of these components.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	201
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	202 Interfaces are created with the Python class statement using
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	203 either Interface.Interface or another interface, as in::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	204
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	205 from zope.interface import Interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	206
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	207 class IMyInterface(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	208 '''Interface documentation'''
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	209
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	210 def meth(arg1, arg2):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	211 '''Documentation for meth'''
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	212
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	213 # Note that there is no self argument
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	214
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	215 class IMySubInterface(IMyInterface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	216 '''Interface documentation'''
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	217
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	218 def meth2():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	219 '''Documentation for meth2'''
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 You use interfaces in two ways:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	222
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	223 o You assert that your object implement the interfaces.
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 There are several ways that you can assert that an object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	226 implements an interface:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	227
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	228 1. Call zope.interface.implements in your class definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	229
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	230 2. Call zope.interfaces.directlyProvides on your object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	231
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	232 3. Call 'zope.interface.classImplements' to assert that instances
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	233 of a class implement an interface.
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 For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	236
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	237 from zope.interface import classImplements
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	238
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	239 classImplements(some_class, some_interface)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	240
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	241 This approach is useful when it is not an option to modify
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	242 the class source. Note that this doesn't affect what the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	243 class itself implements, but only what its instances
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	244 implement.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	245
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	246 o You query interface meta-data. See the IInterface methods and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	247 attributes for details.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	248
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	249 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	250
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	251 def names(all=False):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	252 """Get the interface attribute names
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	253
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	254 Return a sequence of the names of the attributes, including
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	255 methods, included in the interface definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	256
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	257 Normally, only directly defined attributes are included. If
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	258 a true positional or keyword argument is given, then
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	259 attributes defined by base classes will be included.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	262 def namesAndDescriptions(all=False):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	263 """Get the interface attribute names and descriptions
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	264
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	265 Return a sequence of the names and descriptions of the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	266 attributes, including methods, as name-value pairs, included
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	267 in the interface definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	268
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	269 Normally, only directly defined attributes are included. If
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	270 a true positional or keyword argument is given, then
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	271 attributes defined by base classes will be included.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	272 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	273
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	274 def __getitem__(name):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	275 """Get the description for a name
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 If the named attribute is not defined, a KeyError is raised.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	278 """
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 def direct(name):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	281 """Get the description for the name if it was defined by the interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	282
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	283 If the interface doesn't define the name, returns None.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	286 def validateInvariants(obj, errors=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	287 """Validate invariants
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	288
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	289 Validate object to defined invariants. If errors is None,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	290 raises first Invalid error; if errors is a list, appends all errors
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	291 to list, then raises Invalid with the errors as the first element
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	292 of the "args" tuple."""
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 def __contains__(name):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	295 """Test whether the name is defined by the interface"""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	296
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	297 def __iter__():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	298 """Return an iterator over the names defined by the interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	299
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	300 The names iterated include all of the names defined by the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	301 interface directly and indirectly by base interfaces.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	304 __module__ = Attribute("""The name of the module defining the interface""")
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 class IDeclaration(ISpecification):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	307 """Interface declaration
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 Declarations are used to express the interfaces implemented by
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	310 classes or provided by objects.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	313 def __contains__(interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	314 """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	315
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	316 Return true if the given interface is one of the interfaces in
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	317 the specification and false otherwise.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	318 """
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 def __iter__():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	321 """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	322 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	323
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	324 def flattened():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	325 """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	326
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	327 An iterator is returned for all interfaces either included in
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	328 or extended by interfaces included in the specifications
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	329 without duplicates. The interfaces are in "interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	330 resolution order". The interface resolution order is such that
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	331 base interfaces are listed after interfaces that extend them
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	332 and, otherwise, interfaces are included in the order that they
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	333 were defined in the specification.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	334 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	335
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	336 def __sub__(interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	337 """Create an interface specification with some interfaces excluded
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 The argument can be an interface or an interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	340 specifications. The interface or interfaces given in a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	341 specification are subtracted from the interface specification.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	342
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	343 Removing an interface that is not in the specification does
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	344 not raise an error. Doing so has no effect.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	345
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	346 Removing an interface also removes sub-interfaces of the interface.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	347
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	348 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	349
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	350 def __add__(interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	351 """Create an interface specification with some interfaces added
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 The argument can be an interface or an interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	354 specifications. The interface or interfaces given in a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	355 specification are added to the interface specification.
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 Adding an interface that is already in the specification does
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	358 not raise an error. Doing so has no effect.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	359 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	360
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	361 def __nonzero__():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	362 """Return a true value of the interface specification is non-empty
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	363 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	364
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	365 class IInterfaceDeclaration(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	366 """Declare and check the interfaces of objects
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	367
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	368 The functions defined in this interface are used to declare the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	369 interfaces that objects provide and to query the interfaces that have
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	370 been declared.
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 Interfaces can be declared for objects in two ways:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	373
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	374 - Interfaces are declared for instances of the object's class
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 - Interfaces are declared for the object directly.
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 The interfaces declared for an object are, therefore, the union of
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	379 interfaces declared for the object directly and the interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	380 declared for instances of the object's class.
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 Note that we say that a class implements the interfaces provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	383 by it's instances. An instance can also provide interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	384 directly. The interfaces provided by an object are the union of
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	385 the interfaces provided directly and the interfaces implemented by
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	386 the class.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	387 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	388
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	389 def providedBy(ob):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	390 """Return the interfaces provided by an object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	391
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	392 This is the union of the interfaces directly provided by an
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	393 object and interfaces implemented by it's class.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	394
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	395 The value returned is an IDeclaration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	396 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	397
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	398 def implementedBy(class_):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	399 """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	400
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	401 The value returned is an IDeclaration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	402 """
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 def classImplements(class_, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	405 """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	406
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	407 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	408 interface specifications (IDeclaration objects).
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 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	411 specifications) are added to any interfaces previously
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	412 declared.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	413
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	414 Consider the following example::
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 class C(A, B):
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	419 classImplements(C, I1, I2)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	420
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 Instances of ``C`` provide ``I1``, ``I2``, and whatever interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	423 instances of ``A`` and ``B`` provide.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	424 """
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 implementer(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	427 """Create a decorator for declaring interfaces implemented by a facory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	428
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	429 A callable is returned that makes an implements declaration on
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	430 objects passed to it.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	431 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	432
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	433 def classImplementsOnly(class_, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	434 """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	435
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	436 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	437 interface specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	438
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	439 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	440 specifications) replace any previous declarations.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	441
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	442 Consider the following example::
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 class C(A, B):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	445 ...
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	446
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	447 classImplements(C, IA, IB. IC)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	448 classImplementsOnly(C. I1, I2)
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 Instances of ``C`` provide only ``I1``, ``I2``, and regardless of
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	451 whatever interfaces instances of ``A`` and ``B`` implement.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	452 """
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	453
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	454 def implementer_only(*interfaces):
37178 68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	455 """Create a decorator for declaring the only interfaces implemented
68ee61822182 thirdparty: port zope.interface to relative imports Gregory Szorc <gregory.szorc@gmail.com> parents: 37176 diff changeset	456
37176 943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	457 A callable is returned that makes an implements declaration on
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	458 objects passed to it.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	459 """
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 def directlyProvidedBy(object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	462 """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	463
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	464 The value returned is an IDeclaration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	465 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	466
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	467 def directlyProvides(object, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	468 """Declare interfaces declared directly for an object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	469
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	470 The arguments after the object are one or more interfaces or
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	471 interface specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	472
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	473 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	474 specifications) replace interfaces previously
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	475 declared for the object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	476
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	477 Consider the following example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	478
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	479 class C(A, B):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	480 ...
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 ob = C()
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	483 directlyProvides(ob, I1, I2)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	484
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	485 The object, ``ob`` provides ``I1``, ``I2``, and whatever interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	486 instances have been declared for instances of ``C``.
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 To remove directly provided interfaces, use ``directlyProvidedBy`` and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	489 subtract the unwanted interfaces. For example::
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 directlyProvides(ob, directlyProvidedBy(ob)-I2)
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 removes I2 from the interfaces directly provided by
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	494 ``ob``. The object, ``ob`` no longer directly provides ``I2``,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	495 although it might still provide ``I2`` if it's class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	496 implements ``I2``.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	497
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	498 To add directly provided interfaces, use ``directlyProvidedBy`` and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	499 include additional interfaces. For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	500
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	501 directlyProvides(ob, directlyProvidedBy(ob), I2)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	502
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	503 adds I2 to the interfaces directly provided by ob.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	504 """
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 def alsoProvides(object, *interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	507 """Declare additional interfaces directly for an object::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	508
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	509 alsoProvides(ob, I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	510
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	511 is equivalent to::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	512
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	513 directlyProvides(ob, directlyProvidedBy(ob), I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	514 """
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 def noLongerProvides(object, interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	517 """Remove an interface from the list of an object's directly
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	518 provided interfaces::
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 noLongerProvides(ob, I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	521
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	522 is equivalent to::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	523
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	524 directlyProvides(ob, directlyProvidedBy(ob)-I1)
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 with the exception that if ``I1`` is an interface that is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	527 provided by ``ob`` through the class's implementation,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	528 ValueError is raised.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	529 """
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 implements(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	532 """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	533
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	534 This function is called in a class definition (Python 2.x only).
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 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	537 specifications (IDeclaration objects).
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 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	540 specifications) are added to any interfaces previously
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	541 declared.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	542
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	543 Previous declarations include declarations for base classes
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	544 unless implementsOnly was used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	545
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	546 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	547 convenient way to call classImplements. For example::
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 implements(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	550
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	551 is equivalent to calling::
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 classImplements(C, I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	554
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	555 after the class has been created.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	556
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	557 Consider the following example (Python 2.x only)::
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 class C(A, B):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	560 implements(I1, I2)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	561
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	562
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	563 Instances of ``C`` implement ``I1``, ``I2``, and whatever interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	564 instances of ``A`` and ``B`` implement.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	567 def implementsOnly(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	568 """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	569
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	570 This function is called in a class definition (Python 2.x only).
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 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 Previous declarations including declarations for base classes
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	576 are overridden.
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 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	579 convenient way to call classImplementsOnly. For example::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	580
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	581 implementsOnly(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	582
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	583 is equivalent to calling::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	584
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	585 classImplementsOnly(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	586
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	587 after the class has been created.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	588
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	589 Consider the following example (Python 2.x only)::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	590
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	591 class C(A, B):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	592 implementsOnly(I1, I2)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	593
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	594
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	595 Instances of ``C`` implement ``I1``, ``I2``, regardless of what
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	596 instances of ``A`` and ``B`` implement.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	597 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	598
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	599 def classProvides(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	600 """Declare interfaces provided directly by a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	601
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	602 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	603
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	604 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	605 specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	606
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	607 The given interfaces (including the interfaces in the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	608 specifications) are used to create the class's direct-object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	609 interface specification. An error will be raised if the module
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	610 class has an direct interface specification. In other words, it is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	611 an error to call this function more than once in a class
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	612 definition.
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 Note that the given interfaces have nothing to do with the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	615 interfaces implemented by instances of the class.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	616
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	617 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	618 convenient 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	619
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	620 classProvides(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	621
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	622 is equivalent to calling::
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	623
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	624 directlyProvides(theclass, I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	625
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	626 after the class has been created.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	627 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	628 def provider(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	629 """A class decorator version of classProvides"""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	630
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	631 def moduleProvides(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	632 """Declare interfaces provided by a module
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 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	635
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	636 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	637 specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	638
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	639 The given interfaces (including the interfaces in the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	640 specifications) are used to create the module's direct-object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	641 interface specification. An error will be raised if the module
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	642 already has an interface specification. In other words, it is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	643 an error to call this function more than once in a module
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	644 definition.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	645
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	646 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	647 convenient way to call directlyProvides for a module. For example::
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 moduleImplements(I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	650
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	651 is equivalent to::
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 directlyProvides(sys.modules[__name__], I1)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	654 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	655
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	656 def Declaration(*interfaces):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	657 """Create an interface specification
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	658
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	659 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	660 specifications (IDeclaration objects).
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	661
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	662 A new interface specification (IDeclaration) with
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	663 the given interfaces is returned.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	664 """
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 class IAdapterRegistry(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	667 """Provide an interface-based registry for adapters
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 This registry registers objects that are in some sense "from" a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	670 sequence of specification to an interface and a name.
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 No specific semantics are assumed for the registered objects,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	673 however, the most common application will be to register factories
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	674 that adapt objects providing required specifications to a provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	675 interface.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	676 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	677
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	678 def register(required, provided, name, value):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	679 """Register a value
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	680
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	681 A value is registered for a sequence of required specifications, a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	682 provided interface, and a name, which must be text.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	685 def registered(required, provided, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	686 """Return the component registered for the given interfaces and name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	687
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	688 name must be text.
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 Unlike the lookup method, this methods won't retrieve
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	691 components registered for more specific required interfaces or
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	692 less specific provided interfaces.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	693
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	694 If no component was registered exactly for the given
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	695 interfaces and name, then None is returned.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	696
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	697 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	698
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	699 def lookup(required, provided, name='', default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	700 """Lookup a value
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	701
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	702 A value is looked up based on a sequence of required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	703 specifications, a provided interface, and a name, which must be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	704 text.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	705 """
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 def queryMultiAdapter(objects, provided, name=_BLANK, default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	708 """Adapt a sequence of objects to a named, provided, interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	709 """
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 def lookup1(required, provided, name=_BLANK, default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	712 """Lookup a value using a single required interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	713
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	714 A value is looked up based on a single required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	715 specifications, a provided interface, and a name, which must be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	716 text.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	719 def queryAdapter(object, provided, name=_BLANK, default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	720 """Adapt an object using a registered adapter factory.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	721 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	722
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	723 def adapter_hook(provided, object, name=_BLANK, default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	724 """Adapt an object using a registered adapter factory.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	725
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	726 name must be text.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	727 """
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 def lookupAll(required, provided):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	730 """Find all adapters from the required to the provided interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	731
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	732 An iterable object is returned that provides name-value two-tuples.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	733 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	734
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	735 def names(required, provided):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	736 """Return the names for which there are registered objects
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	737 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	738
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	739 def subscribe(required, provided, subscriber, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	740 """Register a subscriber
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	741
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	742 A subscriber is registered for a sequence of required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	743 specifications, a provided interface, and a name.
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 Multiple subscribers may be registered for the same (or
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	746 equivalent) interfaces.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	749 def subscriptions(required, provided, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	750 """Get a sequence of subscribers
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	751
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	752 Subscribers for a sequence of required interfaces, and a provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	753 interface are returned.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	756 def subscribers(objects, provided, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	757 """Get a sequence of subscription adapters
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	758 """
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 # begin formerly in zope.component
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	761
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	762 class ComponentLookupError(LookupError):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	763 """A component could not be found."""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	764
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	765 class Invalid(Exception):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	766 """A component doesn't satisfy a promise."""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	767
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	768 class IObjectEvent(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	769 """An event related to an object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	770
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	771 The object that generated this event is not necessarily the object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	772 refered to by location.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	775 object = Attribute("The subject of the event.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	776
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 @implementer(IObjectEvent)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	779 class ObjectEvent(object):
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 def __init__(self, object):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	782 self.object = object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	783
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	784 class IComponentLookup(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	785 """Component Manager for a Site
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	786
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	787 This object manages the components registered at a particular site. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	788 definition of a site is intentionally vague.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	791 adapters = Attribute(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	792 "Adapter Registry to manage all registered adapters.")
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 utilities = Attribute(
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	795 "Adapter Registry to manage all registered utilities.")
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 def queryAdapter(object, interface, name=_BLANK, default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	798 """Look for a named adapter to an interface for an object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	799
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	800 If a matching adapter cannot be found, returns the default.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	803 def getAdapter(object, interface, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	804 """Look for a named adapter to an interface for an object
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 If a matching adapter cannot be found, a ComponentLookupError
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	807 is raised.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	808 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	809
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	810 def queryMultiAdapter(objects, interface, name=_BLANK, default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	811 """Look for a multi-adapter to an interface for multiple objects
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 If a matching adapter cannot be found, returns the default.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	814 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	815
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	816 def getMultiAdapter(objects, interface, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	817 """Look for a multi-adapter to an interface for multiple objects
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 If a matching adapter cannot be found, a ComponentLookupError
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	820 is raised.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	821 """
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 getAdapters(objects, provided):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	824 """Look for all matching adapters to a provided interface for objects
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	825
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	826 Return an iterable of name-adapter pairs for adapters that
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	827 provide the given interface.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	828 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	829
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	830 def subscribers(objects, provided):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	831 """Get subscribers
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	832
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	833 Subscribers are returned that provide the provided interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	834 and that depend on and are comuted from the sequence of
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	835 required objects.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	836 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	837
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	838 def handle(*objects):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	839 """Call handlers for the given objects
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	840
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	841 Handlers registered for the given objects are called.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	842 """
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 def queryUtility(interface, name='', default=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	845 """Look up a utility that provides an interface.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	846
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	847 If one is not found, returns default.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	850 def getUtilitiesFor(interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	851 """Look up the registered utilities that provide an interface.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	852
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	853 Returns an iterable of name-utility pairs.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	856 def getAllUtilitiesRegisteredFor(interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	857 """Return all registered utilities for an interface
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 This includes overridden utilities.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	860
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	861 An iterable of utility instances is returned. No names are
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	862 returned.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	863 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	864
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	865 class IRegistration(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	866 """A registration-information object
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	867 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	868
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	869 registry = Attribute("The registry having the registration")
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 name = Attribute("The registration name")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	872
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	873 info = Attribute("""Information about the registration
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	874
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	875 This is information deemed useful to people browsing the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	876 configuration of a system. It could, for example, include
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	877 commentary or information about the source of the configuration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	878 """)
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 class IUtilityRegistration(IRegistration):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	881 """Information about the registration of a utility
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	882 """
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 factory = Attribute("The factory used to create the utility. Optional.")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	885 component = Attribute("The object registered")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	886 provided = Attribute("The interface provided by the component")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	887
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	888 class _IBaseAdapterRegistration(IRegistration):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	889 """Information about the registration of an adapter
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	892 factory = Attribute("The factory used to create adapters")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	893
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	894 required = Attribute("""The adapted interfaces
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 This is a sequence of interfaces adapters by the registered
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	897 factory. The factory will be caled with a sequence of objects, as
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	898 positional arguments, that provide these interfaces.
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	901 provided = Attribute("""The interface provided by the adapters.
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 This interface is implemented by the factory
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
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	906 class IAdapterRegistration(_IBaseAdapterRegistration):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	907 """Information about the registration of an adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	908 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	909
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	910 class ISubscriptionAdapterRegistration(_IBaseAdapterRegistration):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	911 """Information about the registration of a subscription adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	912 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	913
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	914 class IHandlerRegistration(IRegistration):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	915
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	916 handler = Attribute("An object called used to handle an event")
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	917
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	918 required = Attribute("""The handled interfaces
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	919
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	920 This is a sequence of interfaces handled by the registered
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	921 handler. The handler will be caled with a sequence of objects, as
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	922 positional arguments, that provide these interfaces.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	923 """)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	924
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	925 class IRegistrationEvent(IObjectEvent):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	926 """An event that involves a registration"""
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	927
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	928
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	929 @implementer(IRegistrationEvent)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	930 class RegistrationEvent(ObjectEvent):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	931 """There has been a change in a registration
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	932 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	933 def __repr__(self):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	934 return "%s event:\n%r" % (self.__class__.__name__, self.object)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	935
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	936 class IRegistered(IRegistrationEvent):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	937 """A component or factory was registered
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	938 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	939
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	940 @implementer(IRegistered)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	941 class Registered(RegistrationEvent):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	942 pass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	943
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	944 class IUnregistered(IRegistrationEvent):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	945 """A component or factory was unregistered
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	946 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	947
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	948 @implementer(IUnregistered)
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	949 class Unregistered(RegistrationEvent):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	950 """A component or factory was unregistered
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	951 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	952 pass
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	953
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	954 class IComponentRegistry(Interface):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	955 """Register components
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	956 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	957
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	958 def registerUtility(component=None, provided=None, name=_BLANK,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	959 info=_BLANK, factory=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	960 """Register a utility
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	961
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	962 factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	963 Factory for the component to be registerd.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	964
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	965 component
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	966 The registered component
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	967
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	968 provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	969 This is the interface provided by the utility. If the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	970 component provides a single interface, then this
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	971 argument is optional and the component-implemented
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	972 interface will be used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	973
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	974 name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	975 The utility name.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	976
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	977 info
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	978 An object that can be converted to a string to provide
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	979 information about the registration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	980
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	981 Only one of component and factory can be used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	982 A Registered event is generated with an IUtilityRegistration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	983 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	984
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	985 def unregisterUtility(component=None, provided=None, name=_BLANK,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	986 factory=None):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	987 """Unregister a utility
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	988
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	989 A boolean is returned indicating whether the registry was
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	990 changed. If the given component is None and there is no
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	991 component registered, or if the given component is not
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	992 None and is not registered, then the function returns
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	993 False, otherwise it returns True.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	994
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	995 factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	996 Factory for the component to be unregisterd.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	997
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	998 component
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	999 The registered component The given component can be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1000 None, in which case any component registered to provide
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1001 the given provided interface with the given name is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1002 unregistered.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1003
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1004 provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1005 This is the interface provided by the utility. If the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1006 component is not None and provides a single interface,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1007 then this argument is optional and the
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1008 component-implemented interface will be used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1009
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1010 name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1011 The utility name.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1012
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1013 Only one of component and factory can be used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1014 An UnRegistered event is generated with an IUtilityRegistration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1015 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1016
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1017 def registeredUtilities():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1018 """Return an iterable of IUtilityRegistration instances.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1019
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1020 These registrations describe the current utility registrations
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1021 in the object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1022 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1023
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1024 def registerAdapter(factory, required=None, provided=None, name=_BLANK,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1025 info=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1026 """Register an adapter factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1027
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1028 Parameters:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1029
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1030 factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1031 The object used to compute the adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1032
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1033 required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1034 This is a sequence of specifications for objects to be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1035 adapted. If omitted, then the value of the factory's
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1036 __component_adapts__ attribute will be used. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1037 __component_adapts__ attribute is usually attribute is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1038 normally set in class definitions using adapts
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1039 function, or for callables using the adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1040 decorator. If the factory doesn't have a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1041 __component_adapts__ adapts attribute, then this
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1042 argument is required.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1043
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1044 provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1045 This is the interface provided by the adapter and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1046 implemented by the factory. If the factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1047 implements a single interface, then this argument is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1048 optional and the factory-implemented interface will be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1049 used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1050
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1051 name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1052 The adapter name.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1053
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1054 info
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1055 An object that can be converted to a string to provide
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1056 information about the registration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1057
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1058 A Registered event is generated with an IAdapterRegistration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1059 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1060
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1061 def unregisterAdapter(factory=None, required=None,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1062 provided=None, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1063 """Unregister an adapter factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1064
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1065 A boolean is returned indicating whether the registry was
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1066 changed. If the given component is None and there is no
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1067 component registered, or if the given component is not
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1068 None and is not registered, then the function returns
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1069 False, otherwise it returns True.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1070
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1071 Parameters:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1072
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1073 factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1074 This is the object used to compute the adapter. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1075 factory can be None, in which case any factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1076 registered to implement the given provided interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1077 for the given required specifications with the given
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1078 name is unregistered.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1079
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1080 required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1081 This is a sequence of specifications for objects to be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1082 adapted. If the factory is not None and the required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1083 arguments is omitted, then the value of the factory's
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1084 __component_adapts__ attribute will be used. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1085 __component_adapts__ attribute attribute is normally
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1086 set in class definitions using adapts function, or for
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1087 callables using the adapter decorator. If the factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1088 is None or doesn't have a __component_adapts__ adapts
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1089 attribute, then this argument is required.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1090
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1091 provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1092 This is the interface provided by the adapter and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1093 implemented by the factory. If the factory is not
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1094 None and implements a single interface, then this
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1095 argument is optional and the factory-implemented
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1096 interface will be used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1097
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1098 name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1099 The adapter name.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1100
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1101 An Unregistered event is generated with an IAdapterRegistration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1102 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1103
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1104 def registeredAdapters():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1105 """Return an iterable of IAdapterRegistration instances.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1106
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1107 These registrations describe the current adapter registrations
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1108 in the object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1109 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1110
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1111 def registerSubscriptionAdapter(factory, required=None, provides=None,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1112 name=_BLANK, info=''):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1113 """Register a subscriber factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1114
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1115 Parameters:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1116
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1117 factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1118 The object used to compute the adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1119
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1120 required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1121 This is a sequence of specifications for objects to be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1122 adapted. If omitted, then the value of the factory's
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1123 __component_adapts__ attribute will be used. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1124 __component_adapts__ attribute is usually attribute is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1125 normally set in class definitions using adapts
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1126 function, or for callables using the adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1127 decorator. If the factory doesn't have a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1128 __component_adapts__ adapts attribute, then this
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1129 argument is required.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1130
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1131 provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1132 This is the interface provided by the adapter and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1133 implemented by the factory. If the factory implements
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1134 a single interface, then this argument is optional and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1135 the factory-implemented interface will be used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1136
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1137 name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1138 The adapter name.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1139
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1140 Currently, only the empty string is accepted. Other
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1141 strings will be accepted in the future when support for
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1142 named subscribers is added.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1143
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1144 info
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1145 An object that can be converted to a string to provide
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1146 information about the registration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1147
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1148 A Registered event is generated with an
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1149 ISubscriptionAdapterRegistration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1150 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1151
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1152 def unregisterSubscriptionAdapter(factory=None, required=None,
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1153 provides=None, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1154 """Unregister a subscriber factory.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1155
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1156 A boolean is returned indicating whether the registry was
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1157 changed. If the given component is None and there is no
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1158 component registered, or if the given component is not
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1159 None and is not registered, then the function returns
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1160 False, otherwise it returns True.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1161
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1162 Parameters:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1163
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1164 factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1165 This is the object used to compute the adapter. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1166 factory can be None, in which case any factories
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1167 registered to implement the given provided interface
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1168 for the given required specifications with the given
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1169 name are unregistered.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1170
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1171 required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1172 This is a sequence of specifications for objects to be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1173 adapted. If the factory is not None and the required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1174 arguments is omitted, then the value of the factory's
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1175 __component_adapts__ attribute will be used. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1176 __component_adapts__ attribute attribute is normally
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1177 set in class definitions using adapts function, or for
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1178 callables using the adapter decorator. If the factory
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1179 is None or doesn't have a __component_adapts__ adapts
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1180 attribute, then this argument is required.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1181
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1182 provided
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1183 This is the interface provided by the adapter and
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1184 implemented by the factory. If the factory is not
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1185 None implements a single interface, then this argument
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1186 is optional and the factory-implemented interface will
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1187 be used.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1188
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1189 name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1190 The adapter name.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1191
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1192 Currently, only the empty string is accepted. Other
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1193 strings will be accepted in the future when support for
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1194 named subscribers is added.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1195
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1196 An Unregistered event is generated with an
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1197 ISubscriptionAdapterRegistration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1198 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1199
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1200 def registeredSubscriptionAdapters():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1201 """Return an iterable of ISubscriptionAdapterRegistration instances.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1202
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1203 These registrations describe the current subscription adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1204 registrations in the object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1205 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1206
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1207 def registerHandler(handler, required=None, name=_BLANK, info=''):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1208 """Register a handler.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1209
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1210 A handler is a subscriber that doesn't compute an adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1211 but performs some function when called.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1212
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1213 Parameters:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1214
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1215 handler
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1216 The object used to handle some event represented by
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1217 the objects passed to it.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1218
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1219 required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1220 This is a sequence of specifications for objects to be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1221 adapted. If omitted, then the value of the factory's
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1222 __component_adapts__ attribute will be used. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1223 __component_adapts__ attribute is usually attribute is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1224 normally set in class definitions using adapts
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1225 function, or for callables using the adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1226 decorator. If the factory doesn't have a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1227 __component_adapts__ adapts attribute, then this
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1228 argument is required.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1229
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1230 name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1231 The handler name.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1232
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1233 Currently, only the empty string is accepted. Other
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1234 strings will be accepted in the future when support for
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1235 named handlers is added.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1236
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1237 info
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1238 An object that can be converted to a string to provide
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1239 information about the registration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1240
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1241
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1242 A Registered event is generated with an IHandlerRegistration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1243 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1244
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1245 def unregisterHandler(handler=None, required=None, name=_BLANK):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1246 """Unregister a handler.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1247
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1248 A handler is a subscriber that doesn't compute an adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1249 but performs some function when called.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1250
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1251 A boolean is returned indicating whether the registry was
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1252 changed.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1253
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1254 Parameters:
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1255
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1256 handler
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1257 This is the object used to handle some event
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1258 represented by the objects passed to it. The handler
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1259 can be None, in which case any handlers registered for
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1260 the given required specifications with the given are
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1261 unregistered.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1262
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1263 required
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1264 This is a sequence of specifications for objects to be
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1265 adapted. If omitted, then the value of the factory's
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1266 __component_adapts__ attribute will be used. The
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1267 __component_adapts__ attribute is usually attribute is
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1268 normally set in class definitions using adapts
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1269 function, or for callables using the adapter
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1270 decorator. If the factory doesn't have a
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1271 __component_adapts__ adapts attribute, then this
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1272 argument is required.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1273
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1274 name
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1275 The handler name.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1276
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1277 Currently, only the empty string is accepted. Other
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1278 strings will be accepted in the future when support for
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1279 named handlers is added.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1280
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1281 An Unregistered event is generated with an IHandlerRegistration.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1282 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1283
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1284 def registeredHandlers():
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1285 """Return an iterable of IHandlerRegistration instances.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1286
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1287 These registrations describe the current handler registrations
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1288 in the object.
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1289 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1290
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1291
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1292 class IComponents(IComponentLookup, IComponentRegistry):
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1293 """Component registration and access
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1294 """
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1295
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1296
943d77fc07a3 thirdparty: vendor zope.interface 4.4.3 Gregory Szorc <gregory.szorc@gmail.com> parents: diff changeset	1297 # end formerly in zope.component

Mercurial > public > mercurial-scm > hg

annotate mercurial/thirdparty/zope/interface/interfaces.py @ 37178:68ee61822182