Type annotations for plain-oauth

Author: davegaeddert

plain-oauth/plain/oauth/models.py

@@ -1,4 +1,4 @@
-from typing import TYPE_CHECKING
+from typing import TYPE_CHECKING, Any
 
 from plain import models
 from plain.auth import get_user_model
@@ -50,7 +50,7 @@ class Meta:
         ]
         ordering = ("provider_key",)
 
-    def __str__(self):
+    def __str__(self) -> str:
         return f"{self.provider_key}[{self.user}:{self.provider_user_id}]"
 
     def refresh_access_token(self) -> None:
@@ -69,13 +69,13 @@ def refresh_access_token(self) -> None:
         self.set_token_fields(refreshed_oauth_token)
         self.save()
 
-    def set_token_fields(self, oauth_token: "OAuthToken"):
+    def set_token_fields(self, oauth_token: "OAuthToken") -> None:
         self.access_token = oauth_token.access_token
         self.refresh_token = oauth_token.refresh_token
         self.access_token_expires_at = oauth_token.access_token_expires_at
         self.refresh_token_expires_at = oauth_token.refresh_token_expires_at
 
-    def set_user_fields(self, oauth_user: "OAuthUser"):
+    def set_user_fields(self, oauth_user: "OAuthUser") -> None:
         self.provider_user_id = oauth_user.provider_id
 
     def access_token_expired(self) -> bool:
@@ -125,7 +125,7 @@ def get_or_create_user(
     def connect(
         cls,
         *,
-        user,
+        user: Any,
         provider_key: str,
         oauth_token: "OAuthToken",
         oauth_user: "OAuthUser",
@@ -155,7 +155,7 @@ def connect(
         return connection
 
     @classmethod
-    def preflight(cls):
+    def preflight(cls) -> list[PreflightResult]:
         """
         A system check for ensuring that provider_keys in the database are also present in settings.
         """

plain-oauth/plain/oauth/providers.py

@@ -40,7 +40,7 @@ def __init__(self, *, provider_id: str, user_model_fields: dict | None = None):
         self.provider_id = provider_id  # ID on the provider's system
         self.user_model_fields = user_model_fields or {}
 
-    def __str__(self):
+    def __str__(self) -> str:
         if "email" in self.user_model_fields:
             return self.user_model_fields["email"]
         if "username" in self.user_model_fields:

plain-oauth/plain/oauth/views.py

@@ -2,7 +2,7 @@
 
 from plain.auth.requests import get_request_user
 from plain.auth.views import AuthViewMixin
-from plain.http import ResponseRedirect
+from plain.http import Response, ResponseRedirect
 from plain.views import TemplateView, View
 
 from .exceptions import (
@@ -14,7 +14,7 @@
 
 
 class OAuthLoginView(View):
-    def post(self):
+    def post(self) -> Response:
         request = self.request
         provider = self.url_kwargs["provider"]
         if get_request_user(request):
@@ -31,7 +31,7 @@ class OAuthCallbackView(TemplateView):
 
     template_name = "oauth/callback.html"
 
-    def get(self):
+    def get(self) -> Response:
         provider = self.url_kwargs["provider"]
         provider_instance = get_oauth_provider_instance(provider_key=provider)
         try:
@@ -51,15 +51,15 @@ def get_template_context(self) -> dict:
 
 
 class OAuthConnectView(AuthViewMixin, View):
-    def post(self):
+    def post(self) -> Response:
         request = self.request
         provider = self.url_kwargs["provider"]
         provider_instance = get_oauth_provider_instance(provider_key=provider)
         return provider_instance.handle_connect_request(request=request)
 
 
 class OAuthDisconnectView(AuthViewMixin, View):
-    def post(self):
+    def post(self) -> Response:
         request = self.request
         provider = self.url_kwargs["provider"]
         provider_instance = get_oauth_provider_instance(provider_key=provider)

scripts/type-validate

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