summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
Diffstat (limited to 'docs')
-rw-r--r--docs/README.rst12
-rw-r--r--docs/api/declarations.rst2
-rw-r--r--docs/verify.rst28
3 files changed, 21 insertions, 21 deletions
diff --git a/docs/README.rst b/docs/README.rst
index 3daf865..b8eef13 100644
--- a/docs/README.rst
+++ b/docs/README.rst
@@ -677,7 +677,7 @@ interfaces that they declare:
>>> baz_implements = zope.interface.implementedBy(Baz)
>>> baz_implements.__bases__
- (<InterfaceClass builtins.IBaz>, <implementedBy ...object>)
+ (<InterfaceClass builtins.IBaz>, classImplements(object))
>>> baz_implements.extends(IFoo)
True
@@ -694,11 +694,11 @@ that lists the specification and all of it's ancestors:
>>> from pprint import pprint
>>> pprint(baz_implements.__sro__)
- (<implementedBy builtins.Baz>,
+ (classImplements(Baz, IBaz),
<InterfaceClass builtins.IBaz>,
<InterfaceClass builtins.IFoo>,
<InterfaceClass builtins.IBlat>,
- <implementedBy ...object>,
+ classImplements(object),
<InterfaceClass zope.interface.Interface>)
>>> class IBiz(zope.interface.Interface):
... pass
@@ -706,13 +706,13 @@ that lists the specification and all of it's ancestors:
... class Biz(Baz):
... pass
>>> pprint(zope.interface.implementedBy(Biz).__sro__)
- (<implementedBy builtins.Biz>,
+ (classImplements(Biz, IBiz),
<InterfaceClass builtins.IBiz>,
- <implementedBy builtins.Baz>,
+ classImplements(Baz, IBaz),
<InterfaceClass builtins.IBaz>,
<InterfaceClass builtins.IFoo>,
<InterfaceClass builtins.IBlat>,
- <implementedBy ...object>,
+ classImplements(object),
<InterfaceClass zope.interface.Interface>)
Tagged Values
diff --git a/docs/api/declarations.rst b/docs/api/declarations.rst
index 05d39eb..cdbf815 100644
--- a/docs/api/declarations.rst
+++ b/docs/api/declarations.rst
@@ -624,7 +624,7 @@ an instance:
... def __call__(self):
... return self
>>> implementedBy(Callable())
- <implementedBy builtins.?>
+ classImplements(builtins.?)
Note that the name of the spec ends with a '?', because the ``Callable``
instance does not have a ``__name__`` attribute.
diff --git a/docs/verify.rst b/docs/verify.rst
index bf602d0..6a313cd 100644
--- a/docs/verify.rst
+++ b/docs/verify.rst
@@ -49,7 +49,7 @@ defined.
.. doctest::
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>:
+ The object <Foo...> has failed to implement interface ...IFoo:
Does not declaratively implement the interface
The base.IBase.x attribute was not provided
The module.IFoo.y attribute was not provided
@@ -61,7 +61,7 @@ declaring the correct interface.
>>> Foo.x = Foo.y = 42
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: Does not declaratively implement the interface.
+ The object <Foo...> has failed to implement interface ...IFoo: Does not declaratively implement the interface.
If we want to only check the structure of the object, without examining
its declarations, we can use the ``tentative`` argument.
@@ -119,13 +119,13 @@ exception.
... class Foo(object):
... x = 1
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The module.IFoo.y attribute was not provided.
+ The object <Foo...> has failed to implement interface ...IFoo: The module.IFoo.y attribute was not provided.
>>> @implementer(IFoo)
... class Foo(object):
... def __init__(self):
... self.y = 2
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The base.IBase.x attribute was not provided.
+ The object <Foo...> has failed to implement interface ...IFoo: The base.IBase.x attribute was not provided.
If both attributes are missing, an exception is raised reporting
both errors.
@@ -136,7 +136,7 @@ both errors.
... class Foo(object):
... pass
>>> verify_foo()
- The object <Foo ...> has failed to implement interface <...IFoo>:
+ The object <Foo ...> has failed to implement interface ...IFoo:
The base.IBase.x attribute was not provided
The module.IFoo.y attribute was not provided
@@ -155,7 +155,7 @@ when trying to get its value, the attribute is considered missing:
... def x(self):
... raise AttributeError
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The module.IFoo.x attribute was not provided.
+ The object <Foo...> has failed to implement interface ...IFoo: The module.IFoo.x attribute was not provided.
Any other exception raised by a property will propagate to the caller of
@@ -203,7 +203,7 @@ that takes one argument. If we don't provide it, we get an error.
... class Foo(object):
... pass
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The module.IFoo.simple(arg1) attribute was not provided.
+ The object <Foo...> has failed to implement interface ...IFoo: The module.IFoo.simple(arg1) attribute was not provided.
Once they exist, they are checked to be callable, and for compatible signatures.
@@ -213,7 +213,7 @@ Not being callable is an error.
>>> Foo.simple = 42
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The contract of module.IFoo.simple(arg1) is violated because '42' is not a method.
+ The object <Foo...> has failed to implement interface ...IFoo: The contract of module.IFoo.simple(arg1) is violated because '42' is not a method.
Taking too few arguments is an error. (Recall that the ``self``
argument is implicit.)
@@ -222,7 +222,7 @@ argument is implicit.)
>>> Foo.simple = lambda self: "I take no arguments"
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The contract of module.IFoo.simple(arg1) is violated because '<lambda>()' doesn't allow enough arguments.
+ The object <Foo...> has failed to implement interface ...IFoo: The contract of module.IFoo.simple(arg1) is violated because '<lambda>()' doesn't allow enough arguments.
Requiring too many arguments is an error.
@@ -230,7 +230,7 @@ Requiring too many arguments is an error.
>>> Foo.simple = lambda self, a, b: "I require two arguments"
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The contract of module.IFoo.simple(arg1) is violated because '<lambda>(a, b)' requires too many arguments.
+ The object <Foo...> has failed to implement interface ...IFoo: The contract of module.IFoo.simple(arg1) is violated because '<lambda>(a, b)' requires too many arguments.
Variable arguments can be used to implement the required number, as
can arguments with defaults.
@@ -257,7 +257,7 @@ variable keyword arguments, the implementation must also accept them.
... class Foo(object):
... def needs_kwargs(self, a=1, b=2): pass
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The contract of module.IFoo.needs_kwargs(**kwargs) is violated because 'Foo.needs_kwargs(a=1, b=2)' doesn't support keyword arguments.
+ The object <Foo...> has failed to implement interface ...IFoo: The contract of module.IFoo.needs_kwargs(**kwargs) is violated because 'Foo.needs_kwargs(a=1, b=2)' doesn't support keyword arguments.
>>> oname, __name__ = __name__, 'module'
>>> class IFoo(Interface):
@@ -267,7 +267,7 @@ variable keyword arguments, the implementation must also accept them.
... class Foo(object):
... def needs_varargs(self, **kwargs): pass
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>: The contract of module.IFoo.needs_varargs(*args) is violated because 'Foo.needs_varargs(**kwargs)' doesn't support variable arguments.
+ The object <Foo...> has failed to implement interface ...IFoo: The contract of module.IFoo.needs_varargs(*args) is violated because 'Foo.needs_varargs(**kwargs)' doesn't support variable arguments.
Of course, missing attributes are also found and reported, and the
source interface of the missing attribute is included. Similarly, when
@@ -288,7 +288,7 @@ the failing method is from a parent class, that is also reported.
... class Foo(Base):
... pass
>>> verify_foo()
- The object <Foo...> has failed to implement interface <...IFoo>:
+ The object <Foo...> has failed to implement interface ...IFoo:
The contract of base.IBase.method(arg1) is violated because 'Base.method()' doesn't allow enough arguments
The module.IFoo.x attribute was not provided
@@ -313,4 +313,4 @@ attributes, cannot be verified.
... print(e)
>>> verify_foo_class()
- The object <class 'Foo'> has failed to implement interface <...IFoo>: The contract of base.IBase.method(arg1) is violated because 'Base.method(self)' doesn't allow enough arguments.
+ The object <class 'Foo'> has failed to implement interface ...IFoo: The contract of base.IBase.method(arg1) is violated because 'Base.method(self)' doesn't allow enough arguments.