diff options
| author | Bert JW Regeer <bertjw@regeer.org> | 2018-10-14 17:23:17 -0600 |
|---|---|---|
| committer | Bert JW Regeer <bertjw@regeer.org> | 2018-10-14 17:23:17 -0600 |
| commit | a7e16c231c05ca8bea3271632a347e7eac96cb9d (patch) | |
| tree | 203910773fa33ddc83aee05c6b20d0ddf6168a57 | |
| parent | 05915720f97df868e0b7dcff6e9b8eed964b8a90 (diff) | |
| download | pyramid-a7e16c231c05ca8bea3271632a347e7eac96cb9d.tar.gz pyramid-a7e16c231c05ca8bea3271632a347e7eac96cb9d.tar.bz2 pyramid-a7e16c231c05ca8bea3271632a347e7eac96cb9d.zip | |
Update documentation for implementing custom authz policy
| -rw-r--r-- | docs/narr/security.rst | 12 |
1 files changed, 7 insertions, 5 deletions
diff --git a/docs/narr/security.rst b/docs/narr/security.rst index 5bccd6d52..6b6f9a1f1 100644 --- a/docs/narr/security.rst +++ b/docs/narr/security.rst @@ -714,14 +714,16 @@ object that implements the following interface: .. code-block:: python :linenos: - class IAuthorizationPolicy(object): + class IAuthorizationPolicy(Interface): """ An object representing a Pyramid authorization policy. """ - def permits(self, context, principals, permission): - """ Return ``True`` if any of the ``principals`` is allowed the - ``permission`` in the current ``context``, else return ``False`` + def permits(context, principals, permission): + """ Return an instance of :class:`pyramid.security.Allowed` if any + of the ``principals`` is allowed the ``permission`` in the current + ``context``, else return an instance of + :class:`pyramid.security.Denied`. """ - def principals_allowed_by_permission(self, context, permission): + def principals_allowed_by_permission(context, permission): """ Return a set of principal identifiers allowed by the ``permission`` in ``context``. This behavior is optional; if you choose to not implement it you should define this method as |
