Kc@sdZdZddlmZddlmZdefdYZdefdYZd efd YZd efd YZ d e efdYZ de fdYZ defdYZ defdYZ dS(sWInterface Package Interfaces $Id: interfaces.py 110699 2010-04-09 08:16:17Z regebro $ trestructuredtexti(t Interface(t AttributetIElementcBsSeZdZeddZeddZdZd dZdZdZRS( s=Objects that have basic documentation and tagged values. t__name__sThe object namet__doc__sThe object doc stringcCsdS(scReturns the value associated with `tag`. Raise a `KeyError` of the tag isn't set. N((ttag((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytgetTaggedValuescCsdS(siReturns the value associated with `tag`. Return the default value of the tag isn't set. N((Rtdefault((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytqueryTaggedValue%scCsdS(sReturns a list of all tags.N((((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytgetTaggedValueTags+scCsdS(sAssociates `value` with `key`.N((Rtvalue((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytsetTaggedValue.sN( Rt __module__RRRtNoneR R R (((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyRs   t IAttributecBseZdZeddZRS(sAttribute descriptorst interfaces@Stores the interface instance in which the attribute is located.(RR RRR(((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR2stIMethodcBs eZdZdZdZRS(sMethod attributescCsdS(sReturns the signature information. This method returns a dictionary with the following keys: o `positional` - All positional arguments. o `required` - A list of all required arguments. o `optional` - A list of all optional arguments. o `varargs` - The name of the varargs argument. o `kwargs` - The name of the kwargs argument. N((((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytgetSignatureInfo=scCsdS(sReturn a signature string suitable for inclusion in documentation. This method returns the function signature string. For example, if you have `func(a, b, c=1, d='f')`, then the signature string is `(a, b, c=1, d='f')`. N((((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytgetSignatureStringMs(RR RRR(((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR:s tISpecificationcBs_eZdZedZdZddZedZ edZ edZ ddZ RS( s Object Behavioral specificationscCsdS(sTest whether a specification extends another The specification extends other if it has other as a base interface or if one of it's bases extends other. If strict is false, then the specification extends itself. N((tothertstrict((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytextendsXscCsdS(s=Test whether the specification is or extends another N((R((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt isOrExtendsascCsdS(s/Return a weakref to the specification This method is, regrettably, needed to allow weakrefs to be computed to security-proxied specifications. While the zope.interface package does not require zope.security or zope.proxy, it has to be able to coexist with it. N((tcallback((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytweakrefessoBase specifications A tuple if specifications from which this specification is directly derived. sSpecification-resolution order A tuple of the specification and all of it's ancestor specifications from most specific to least specific. (This is similar to the method-resolution order for new-style classes.) sInterface-resolution order A tuple of the of the specification's ancestor interfaces from most specific to least specific. The specification itself is included if it is an interface. (This is similar to the method-resolution order for new-style classes.) cCsdS(s|Look up the description for a name If the named attribute is not defined, the default is returned. N((tnameR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytgetsN( RR RtTrueRRRRRt __bases__t__sro__t__iro__R(((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyRUs     t IInterfacecBsteZdZdZdZedZedZdZdZ d dZ dZ d Z ed ZRS( sE Interface objects Interface objects describe the behavior of an object by containing useful information about the object. This information includes: o Prose documentation about the object. In Python terms, this is called the "doc string" of the interface. In this element, you describe how the object works in prose language and any other useful information about the object. o Descriptions of attributes. Attribute descriptions include the name of the attribute and prose documentation describing the attributes usage. o Descriptions of methods. Method descriptions can include: - Prose "doc string" documentation about the method and its usage. - A description of the methods arguments; how many arguments are expected, optional arguments and their default values, the position or arguments in the signature, whether the method accepts arbitrary arguments and whether the method accepts arbitrary keyword arguments. o Optional tagged data. Interface objects (and their attributes and methods) can have optional, application specific tagged data associated with them. Examples uses for this are examples, security assertions, pre/post conditions, and other possible information you may want to associate with an Interface or its attributes. Not all of this information is mandatory. For example, you may only want the methods of your interface to have prose documentation and not describe the arguments of the method in exact detail. Interface objects are flexible and let you give or take any of these components. Interfaces are created with the Python class statement using either Interface.Interface or another interface, as in:: from zope.interface import Interface class IMyInterface(Interface): '''Interface documentation''' def meth(arg1, arg2): '''Documentation for meth''' # Note that there is no self argument class IMySubInterface(IMyInterface): '''Interface documentation''' def meth2(): '''Documentation for meth2''' You use interfaces in two ways: o You assert that your object implement the interfaces. There are several ways that you can assert that an object implements an interface: 1. Call zope.interface.implements in your class definition. 2. Call zope.interfaces.directlyProvides on your object. 3. Call 'zope.interface.classImplements' to assert that instances of a class implement an interface. For example:: from zope.interface import classImplements classImplements(some_class, some_interface) This approach is useful when it is not an option to modify the class source. Note that this doesn't affect what the class itself implements, but only what its instances implement. o You query interface meta-data. See the IInterface methods and attributes for details. cCsdS(sTest whether the interface is implemented by the object Return true of the object asserts that it implements the interface, including asserting that it implements an extended interface. N((tobject((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt providedByscCsdS(sTest whether the interface is implemented by instances of the class Return true of the class asserts that its instances implement the interface, including asserting that they implement an extended interface. N((tclass_((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt implementedByscCsdS(seGet the interface attribute names Return a sequence of the names of the attributes, including methods, included in the interface definition. Normally, only directly defined attributes are included. If a true positional or keyword argument is given, then attributes defined by base classes will be included. N((tall((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytnamesscCsdS(sGet the interface attribute names and descriptions Return a sequence of the names and descriptions of the attributes, including methods, as name-value pairs, included in the interface definition. Normally, only directly defined attributes are included. If a true positional or keyword argument is given, then attributes defined by base classes will be included. N((R&((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytnamesAndDescriptionsscCsdS(smGet the description for a name If the named attribute is not defined, a KeyError is raised. N((R((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt __getitem__scCsdS(sGet the description for the name if it was defined by the interface If the interface doesn't define the name, returns None. N((R((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytdirectscCsdS(s Validate invariants Validate object to defined invariants. If errors is None, raises first Invalid error; if errors is a list, appends all errors to list, then raises Invalid with the errors as the first element of the "args" tuple.N((tobjterrors((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytvalidateInvariantsscCsdS(s1Test whether the name is defined by the interfaceN((R((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt __contains__"scCsdS(sReturn an iterator over the names defined by the interface The names iterated include all of the names defined by the interface directly and indirectly by base interfaces. N((((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt__iter__%ss-The name of the module defining the interfaceN(RR RR#R%tFalseR'R(R)R*RR-R.R/R(((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR!sV       t IDeclarationcBsDeZdZdZdZdZdZdZdZRS(sInterface declaration Declarations are used to express the interfaces implemented by classes or provided by objects. cCsdS(sTest whether an interface is in the specification Return true if the given interface is one of the interfaces in the specification and false otherwise. N((R((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR.5scCsdS(sCReturn an iterator for the interfaces in the specification N((((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR/<scCsdS(sReturn an iterator of all included and extended interfaces An iterator is returned for all interfaces either included in or extended by interfaces included in the specifications without duplicates. The interfaces are in "interface resolution order". The interface resolution order is such that base interfaces are listed after interfaces that extend them and, otherwise, interfaces are included in the order that they were defined in the specification. N((((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt flattened@scCsdS(sCreate an interface specification with some interfaces excluded The argument can be an interface or an interface specifications. The interface or interfaces given in a specification are subtracted from the interface specification. Removing an interface that is not in the specification does not raise an error. Doing so has no effect. Removing an interface also removes sub-interfaces of the interface. N((t interfaces((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt__sub__LscCsdS(szCreate an interface specification with some interfaces added The argument can be an interface or an interface specifications. The interface or interfaces given in a specification are added to the interface specification. Adding an interface that is already in the specification does not raise an error. Doing so has no effect. N((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt__add__ZscCsdS(sHReturn a true value of the interface specification is non-empty N((((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt __nonzero__es( RR RR.R/R2R4R5R6(((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR1.s    tIInterfaceDeclarationcBseZdZdZdZdZdZdZdZdZ dZ d Z d Z d Z d Zd ZdZdZdZRS(sdDeclare and check the interfaces of objects The functions defined in this interface are used to declare the interfaces that objects provide and to query the interfaces that have been declared. Interfaces can be declared for objects in two ways: - Interfaces are declared for instances of the object's class - Interfaces are declared for the object directly. The interfaces declared for an object are, therefore, the union of interfaces declared for the object directly and the interfaces declared for instances of the object's class. Note that we say that a class implements the interfaces provided by it's instances. An instance can also provide interfaces directly. The interfaces provided by an object are the union of the interfaces provided directly and the interfaces implemented by the class. cCsdS(sReturn the interfaces provided by an object This is the union of the interfaces directly provided by an object and interfaces implemented by it's class. The value returned is an IDeclaration. N((tob((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR#scCsdS(sqReturn the interfaces implemented for a class' instances The value returned is an IDeclaration. N((R$((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR%scGsdS(sODeclare additional interfaces implemented for instances of a class The arguments after the class are one or more interfaces or interface specifications (IDeclaration objects). The interfaces given (including the interfaces in the specifications) are added to any interfaces previously declared. Consider the following example:: class C(A, B): ... classImplements(C, I1, I2) Instances of ``C`` provide ``I1``, ``I2``, and whatever interfaces instances of ``A`` and ``B`` provide. N((R$R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytclassImplementsscGsdS(sCreate a decorator for declaring interfaces implemented by a facory A callable is returned that makes an implements declaration on objects passed to it. N((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt implementerscGsdS(swDeclare the only interfaces implemented by instances of a class The arguments after the class are one or more interfaces or interface specifications (IDeclaration objects). The interfaces given (including the interfaces in the specifications) replace any previous declarations. Consider the following example:: class C(A, B): ... classImplements(C, IA, IB. IC) classImplementsOnly(C. I1, I2) Instances of ``C`` provide only ``I1``, ``I2``, and regardless of whatever interfaces instances of ``A`` and ``B`` implement. N((R$R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytclassImplementsOnlyscGsdS(sCreate a decorator for declaring the only interfaces implemented A callable is returned that makes an implements declaration on objects passed to it. N((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytimplementer_onlyscCsdS(stReturn the interfaces directly provided by the given object The value returned is an IDeclaration. N((R"((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytdirectlyProvidedByscGsdS(sDeclare interfaces declared directly for an object The arguments after the object are one or more interfaces or interface specifications (IDeclaration objects). The interfaces given (including the interfaces in the specifications) replace interfaces previously declared for the object. Consider the following example:: class C(A, B): ... ob = C() directlyProvides(ob, I1, I2) The object, ``ob`` provides ``I1``, ``I2``, and whatever interfaces instances have been declared for instances of ``C``. To remove directly provided interfaces, use ``directlyProvidedBy`` and subtract the unwanted interfaces. For example:: directlyProvides(ob, directlyProvidedBy(ob)-I2) removes I2 from the interfaces directly provided by ``ob``. The object, ``ob`` no longer directly provides ``I2``, although it might still provide ``I2`` if it's class implements ``I2``. To add directly provided interfaces, use ``directlyProvidedBy`` and include additional interfaces. For example:: directlyProvides(ob, directlyProvidedBy(ob), I2) adds I2 to the interfaces directly provided by ob. N((R"R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytdirectlyProvidesscGsdS(sDeclare additional interfaces directly for an object:: alsoProvides(ob, I1) is equivalent to:: directlyProvides(ob, directlyProvidedBy(ob), I1) N((R"R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt alsoProvidesscCsdS(s{Remove an interface from the list of an object's directly provided interfaces:: noLongerProvides(ob, I1) is equivalent to:: directlyProvides(ob, directlyProvidedBy(ob)-I1) with the exception that if ``I1`` is an interface that is provided by ``ob`` through the class's implementation, ValueError is raised. N((R"R((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytnoLongerProvidesscGsdS(sDeclare interfaces implemented by instances of a class This function is called in a class definition. The arguments are one or more interfaces or interface specifications (IDeclaration objects). The interfaces given (including the interfaces in the specifications) are added to any interfaces previously declared. Previous declarations include declarations for base classes unless implementsOnly was used. This function is provided for convenience. It provides a more convenient way to call classImplements. For example:: implements(I1) is equivalent to calling:: classImplements(C, I1) after the class has been created. Consider the following example:: class C(A, B): implements(I1, I2) Instances of ``C`` implement ``I1``, ``I2``, and whatever interfaces instances of ``A`` and ``B`` implement. N((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt implementsscGsdS(sGDeclare the only interfaces implemented by instances of a class This function is called in a class definition. The arguments are one or more interfaces or interface specifications (IDeclaration objects). Previous declarations including declarations for base classes are overridden. This function is provided for convenience. It provides a more convenient way to call classImplementsOnly. For example:: implementsOnly(I1) is equivalent to calling:: classImplementsOnly(I1) after the class has been created. Consider the following example:: class C(A, B): implementsOnly(I1, I2) Instances of ``C`` implement ``I1``, ``I2``, regardless of what instances of ``A`` and ``B`` implement. N((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytimplementsOnly3scGsdS(sDeclare interfaces provided directly by a class This function is called in a class definition. The arguments are one or more interfaces or interface specifications (IDeclaration objects). The given interfaces (including the interfaces in the specifications) are used to create the class's direct-object interface specification. An error will be raised if the module class has an direct interface specification. In other words, it is an error to call this function more than once in a class definition. Note that the given interfaces have nothing to do with the interfaces implemented by instances of the class. This function is provided for convenience. It provides a more convenient way to call directlyProvides for a class. For example:: classProvides(I1) is equivalent to calling:: directlyProvides(theclass, I1) after the class has been created. N((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt classProvidesSscGsdS(s*A class decorator version of classProvidesN((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytproviderpscGsdS(sEDeclare interfaces provided by a module This function is used in a module definition. The arguments are one or more interfaces or interface specifications (IDeclaration objects). The given interfaces (including the interfaces in the specifications) are used to create the module's direct-object interface specification. An error will be raised if the module already has an interface specification. In other words, it is an error to call this function more than once in a module definition. This function is provided for convenience. It provides a more convenient way to call directlyProvides for a module. For example:: moduleImplements(I1) is equivalent to:: directlyProvides(sys.modules[__name__], I1) N((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytmoduleProvidessscGsdS(sCreate an interface specification The arguments are one or more interfaces or interface specifications (IDeclaration objects). A new interface specification (IDeclaration) with the given interfaces is returned. N((R3((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt Declarations(RR RR#R%R9R:R;R<R=R>R?R@RARBRCRDRERF(((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR7is"       '  $   tIAdapterRegistrycBseZdZdZddZdddZdddZdddZdddZ ddd Z d Z d Z dd Z dd ZddZRS(sProvide an interface-based registry for adapters This registry registers objects that are in some sense "from" a sequence of specification to an interface and a name. No specific semantics are assumed for the registered objects, however, the most common application will be to register factories that adapt objects providing required specifications to a provided interface. cCsdS(sRegister a value A value is registered for a *sequence* of required specifications, a provided interface, and a name. N((trequiredtprovidedRR ((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytregistersucCsdS(snReturn the component registered for the given interfaces and name Unlike the lookup method, this methods won't retrieve components registered for more specific required interfaces or less specific provided interfaces. If no component was registered exactly for the given interfaces and name, then None is returned. N((RHRIR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt registeredstcCsdS(sLookup a value A value is looked up based on a *sequence* of required specifications, a provided interface, and a name. N((RHRIRR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytlookupscCsdS(sDAdapt a sequence of objects to a named, provided, interface N((tobjectsRIRR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytqueryMultiAdapterscCsdS(sLookup a value using a single required interface A value is looked up based on a single required specifications, a provided interface, and a name. N((RHRIRR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pytlookup1scCsdS(s<Adapt an object using a registered adapter factory. N((R"RIRR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt queryAdapterscCsdS(s<Adapt an object using a registered adapter factory. N((RIR"RR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt adapter_hookscCsdS(sFind all adapters from the required to the provided interfaces An iterable object is returned that provides name-value two-tuples. N((RHRI((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt lookupAllscCsdS(s@Return the names for which there are registered objects N((RHRI((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyR'scCsdS(sRegister a subscriber A subscriber is registered for a *sequence* of required specifications, a provided interface, and a name. Multiple subscribers may be registered for the same (or equivalent) interfaces. N((RHRIt subscriberR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt subscribescCsdS(sGet a sequence of subscribers Subscribers for a *sequence* of required interfaces, and a provided interface are returned. N((RHRIR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt subscriptionsscCsdS(s0Get a sequence of subscription adapters N((RNRIR((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyt subscriberssN(RR RRJRKRRMRORPRQRRRSR'RURVRW(((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyRGs      N(Rt __docformat__tzope.interfaceRtzope.interface.interfaceRRRRRR!R1R7RG(((s=/usr/lib/python2.7/dist-packages/zope/interface/interfaces.pyts:;.