Michael Merickel
2018-10-04 c314e31223307d7fd739e0bc41519ae6d1d323d3
pyramid/security.py
@@ -17,8 +17,6 @@
Allow = 'Allow'
Deny = 'Deny'
_marker = object()
class AllPermissionsList(object):
    """ Stand in 'permission list' to represent all permissions """
@@ -120,7 +118,7 @@
    '"effective_principals" attribute of the Pyramid request instead.'
    )
def remember(request, userid=_marker, **kw):
def remember(request, userid, **kw):
    """
    Returns a sequence of header tuples (e.g. ``[('Set-Cookie', 'foo=abc')]``)
    on this request's response.
@@ -143,24 +141,14 @@
    always return an empty sequence. If used, the composition and
    meaning of ``**kw`` must be agreed upon by the calling code and
    the effective authentication policy.
    .. deprecated:: 1.6
        Renamed the ``principal`` argument to ``userid`` to clarify its
        purpose.
    .. versionchanged:: 1.6
        Deprecated the ``principal`` argument in favor of ``userid`` to clarify
        its relationship to the authentication policy.
    .. versionchanged:: 1.10
        Removed the deprecated ``principal`` argument.
    """
    if userid is _marker:
        principal = kw.pop('principal', _marker)
        if principal is _marker:
            raise TypeError(
                'remember() missing 1 required positional argument: '
                '\'userid\'')
        else:
            deprecated(
                'principal',
                'The "principal" argument was deprecated in Pyramid 1.6. '
                'It will be removed in Pyramid 1.9. Use the "userid" '
                'argument instead.')
            userid = principal
    policy = _get_authentication_policy(request)
    if policy is None:
        return []