[Checkins] SVN: zope.security/trunk/ Convert doctests in 'zope.security.proxy' into Sphinx doctest snppets.

[Tres Seaver]

Log message for revision 128875:
  Convert doctests in 'zope.security.proxy' into Sphinx doctest snppets.
  
  They are still tested under 'tox -e docs'.

Changed:
  _U  zope.security/trunk/
  A   zope.security/trunk/docs/api/proxy.rst
  U   zope.security/trunk/docs/index.rst
  U   zope.security/trunk/src/zope/security/proxy.py
  U   zope.security/trunk/src/zope/security/tests/test_proxy.py

-=-
Added: zope.security/trunk/docs/api/proxy.rst
===================================================================
--- zope.security/trunk/docs/api/proxy.rst	                        (rev 0)
+++ zope.security/trunk/docs/api/proxy.rst	2012-12-23 20:54:09 UTC (rev 128875)
@@ -0,0 +1,43 @@
+:mod:`zope.security.proxy`
+===============================
+
+.. testsetup::
+
+   from zope.component.testing import setUp
+   setUp()
+
+.. autofunction:: zope.security.proxy.getTestProxyItems
+
+.. autofunction:: zope.security.proxy.isinstance
+
+.. doctest::
+
+   >>> from zope.security.proxy import isinstance
+   >>> class C1(object):
+   ...     pass
+
+   >>> c = C1()
+   >>> isinstance(c, C1)
+   True
+
+   >>> from zope.security.checker import ProxyFactory
+   >>> isinstance(ProxyFactory(c), C1)
+   True
+
+   >>> class C2(C1):
+   ...     pass
+
+   >>> c = C2()
+   >>> isinstance(c, C1)
+   True
+
+   >>> from zope.security.checker import ProxyFactory
+   >>> isinstance(ProxyFactory(c), C1)
+   True
+
+
+
+.. testcleanup::
+
+   from zope.component.testing import tearDown
+   tearDown()

Modified: zope.security/trunk/docs/index.rst
===================================================================
--- zope.security/trunk/docs/index.rst	2012-12-23 20:54:08 UTC (rev 128874)
+++ zope.security/trunk/docs/index.rst	2012-12-23 20:54:09 UTC (rev 128875)
@@ -14,6 +14,7 @@
    api/management
    api/permission
    api/protectclass
+   api/proxy
 
 
 

Modified: zope.security/trunk/src/zope/security/proxy.py
===================================================================
--- zope.security/trunk/src/zope/security/proxy.py	2012-12-23 20:54:08 UTC (rev 128874)
+++ zope.security/trunk/src/zope/security/proxy.py	2012-12-23 20:54:09 UTC (rev 128875)
@@ -15,7 +15,8 @@
 """
 __docformat__ = 'restructuredtext'
 
-from zope.security._proxy import getChecker, getObject
+from zope.security._proxy import getChecker
+from zope.security._proxy import getObject
 from zope.security._proxy import _Proxy as Proxy
 
 # We need the injection of DecoratedSecurityCheckerDescriptor into
@@ -46,32 +47,7 @@
     """Test whether an object is an instance of a type.
 
     This works even if the object is security proxied:
-
-      >>> class C1(object):
-      ...     pass
-
-      >>> c = C1()
-      >>> isinstance(c, C1)
-      True
-
-      >>> from zope.security.checker import ProxyFactory
-      >>> isinstance(ProxyFactory(c), C1)
-      True
-
-      >>> class C2(C1):
-      ...     pass
-
-      >>> c = C2()
-      >>> isinstance(c, C1)
-      True
-
-      >>> from zope.security.checker import ProxyFactory
-      >>> isinstance(ProxyFactory(c), C1)
-      True
-
     """
-
     # The removeSecurityProxy call is OK here because it is *only*
     # being used for isinstance
-
     return builtin_isinstance(removeSecurityProxy(object), cls)

Modified: zope.security/trunk/src/zope/security/tests/test_proxy.py
===================================================================
--- zope.security/trunk/src/zope/security/tests/test_proxy.py	2012-12-23 20:54:08 UTC (rev 128874)
+++ zope.security/trunk/src/zope/security/tests/test_proxy.py	2012-12-23 20:54:09 UTC (rev 128875)
@@ -472,9 +472,7 @@
 
 
 def test_suite():
-    from doctest import DocTestSuite
     return unittest.TestSuite((
-        DocTestSuite('zope.security.proxy'),
         unittest.makeSuite(ProxyTests),
         unittest.makeSuite(TestLocationProxySecurityChecker),
     ))