summaryrefslogtreecommitdiff
path: root/src/zope
diff options
context:
space:
mode:
authorTres Seaver <tseaver@palladion.com>2012-12-23 20:54:02 +0000
committerTres Seaver <tseaver@palladion.com>2012-12-23 20:54:02 +0000
commita511f6627df22d9a15788b846f3d6f3ba81ccbdb (patch)
tree8d5cda3977e1c6e69b7ada24e6d514a07edbfde9 /src/zope
parent9f1faae693fc91ca97f2b3caf4e48fd3e62e2635 (diff)
downloadzope-security-a511f6627df22d9a15788b846f3d6f3ba81ccbdb.tar.gz
Convert doctests in 'zope.security.permission' into Sphinx doctest snppets.
They are still tested under 'tox -e docs'.
Diffstat (limited to 'src/zope')
-rw-r--r--src/zope/security/permission.py110
-rw-r--r--src/zope/security/tests/test_permission.py4
2 files changed, 0 insertions, 114 deletions
diff --git a/src/zope/security/permission.py b/src/zope/security/permission.py
index 46ba194..c8bf50e 100644
--- a/src/zope/security/permission.py
+++ b/src/zope/security/permission.py
@@ -32,23 +32,6 @@ class Permission(object):
def checkPermission(context, permission_id):
"""Check whether a given permission exists in the provided context.
-
- >>> from zope.component.testing import setUp, tearDown
- >>> setUp()
- >>> from zope.component import provideUtility
- >>> provideUtility(Permission('x'), IPermission, 'x')
-
- >>> checkPermission(None, 'x')
- >>> checkPermission(None, 'y')
- Traceback (most recent call last):
- ...
- ValueError: ('Undefined permission id', 'y')
-
- The CheckerPublic always exists:
-
- >>> checkPermission(None, CheckerPublic)
- >>> tearDown()
-
"""
if permission_id is CheckerPublic:
return
@@ -57,18 +40,6 @@ def checkPermission(context, permission_id):
def allPermissions(context=None):
"""Get the ids of all defined permissions
-
- >>> from zope.component.testing import setUp, tearDown
- >>> setUp()
- >>> from zope.component import provideUtility
- >>> provideUtility(Permission('x'), IPermission, 'x')
- >>> provideUtility(Permission('y'), IPermission, 'y')
-
- >>> ids = list(allPermissions(None))
- >>> ids.sort()
- >>> ids
- [u'x', u'y']
- >>> tearDown()
"""
for id, permission in getUtilitiesFor(IPermission, context):
if id != u'zope.Public':
@@ -78,37 +49,6 @@ def PermissionsVocabulary(context=None):
"""A vocabulary of permission IDs.
Term values are permissions, while term tokens are permission IDs.
-
- To illustrate, we need to register the permission IDs vocabulary:
-
- >>> from zope.component.testing import setUp, tearDown
- >>> setUp()
- >>> from zope.schema.vocabulary import _clear
- >>> _clear()
-
- >>> from zope.schema.vocabulary import getVocabularyRegistry
- >>> registry = getVocabularyRegistry()
- >>> registry.register('Permissions', PermissionsVocabulary)
-
- We also need to register some sample permission utilities:
-
- >>> from zope.security.interfaces import IPermission
- >>> from zope.security.permission import Permission
- >>> from zope.component import provideUtility
- >>> a = Permission('a')
- >>> b = Permission('b')
- >>> provideUtility(a, IPermission, 'a')
- >>> provideUtility(b, IPermission, 'b')
-
- We can now lookup these permissions using the vocabulary:
-
- >>> vocab = registry.get(None, 'Permissions')
- >>> vocab.getTermByToken('a').value is a
- True
- >>> vocab.getTermByToken('b').value is b
- True
- >>> tearDown()
-
"""
terms = []
for id, permission in getUtilitiesFor(IPermission, context):
@@ -128,57 +68,7 @@ def PermissionIdsVocabulary(context=None):
Terms are sorted by title except for 'Public', which always appears as
the first term.
-
- To illustrate, we need to register the permission IDs vocabulary:
-
- >>> from zope.component.testing import setUp, tearDown
- >>> setUp()
- >>> from zope.schema.vocabulary import _clear
- >>> _clear()
-
- >>> from zope.schema.vocabulary import getVocabularyRegistry
- >>> registry = getVocabularyRegistry()
- >>> registry.register('Permission Ids', PermissionIdsVocabulary)
-
- We also need to register some sample permission utilities, including
- the special permission 'zope.Public':
-
- >>> from zope.security.interfaces import IPermission
- >>> from zope.security.permission import Permission
- >>> from zope.component import provideUtility
- >>> provideUtility(Permission('zope.Public'), IPermission, 'zope.Public')
- >>> provideUtility(Permission('b'), IPermission, 'b')
- >>> provideUtility(Permission('a'), IPermission, 'a')
-
- We can now lookup these permissions using the vocabulary:
-
- >>> vocab = registry.get(None, 'Permission Ids')
-
- The non-public permissions 'a' and 'b' are string values:
-
- >>> vocab.getTermByToken('a').value
- u'a'
- >>> vocab.getTermByToken('b').value
- u'b'
-
- However, the public permission value is CheckerPublic:
-
- >>> vocab.getTermByToken('zope.Public').value is CheckerPublic
- True
-
- and its title is shortened:
-
- >>> vocab.getTermByToken('zope.Public').title
- u'Public'
-
- The terms are sorted by title except for the public permission, which is
- listed first:
-
- >>> [term.title for term in vocab]
- [u'Public', u'a', u'b']
- >>> tearDown()
"""
-
terms = []
for name, permission in getUtilitiesFor(IPermission, context):
if name == 'zope.Public':
diff --git a/src/zope/security/tests/test_permission.py b/src/zope/security/tests/test_permission.py
index 8bff83b..ab30591 100644
--- a/src/zope/security/tests/test_permission.py
+++ b/src/zope/security/tests/test_permission.py
@@ -17,9 +17,5 @@ import unittest
def test_suite():
- from zope.component.testing import setUp, tearDown
- from doctest import DocTestSuite
return unittest.TestSuite([
- DocTestSuite('zope.security.permission',
- setUp=setUp, tearDown=tearDown),
])