Type annotations for plain-loginlink

Author: davegaeddert

plain-loginlink/plain/loginlink/forms.py

@@ -1,15 +1,24 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING, Any
+
 from plain import forms
 from plain.auth import get_user_model
 from plain.email import TemplateEmail
 
 from .links import generate_link_url
 
+if TYPE_CHECKING:
+    from plain.http import Request
+
 
 class LoginLinkForm(forms.Form):
     email = forms.EmailField()
     next = forms.CharField(required=False)
 
-    def maybe_send_link(self, request, expires_in=60 * 60):
+    def maybe_send_link(
+        self, request: Request, expires_in: int = 60 * 60
+    ) -> int | None:
         user_model = get_user_model()
         email = self.cleaned_data["email"]
         try:
@@ -31,7 +40,11 @@ def maybe_send_link(self, request, expires_in=60 * 60):
             )
             return email.send()
 
-    def get_template_email(self, *, email, context):
+        return None
+
+    def get_template_email(
+        self, *, email: str, context: dict[str, Any]
+    ) -> TemplateEmail:
         return TemplateEmail(
             template="loginlink",
             to=[email],

plain-loginlink/plain/loginlink/links.py

@@ -1,9 +1,17 @@
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
 from plain.auth import get_user_model
 from plain.signing import BadSignature, SignatureExpired
 from plain.urls import reverse
 
 from . import signing
 
+if TYPE_CHECKING:
+    from plain.http import Request
+    from plain.models import Model
+
 
 class LoginLinkExpired(Exception):
     pass
@@ -17,7 +25,9 @@ class LoginLinkChanged(Exception):
     pass
 
 
-def generate_link_url(*, request, user, email, expires_in):
+def generate_link_url(
+    *, request: Request, user: Model, email: str, expires_in: int
+) -> str:
     """
     Generate a login link using both the user's ID
     and email address, so links break if the user email changes or is assigned to another user.
@@ -27,7 +37,7 @@ def generate_link_url(*, request, user, email, expires_in):
     return request.build_absolute_uri(reverse("loginlink:login", token))
 
 
-def get_link_token_user(token):
+def get_link_token_user(token: str) -> Model:
     """
     Validate a link token and get the user from it.
     """

plain-loginlink/plain/loginlink/signing.py

@@ -1,5 +1,8 @@
+from __future__ import annotations
+
 import time
 import zlib
+from typing import Any
 
 from plain.signing import (
     JSONSerializer,
@@ -15,12 +18,12 @@
 class ExpiringSigner(Signer):
     """A signer with an embedded expiration (vs max age unsign)"""
 
-    def sign(self, value, expires_in):
+    def sign(self, value: str, expires_in: int) -> str:
         timestamp = b62_encode(int(time.time() + expires_in))
         value = f"{value}{self.sep}{timestamp}"
         return super().sign(value)
 
-    def unsign(self, value):
+    def unsign(self, value: str) -> str:
         """
         Retrieve original value and check the expiration hasn't passed.
         """
@@ -32,8 +35,12 @@ def unsign(self, value):
         return value
 
     def sign_object(
-        self, obj, serializer=JSONSerializer, compress=False, expires_in=None
-    ):
+        self,
+        obj: Any,
+        serializer: type = JSONSerializer,
+        compress: bool = False,
+        expires_in: int | None = None,
+    ) -> str:
         """
         Return URL-safe, hmac signed base64 compressed JSON string.
 
@@ -58,7 +65,7 @@ def sign_object(
             base64d = "." + base64d
         return self.sign(base64d, expires_in)
 
-    def unsign_object(self, signed_obj, serializer=JSONSerializer):
+    def unsign_object(self, signed_obj: str, serializer: type = JSONSerializer) -> Any:
         # Signer.unsign() returns str but base64 and zlib compression operate
         # on bytes.
         base64d = self.unsign(signed_obj).encode()
@@ -73,13 +80,13 @@ def unsign_object(self, signed_obj, serializer=JSONSerializer):
 
 
 def dumps(
-    obj,
-    key=None,
-    salt="plain.loginlink",
-    serializer=JSONSerializer,
-    compress=False,
-    expires_in=None,
-):
+    obj: Any,
+    key: str | None = None,
+    salt: str = "plain.loginlink",
+    serializer: type = JSONSerializer,
+    compress: bool = False,
+    expires_in: int | None = None,
+) -> str:
     """
     Return URL-safe, hmac signed base64 compressed JSON string. If key is
     None, use settings.SECRET_KEY instead. The hmac algorithm is the default
@@ -102,12 +109,12 @@ def dumps(
 
 
 def loads(
-    s,
-    key=None,
-    salt="plain.loginlink",
-    serializer=JSONSerializer,
-    fallback_keys=None,
-):
+    s: str,
+    key: str | None = None,
+    salt: str = "plain.loginlink",
+    serializer: type = JSONSerializer,
+    fallback_keys: list[str] | None = None,
+) -> Any:
     """
     Reverse of dumps(), raise BadSignature if signature fails.
 

plain-loginlink/plain/loginlink/views.py

@@ -1,6 +1,10 @@
+from __future__ import annotations
+
+from typing import Any
+
 from plain.auth import login, logout
 from plain.auth.views import AuthViewMixin
-from plain.http import ResponseRedirect
+from plain.http import Response, ResponseRedirect
 from plain.runtime import settings
 from plain.urls import reverse, reverse_lazy
 from plain.views import FormView, TemplateView, View
@@ -18,19 +22,19 @@ class LoginLinkFormView(AuthViewMixin, FormView):
     form_class = LoginLinkForm
     success_url = reverse_lazy("loginlink:sent")
 
-    def get(self):
+    def get(self) -> Response:
         # Redirect if the user is already logged in
         if self.user:
             form = self.get_form()
             return ResponseRedirect(self.get_success_url(form))
 
         return super().get()
 
-    def form_valid(self, form):
+    def form_valid(self, form: LoginLinkForm) -> Response:
         form.maybe_send_link(self.request)
         return super().form_valid(form)
 
-    def get_success_url(self, form):
+    def get_success_url(self, form: LoginLinkForm) -> str:
         if next_url := form.cleaned_data.get("next"):
             # Keep the next URL in the query string so the sent
             # view can redirect to it if reloaded and logged in already.
@@ -42,7 +46,7 @@ def get_success_url(self, form):
 class LoginLinkSentView(AuthViewMixin, TemplateView):
     template_name = "loginlink/sent.html"
 
-    def get(self):
+    def get(self) -> Response:
         # Redirect if the user is already logged in
         if self.user:
             next_url = self.request.query_params.get("next", "/")
@@ -54,7 +58,7 @@ def get(self):
 class LoginLinkFailedView(TemplateView):
     template_name = "loginlink/failed.html"
 
-    def get_template_context(self):
+    def get_template_context(self) -> dict[str, Any]:
         context = super().get_template_context()
         context["error"] = self.request.query_params.get("error")
         context["login_url"] = reverse(settings.AUTH_LOGIN_URL)
@@ -64,7 +68,7 @@ def get_template_context(self):
 class LoginLinkLoginView(AuthViewMixin, View):
     success_url = "/"
 
-    def get(self):
+    def get(self) -> Response:
         # If they're logged in, log them out and process the link again
         if self.user:
             logout(self.request)

scripts/type-validate

@@ -25,6 +25,7 @@ FULLY_TYPED_DIRS = [
     "plain-esbuild/plain/esbuild",
     "plain-flags/plain/flags",
     "plain-htmx/plain/htmx",
+    "plain-loginlink/plain/loginlink",
     "plain-sessions/plain/sessions",
 ]