Permalink
Browse files

remove deprecated principal keyword argument to remember

  • Loading branch information...
mmerickel committed Oct 4, 2018
1 parent 1f307db commit 781371a7902154a64faa51e37a371242dfde1e29
Showing with 16 additions and 34 deletions.
  1. +8 −1 CHANGES.rst
  2. +0 −6 TODO.txt
  3. +8 −20 pyramid/security.py
  4. +0 −7 pyramid/tests/test_security.py
View
@@ -132,9 +132,16 @@ Backward Incompatibilities
See https://github.com/Pylons/pyramid/pull/3328
- Removed ``pyramid.config.Configurator.set_request_property`` which had been
deprecated since Pyramid 1.5.
deprecated since Pyramid 1.5. Instead use
``pyramid.config.Configurator.add_request_method`` with ``reify=True`` or
``property=True``.
See https://github.com/Pylons/pyramid/pull/3368
- Removed the ``principal`` keyword argument from
``pyramid.security.remember`` which had been deprecated since Pyramid 1.6
and replaced by the ``userid`` argument.
See https://github.com/Pylons/pyramid/pull/3369
Documentation Changes
---------------------
View
@@ -111,12 +111,6 @@ Nice-to-Have
)
Future
------
- 1.9: Remove extra code enabling ``pyramid.security.remember(principal=...)``
and force use of ``userid``.
Probably Bad Ideas
------------------
View
@@ -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 @@ def effective_principals(request):
'"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 @@ def remember(request, userid=_marker, **kw):
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 []
@@ -183,13 +183,6 @@ def test_with_authentication_policy_no_reg_on_request(self):
result = self._callFUT(request, 'me')
self.assertEqual(result, [('X-Pyramid-Test', 'me')])
def test_with_deprecated_principal_arg(self):
request = _makeRequest()
registry = request.registry
_registerAuthenticationPolicy(registry, 'yo')
result = self._callFUT(request, principal='me')
self.assertEqual(result, [('X-Pyramid-Test', 'me')])
def test_with_missing_arg(self):
request = _makeRequest()
registry = request.registry

0 comments on commit 781371a

Please sign in to comment.