Type annotations on plain-auth

Author: davegaeddert

plain-auth/plain/auth/requests.py

@@ -1,24 +1,20 @@
 from __future__ import annotations
 
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from weakref import WeakKeyDictionary
 
 if TYPE_CHECKING:
     from plain.http import Request
 
-    from .sessions import get_user_model
+_request_users: WeakKeyDictionary[Request, Any | None] = WeakKeyDictionary()
 
-    User = get_user_model()
 
-_request_users: WeakKeyDictionary[Request, User | None] = WeakKeyDictionary()
-
-
-def set_request_user(request: Request, user: User | None) -> None:
+def set_request_user(request: Request, user: Any | None) -> None:
     """Store the authenticated user for this request."""
     _request_users[request] = user
 
 
-def get_request_user(request: Request) -> User | None:
+def get_request_user(request: Request) -> Any | None:
     """
     Get the authenticated user for this request, if any.
 

plain-auth/plain/auth/sessions.py

@@ -1,4 +1,8 @@
+from __future__ import annotations
+
 import hmac
+from collections.abc import Generator
+from typing import TYPE_CHECKING, Any
 
 from plain.exceptions import ImproperlyConfigured
 from plain.models import models_registry
@@ -9,18 +13,21 @@
 
 from .requests import get_request_user, set_request_user
 
+if TYPE_CHECKING:
+    from plain.http import Request
+
 USER_ID_SESSION_KEY = "_auth_user_id"
 USER_HASH_SESSION_KEY = "_auth_user_hash"
 
 
-def get_session_auth_hash(user):
+def get_session_auth_hash(user: Any) -> str:
     """
     Return an HMAC of the password field.
     """
     return _get_session_auth_hash(user)
 
 
-def update_session_auth_hash(request, user):
+def update_session_auth_hash(request: Request, user: Any) -> None:
     """
     Updating a user's password (for example) logs out all sessions for the user.
 
@@ -36,12 +43,12 @@ def update_session_auth_hash(request, user):
         session[USER_HASH_SESSION_KEY] = get_session_auth_hash(user)
 
 
-def get_session_auth_fallback_hash(user):
+def get_session_auth_fallback_hash(user: Any) -> Generator[str, None, None]:
     for fallback_secret in settings.SECRET_KEY_FALLBACKS:
         yield _get_session_auth_hash(user, secret=fallback_secret)
 
 
-def _get_session_auth_hash(user, secret=None):
+def _get_session_auth_hash(user: Any, secret: str | None = None) -> str:
     key_salt = "plain.auth.get_session_auth_hash"
     return salted_hmac(
         key_salt,
@@ -51,7 +58,7 @@ def _get_session_auth_hash(user, secret=None):
     ).hexdigest()
 
 
-def login(request, user):
+def login(request: Request, user: Any) -> None:
     """
     Persist a user id and a backend in the request. This way a user doesn't
     have to reauthenticate on every request. Note that data set during
@@ -87,7 +94,7 @@ def login(request, user):
     set_request_user(request, user)
 
 
-def logout(request):
+def logout(request: Request) -> None:
     """
     Remove the authenticated user's ID from the request and flush their session
     data.
@@ -99,7 +106,7 @@ def logout(request):
     set_request_user(request, None)
 
 
-def get_user_model():
+def get_user_model() -> type[Any]:
     """
     Return the User model that is active in this project.
     """
@@ -115,7 +122,7 @@ def get_user_model():
         )
 
 
-def get_user(request):
+def get_user(request: Request) -> Any | None:
     """
     Return the user model instance associated with the given request session.
     If no user is retrieved, return None.

plain-auth/plain/auth/templates.py

@@ -1,13 +1,20 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
 from jinja2 import pass_context
 
 from plain.templates import register_template_global
 
 from .requests import get_request_user
 
+if TYPE_CHECKING:
+    from jinja2.runtime import Context
+
 
 @register_template_global
 @pass_context
-def get_current_user(context):
+def get_current_user(context: Context) -> Any | None:
     """Get the authenticated user for the current request."""
     request = context.get("request")
     assert request is not None, "No request in template context"

plain-auth/plain/auth/test.py

@@ -1,4 +1,7 @@
+from __future__ import annotations
+
 from http.cookies import SimpleCookie
+from typing import TYPE_CHECKING, Any
 
 from plain.http.request import Request
 from plain.runtime import settings
@@ -8,8 +11,11 @@
 from .requests import set_request_user
 from .sessions import get_user, login, logout
 
+if TYPE_CHECKING:
+    from plain.test.client import Client
+
 
-def login_client(client, user):
+def login_client(client: Client, user: Any) -> None:
     """Log a user into a test client."""
     request = Request()
     if client.session:
@@ -32,7 +38,7 @@ def login_client(client, user):
     client.cookies[session_cookie].update(cookie_data)
 
 
-def logout_client(client):
+def logout_client(client: Client) -> None:
     """Log out a user from a test client."""
     request = Request()
     if client.session:

plain-auth/plain/auth/utils.py

@@ -1,8 +1,12 @@
+from __future__ import annotations
+
+from typing import Any
+
 from plain.urls import NoReverseMatch, reverse
 from plain.utils.functional import Promise
 
 
-def resolve_url(to, *args, **kwargs):
+def resolve_url(to: Any, *args: Any, **kwargs: Any) -> str:
     """
     Return a URL appropriate for the arguments passed.
 

plain-auth/plain/auth/views.py

@@ -1,7 +1,7 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 from urllib.parse import urlparse, urlunparse
 
 from plain.exceptions import PermissionDenied
@@ -23,13 +23,9 @@
 if TYPE_CHECKING:
     from plain.http import Request
 
-    from .sessions import get_user_model
-
-    User = get_user_model()
-
 
 class LoginRequired(Exception):
-    def __init__(self, login_url=None, redirect_field_name="next"):
+    def __init__(self, login_url: str | None = None, redirect_field_name: str = "next"):
         self.login_url = login_url or settings.AUTH_LOGIN_URL
         self.redirect_field_name = redirect_field_name
 
@@ -42,7 +38,7 @@ class AuthViewMixin(SessionViewMixin):
     request: Request
 
     @cached_property
-    def user(self) -> User | None:
+    def user(self) -> Any | None:
         """Get the authenticated user for this request."""
         from .requests import get_request_user
 
@@ -116,12 +112,14 @@ def get_response(self) -> Response:
 
 
 class LogoutView(View):
-    def post(self):
+    def post(self) -> ResponseRedirect:
         logout(self.request)
         return ResponseRedirect("/")
 
 
-def redirect_to_login(next, login_url=None, redirect_field_name="next"):
+def redirect_to_login(
+    next: str, login_url: str | None = None, redirect_field_name: str = "next"
+) -> ResponseRedirect:
     """
     Redirect the user to the login page, passing the given 'next' page.
     """
@@ -133,4 +131,4 @@ def redirect_to_login(next, login_url=None, redirect_field_name="next"):
         querystring[redirect_field_name] = next
         login_url_parts[4] = querystring.urlencode(safe="/")
 
-    return ResponseRedirect(urlunparse(login_url_parts))
+    return ResponseRedirect(str(urlunparse(login_url_parts)))

scripts/type-validate

@@ -14,6 +14,7 @@ from pathlib import Path
 # Directories that must maintain 100% type annotation coverage
 FULLY_TYPED_DIRS = [
     "plain/plain",
+    "plain-auth/plain/auth",
 ]