[Checkins] SVN: zope.security/trunk/ Convert module checker doctests to Sphinx.
Tres Seaver
cvs-admin at zope.org
Sun Dec 23 20:54:16 UTC 2012
Log message for revision 128885:
Convert module checker doctests to Sphinx.
Changed:
_U zope.security/trunk/
U zope.security/trunk/docs/api/checker.rst
U zope.security/trunk/src/zope/security/tests/test_module_directives.py
-=-
Modified: zope.security/trunk/docs/api/checker.rst
===================================================================
--- zope.security/trunk/docs/api/checker.rst 2012-12-23 20:54:15 UTC (rev 128884)
+++ zope.security/trunk/docs/api/checker.rst 2012-12-23 20:54:15 UTC (rev 128885)
@@ -5,6 +5,172 @@
:members:
:member-order: bysource
+
+Protections for Modules
+-----------------------
+
+The :func:`zope.secuirty.checker.moduleChecker` API can be used to
+determine whether a module has been protected: Initially, there's no checker
+defined for the module:
+
+.. doctest::
+
+ >>> from zope.security.checker import moduleChecker
+ >>> from zope.security.tests import test_directives
+ >>> moduleChecker(test_directives) is None
+ True
+
+We can add a checker using :func:`zope.security.metaconfigure.protectModule`:
+
+.. doctest::
+
+ >>> from zope.component import provideUtility
+ >>> from zope.security.metaconfigure import protectModule
+ >>> from zope.security.permission import Permission
+ >>> from zope.security.interfaces import IPermission
+ >>> TEST_PERM = 'zope.security.metaconfigure.test'
+ >>> perm = Permission(TEST_PERM, '')
+ >>> provideUtility(perm, IPermission, TEST_PERM)
+ >>> protectModule(test_directives, 'foo', TEST_PERM)
+
+Now, the checker should exist and have an access dictionary with the
+name and permission:
+
+.. doctest::
+
+ >>> def pprint(ob, width=70):
+ ... from pprint import PrettyPrinter
+ ... PrettyPrinter(width=width).pprint(ob)
+ >>> checker = moduleChecker(test_directives)
+ >>> cdict = checker.get_permissions
+ >>> pprint(cdict)
+ {'foo': 'zope.security.metaconfigure.test'}
+
+ If we define additional names, they will be added to the dict:
+
+ >>> protectModule(test_directives, 'bar', TEST_PERM)
+ >>> protectModule(test_directives, 'baz', TEST_PERM)
+ >>> pprint(cdict)
+ {'bar': 'zope.security.metaconfigure.test',
+ 'baz': 'zope.security.metaconfigure.test',
+ 'foo': 'zope.security.metaconfigure.test'}
+
+The allow directive creates actions for each named defined
+directly, or via interface:
+
+.. doctest::
+
+ >>> from zope.interface import Interface
+ >>> from zope.interface import Attribute
+ >>> from zope.security.metaconfigure import allow
+ >>> class I1(Interface):
+ ... def x(): pass
+ ... y = Attribute("Y")
+ >>> class I2(I1):
+ ... def a(): pass
+ ... b = Attribute("B")
+ >>> class AContext(object):
+ ... def __init__(self):
+ ... self.actions = []
+ ...
+ ... def action(self, discriminator, callable, args):
+ ... self.actions.append(
+ ... {'discriminator': discriminator,
+ ... 'callable': int(callable is protectModule),
+ ... 'args': args})
+ ... module='testmodule'
+
+ >>> context = AContext()
+ >>> allow(context, attributes=['foo', 'bar'], interface=[I1, I2])
+ >>> context.actions.sort(
+ ... lambda a, b: cmp(a['discriminator'], b['discriminator']))
+ >>> pprint(context.actions)
+ [{'args': ('testmodule', 'a', 'zope.Public'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'a')},
+ {'args': ('testmodule', 'b', 'zope.Public'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'b')},
+ {'args': ('testmodule', 'bar', 'zope.Public'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'bar')},
+ {'args': ('testmodule', 'foo', 'zope.Public'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'foo')},
+ {'args': ('testmodule', 'x', 'zope.Public'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'x')},
+ {'args': ('testmodule', 'y', 'zope.Public'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'y')}]
+
+The provide directive creates actions for each named defined
+directly, or via interface:
+
+.. doctest::
+
+ >>> from zope.security.metaconfigure import require
+ >>> class RContext(object):
+ ... def __init__(self):
+ ... self.actions = []
+ ... def action(self, discriminator, callable, args):
+ ... self.actions.append(
+ ... {'discriminator': discriminator,
+ ... 'callable': int(callable is protectModule),
+ ... 'args': args})
+ ... module='testmodule'
+
+ >>> context = RContext()
+ >>> require(context, attributes=['foo', 'bar'],
+ ... interface=[I1, I2], permission='p')
+
+ >>> context.actions.sort(
+ ... lambda a, b: cmp(a['discriminator'], b['discriminator']))
+ >>> pprint(context.actions)
+ [{'args': ('testmodule', 'a', 'p'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'a')},
+ {'args': ('testmodule', 'b', 'p'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'b')},
+ {'args': ('testmodule', 'bar', 'p'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'bar')},
+ {'args': ('testmodule', 'foo', 'p'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'foo')},
+ {'args': ('testmodule', 'x', 'p'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'x')},
+ {'args': ('testmodule', 'y', 'p'),
+ 'callable': 1,
+ 'discriminator': ('http://namespaces.zope.org/zope:module',
+ 'testmodule',
+ 'y')}]
+
+
Protections for set objects
---------------------------
Modified: zope.security/trunk/src/zope/security/tests/test_module_directives.py
===================================================================
--- zope.security/trunk/src/zope/security/tests/test_module_directives.py 2012-12-23 20:54:15 UTC (rev 128884)
+++ zope.security/trunk/src/zope/security/tests/test_module_directives.py 2012-12-23 20:54:15 UTC (rev 128885)
@@ -16,188 +16,6 @@
import unittest
-def pprint(ob, width=70):
- from pprint import PrettyPrinter
- PrettyPrinter(width=width).pprint(ob)
-
-TEST_PERM = 'zope.security.metaconfigure.test'
-TEST_BAD_PERM = 'zope.security.metaconfigure.bad'
-
-def test_protectModule():
- """
- >>> from zope.security import metaconfigure
-
- >>> from zope.security.tests import test_directives
- >>> from zope.security.interfaces import IPermission
- >>> from zope.security.permission import Permission
-
- >>> from zope.component import provideUtility
-
- Initially, there's no checker defined for the module:
-
- >>> from zope.security.checker import moduleChecker
- >>> moduleChecker(test_directives)
-
- >>> perm = Permission(TEST_PERM, '')
- >>> provideUtility(perm, IPermission, TEST_PERM)
- >>> metaconfigure.protectModule(test_directives, 'foo', TEST_PERM)
-
- Now, the checker should exist and have an access dictionary with the
- name and permission:
-
- >>> checker = moduleChecker(test_directives)
- >>> cdict = checker.get_permissions
- >>> pprint(cdict)
- {'foo': 'zope.security.metaconfigure.test'}
-
- If we define additional names, they will be added to the dict:
-
- >>> metaconfigure.protectModule(test_directives, 'bar', TEST_PERM)
- >>> metaconfigure.protectModule(test_directives, 'baz', TEST_PERM)
- >>> pprint(cdict)
- {'bar': 'zope.security.metaconfigure.test',
- 'baz': 'zope.security.metaconfigure.test',
- 'foo': 'zope.security.metaconfigure.test'}
-
- """
-
-def test_allow():
- """
-
- The allow directive creates actions for each named defined
- directly, or via interface:
-
- >>> from zope.interface import Interface
- >>> from zope.interface import Attribute
- >>> from zope.security import metaconfigure
-
- >>> class I1(Interface):
- ... def x(): pass
- ... y = Attribute("Y")
- >>> class I2(I1):
- ... def a(): pass
- ... b = Attribute("B")
- >>> class Context(object):
- ... def __init__(self):
- ... self.actions = []
- ...
- ... def action(self, discriminator, callable, args):
- ... self.actions.append(
- ... {'discriminator': discriminator,
- ... 'callable': int(callable is metaconfigure.protectModule),
- ... 'args': args})
- ...
- ... module='testmodule'
-
- >>> context = Context()
- >>> metaconfigure.allow(context, attributes=['foo', 'bar'],
- ... interface=[I1, I2])
-
- >>> context.actions.sort(
- ... lambda a, b: cmp(a['discriminator'], b['discriminator']))
- >>> pprint(context.actions)
- [{'args': ('testmodule', 'a', 'zope.Public'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'a')},
- {'args': ('testmodule', 'b', 'zope.Public'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'b')},
- {'args': ('testmodule', 'bar', 'zope.Public'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'bar')},
- {'args': ('testmodule', 'foo', 'zope.Public'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'foo')},
- {'args': ('testmodule', 'x', 'zope.Public'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'x')},
- {'args': ('testmodule', 'y', 'zope.Public'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'y')}]
-
- """
-
-def test_require():
- """
-
- The allow directive creates actions for each named defined
- directly, or via interface:
-
- >>> from zope.interface import Interface
- >>> from zope.interface import Attribute
- >>> from zope.security import metaconfigure
-
- >>> class I1(Interface):
- ... def x(): pass
- ... y = Attribute("Y")
- >>> class I2(I1):
- ... def a(): pass
- ... b = Attribute("B")
- >>> class Context(object):
- ... def __init__(self):
- ... self.actions = []
- ...
- ... def action(self, discriminator, callable, args):
- ... self.actions.append(
- ... {'discriminator': discriminator,
- ... 'callable': int(callable is metaconfigure.protectModule),
- ... 'args': args})
- ...
- ... module='testmodule'
-
- >>> context = Context()
- >>> metaconfigure.require(context, attributes=['foo', 'bar'],
- ... interface=[I1, I2], permission='p')
-
- >>> context.actions.sort(
- ... lambda a, b: cmp(a['discriminator'], b['discriminator']))
- >>> pprint(context.actions)
- [{'args': ('testmodule', 'a', 'p'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'a')},
- {'args': ('testmodule', 'b', 'p'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'b')},
- {'args': ('testmodule', 'bar', 'p'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'bar')},
- {'args': ('testmodule', 'foo', 'p'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'foo')},
- {'args': ('testmodule', 'x', 'p'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'x')},
- {'args': ('testmodule', 'y', 'p'),
- 'callable': 1,
- 'discriminator': ('http://namespaces.zope.org/zope:module',
- 'testmodule',
- 'y')}]
-
- """
-
-
def _skip_wo_zope_configuration(testfunc):
try:
import zope.configuration.xmlconfig
@@ -255,12 +73,6 @@
self.assertEqual(perms, ['zope.Security'])
def test_suite():
- import doctest
- from zope.component.testing import tearDown
- from zope.component.testing import setUp
-
return unittest.TestSuite((
- doctest.DocTestSuite(setUp=setUp, tearDown=tearDown),
- doctest.DocTestSuite('zope.security.zcml'),
unittest.makeSuite(DirectivesTest),
))
More information about the checkins
mailing list