From ab80ac7996bf792ddf3fbcce639e4b6714b401e6 Mon Sep 17 00:00:00 2001 From: Theron Luhn Date: Tue, 13 Oct 2020 23:08:00 -0700 Subject: Rename `ISecurityPolicy.authenticated_identity` to `identity` --- docs/tutorials/wiki2/authentication.rst | 2 +- docs/tutorials/wiki2/src/authentication/tutorial/security.py | 6 +++--- docs/tutorials/wiki2/src/authorization/tutorial/security.py | 8 ++++---- docs/tutorials/wiki2/src/tests/tutorial/security.py | 8 ++++---- 4 files changed, 12 insertions(+), 12 deletions(-) (limited to 'docs/tutorials/wiki2') diff --git a/docs/tutorials/wiki2/authentication.rst b/docs/tutorials/wiki2/authentication.rst index 5519a967e..4d8723176 100644 --- a/docs/tutorials/wiki2/authentication.rst +++ b/docs/tutorials/wiki2/authentication.rst @@ -64,7 +64,7 @@ Identifying the current user is done in a few steps: #. The result is stored in the ``identity_cache`` which ensures that subsequent invocations return the same identity object for the request. -Finally, :attr:`pyramid.request.Request.authenticated_identity` contains either ``None`` or a ``tutorial.models.User`` instance and that value is aliased to ``request.user`` for convenience in our application. +Finally, :attr:`pyramid.request.Request.identity` contains either ``None`` or a ``tutorial.models.User`` instance and that value is aliased to ``request.user`` for convenience in our application. Note the usage of the ``identity_cache`` is optional, but it has several advantages in most scenarios: diff --git a/docs/tutorials/wiki2/src/authentication/tutorial/security.py b/docs/tutorials/wiki2/src/authentication/tutorial/security.py index 1027ddd0a..a4843f286 100644 --- a/docs/tutorials/wiki2/src/authentication/tutorial/security.py +++ b/docs/tutorials/wiki2/src/authentication/tutorial/security.py @@ -19,11 +19,11 @@ class MySecurityPolicy: user = request.dbsession.query(models.User).get(userid) return user - def authenticated_identity(self, request): + def identity(self, request): return self.identity_cache.get_or_create(request) def authenticated_userid(self, request): - user = self.authenticated_identity(request) + user = self.identity(request) if user is not None: return user.id @@ -41,4 +41,4 @@ def includeme(config): config.set_security_policy(MySecurityPolicy(settings['auth.secret'])) config.add_request_method( - lambda request: request.authenticated_identity, 'user', property=True) + lambda request: request.identity, 'user', property=True) diff --git a/docs/tutorials/wiki2/src/authorization/tutorial/security.py b/docs/tutorials/wiki2/src/authorization/tutorial/security.py index 5a9d4bbf2..4f79195ef 100644 --- a/docs/tutorials/wiki2/src/authorization/tutorial/security.py +++ b/docs/tutorials/wiki2/src/authorization/tutorial/security.py @@ -25,11 +25,11 @@ class MySecurityPolicy: user = request.dbsession.query(models.User).get(userid) return user - def authenticated_identity(self, request): + def identity(self, request): return self.identity_cache.get_or_create(request) def authenticated_userid(self, request): - user = self.authenticated_identity(request) + user = self.identity(request) if user is not None: return user.id @@ -45,7 +45,7 @@ class MySecurityPolicy: def effective_principals(self, request): principals = [Everyone] - user = self.authenticated_identity(request) + user = self.identity(request) if user is not None: principals.append(Authenticated) principals.append('u:' + str(user.id)) @@ -60,4 +60,4 @@ def includeme(config): config.set_security_policy(MySecurityPolicy(settings['auth.secret'])) config.add_request_method( - lambda request: request.authenticated_identity, 'user', property=True) + lambda request: request.identity, 'user', property=True) diff --git a/docs/tutorials/wiki2/src/tests/tutorial/security.py b/docs/tutorials/wiki2/src/tests/tutorial/security.py index 5a9d4bbf2..4f79195ef 100644 --- a/docs/tutorials/wiki2/src/tests/tutorial/security.py +++ b/docs/tutorials/wiki2/src/tests/tutorial/security.py @@ -25,11 +25,11 @@ class MySecurityPolicy: user = request.dbsession.query(models.User).get(userid) return user - def authenticated_identity(self, request): + def identity(self, request): return self.identity_cache.get_or_create(request) def authenticated_userid(self, request): - user = self.authenticated_identity(request) + user = self.identity(request) if user is not None: return user.id @@ -45,7 +45,7 @@ class MySecurityPolicy: def effective_principals(self, request): principals = [Everyone] - user = self.authenticated_identity(request) + user = self.identity(request) if user is not None: principals.append(Authenticated) principals.append('u:' + str(user.id)) @@ -60,4 +60,4 @@ def includeme(config): config.set_security_policy(MySecurityPolicy(settings['auth.secret'])) config.add_request_method( - lambda request: request.authenticated_identity, 'user', property=True) + lambda request: request.identity, 'user', property=True) -- cgit v1.2.3