summaryrefslogtreecommitdiff
path: root/src
diff options
context:
space:
mode:
authorTheron Luhn <theron@luhn.com>2019-05-12 12:13:26 -0700
committerTheron Luhn <theron@luhn.com>2019-05-12 12:13:26 -0700
commit4c95ccd5e9b9657165f6ba061ee795fc4a5fcd30 (patch)
treea2cce5a912876f3f911e21e601896c1f21fdcb98 /src
parent08d5eddb2932a894fac03917508da95f480bfe7d (diff)
downloadpyramid-4c95ccd5e9b9657165f6ba061ee795fc4a5fcd30.tar.gz
pyramid-4c95ccd5e9b9657165f6ba061ee795fc4a5fcd30.tar.bz2
pyramid-4c95ccd5e9b9657165f6ba061ee795fc4a5fcd30.zip
Narrative docs WIP
Diffstat (limited to 'src')
-rw-r--r--src/pyramid/interfaces.py7
1 files changed, 6 insertions, 1 deletions
diff --git a/src/pyramid/interfaces.py b/src/pyramid/interfaces.py
index 9dabb9cfc..bc52e324e 100644
--- a/src/pyramid/interfaces.py
+++ b/src/pyramid/interfaces.py
@@ -484,13 +484,18 @@ class IViewMapperFactory(Interface):
class ISecurityPolicy(Interface):
def identify(request):
- """ Return an object identifying a trusted and verified user. """
+ """ Return an object identifying a trusted and verified user. This
+ object may be anything, but should implement a ``__str__`` method for
+ logging and debugging purposes.
+
+ """
def permits(request, context, identity, permission):
""" Return an instance of :class:`pyramid.security.Allowed` if a user
of the given identity is allowed the ``permission`` in the current
``context``, else return an instance of
:class:`pyramid.security.Denied`.
+
"""
def remember(request, userid, **kw):