Move view mixins to view inheritance for better typing

Author: davegaeddert

plain-admin/plain/admin/impersonate/views.py

@@ -1,14 +1,13 @@
-from plain.auth.views import AuthViewMixin
+from plain.auth.views import AuthView
 from plain.http import Response, ResponseForbidden, ResponseRedirect
-from plain.sessions.views import SessionViewMixin
-from plain.views import View
+from plain.sessions.views import SessionView
 
 from .constants import IMPERSONATE_SESSION_KEY
 from .permissions import can_be_impersonator
 from .requests import get_request_impersonator
 
 
-class ImpersonateStartView(AuthViewMixin, View):
+class ImpersonateStartView(AuthView):
     def get(self) -> Response:
         # We *could* already be impersonating, so need to consider that
         impersonator = get_request_impersonator(self.request) or self.user
@@ -19,7 +18,7 @@ def get(self) -> Response:
         return ResponseForbidden()
 
 
-class ImpersonateStopView(SessionViewMixin, View):
+class ImpersonateStopView(SessionView):
     def get(self) -> Response:
         self.session.pop(IMPERSONATE_SESSION_KEY)
         return ResponseRedirect(self.request.query_params.get("next", "/"))

plain-admin/plain/admin/views/base.py

@@ -1,6 +1,6 @@
 from typing import TYPE_CHECKING, Any, Optional
 
-from plain.auth.views import AuthViewMixin
+from plain.auth.views import AuthView
 from plain.runtime import settings
 from plain.urls import reverse
 from plain.utils import timezone
@@ -13,15 +13,15 @@
 from .types import Img
 
 if TYPE_CHECKING:
-    from plain.http import Response
+    from plain.http import ResponseBase
 
     from ..cards import Card
 
 
 URL_NAMESPACE = "admin"
 
 
-class AdminView(AuthViewMixin, TemplateView):
+class AdminView(AuthView, TemplateView):
     admin_required = True
 
     title: str = ""
@@ -44,7 +44,7 @@ class AdminView(AuthViewMixin, TemplateView):
     template_name = "admin/page.html"
     cards: list["Card"] = []
 
-    def get_response(self) -> "Response":
+    def get_response(self) -> "ResponseBase":
         response = super().get_response()
         response.headers["Cache-Control"] = (
             "no-cache, no-store, must-revalidate, max-age=0"

plain-admin/plain/admin/views/objects.py

@@ -1,7 +1,7 @@
 from functools import cached_property
 from typing import TYPE_CHECKING, Any
 
-from plain.htmx.views import HTMXViewMixin
+from plain.htmx.views import HTMXView
 from plain.http import Response, ResponseRedirect
 from plain.models import Model
 from plain.paginator import Paginator
@@ -18,7 +18,7 @@
     from plain.forms import BaseForm
 
 
-class AdminListView(HTMXViewMixin, AdminView):
+class AdminListView(HTMXView, AdminView):
     template_name = "admin/list.html"
     fields: list[str]
     actions: list[str] = []

plain-auth/plain/auth/views.py

@@ -1,28 +1,25 @@
 from __future__ import annotations
 
 from functools import cached_property
-from typing import TYPE_CHECKING, Any
+from typing import Any
 from urllib.parse import urlparse, urlunparse
 
 from plain.exceptions import PermissionDenied
 from plain.http import (
     Http404,
     QueryDict,
-    Response,
+    ResponseBase,
     ResponseRedirect,
 )
 from plain.runtime import settings
-from plain.sessions.views import SessionViewMixin
+from plain.sessions.views import SessionView
 from plain.urls import reverse
 from plain.utils.cache import patch_cache_control
 from plain.views import View
 
 from .sessions import logout
 from .utils import resolve_url
 
-if TYPE_CHECKING:
-    from plain.http import Request
-
 try:
     from plain.admin.impersonate import get_request_impersonator
 except ImportError:
@@ -35,13 +32,11 @@ def __init__(self, login_url: str | None = None, redirect_field_name: str = "nex
         self.redirect_field_name = redirect_field_name
 
 
-class AuthViewMixin(SessionViewMixin):
+class AuthView(SessionView):
     login_required = False
     admin_required = False  # Implies login_required
     login_url = settings.AUTH_LOGIN_URL
 
-    request: Request
-
     @cached_property
     def user(self) -> Any | None:
         """Get the authenticated user for this request."""
@@ -84,7 +79,7 @@ def check_auth(self) -> None:
                 # Show a 404 so we don't expose admin urls to non-admin users
                 raise Http404()
 
-    def get_response(self) -> Response:
+    def get_response(self) -> ResponseBase:
         try:
             self.check_auth()
         except LoginRequired as e:
@@ -110,8 +105,7 @@ def get_response(self) -> Response:
             else:
                 raise PermissionDenied("Login required")
 
-        # Mixin expects to be used with View base class
-        response = super().get_response()  # type: ignore[misc]
+        response = super().get_response()
 
         if self.user:
             # Make sure it at least has private as a default

plain-auth/tests/app/urls.py

@@ -1,4 +1,4 @@
-from plain.auth.views import AuthViewMixin
+from plain.auth.views import AuthView
 from plain.urls import Router, path
 from plain.views import View
 
@@ -8,28 +8,28 @@ def get(self):
         return "login"
 
 
-class ProtectedView(AuthViewMixin, View):
+class ProtectedView(AuthView):
     login_required = True
 
     def get(self):
         return "protected"
 
 
-class OpenView(AuthViewMixin, View):
+class OpenView(AuthView):
     # login_required = False
 
     def get(self):
         return "open"
 
 
-class AdminView(AuthViewMixin, View):
+class AdminView(AuthView):
     admin_required = True
 
     def get(self):
         return "admin"
 
 
-class NoLoginUrlView(AuthViewMixin, View):
+class NoLoginUrlView(AuthView):
     login_required = True
     login_url = None
 

plain-htmx/plain/htmx/views.py

@@ -3,19 +3,19 @@
 from collections.abc import Callable
 from typing import Any
 
-from plain.http import Response
+from plain.http import ResponseBase
 from plain.utils.cache import patch_vary_headers
+from plain.views import TemplateView
 
 from .templates import render_template_fragment
 
 
-class HTMXViewMixin:
-    """Mixin for View classes to add HTMX-specific functionality."""
+class HTMXView(TemplateView):
+    """View with HTMX-specific functionality."""
 
     def render_template(self) -> str:
-        # These methods are provided by the View base class
-        template = self.get_template()  # type: ignore[attr-defined]
-        context = self.get_template_context()  # type: ignore[attr-defined]
+        template = self.get_template()
+        context = self.get_template_context()
 
         if self.is_htmx_request() and self.get_htmx_fragment_name():
             return render_template_fragment(
@@ -26,20 +26,20 @@ def render_template(self) -> str:
 
         return template.render(context)
 
-    def get_response(self) -> Response:
-        response = super().get_response()  # type: ignore[misc]
+    def get_response(self) -> ResponseBase:
+        response = super().get_response()
         # Tell browser caching to also consider the fragment header,
         # not just the url/cookie.
         patch_vary_headers(
             response, ["HX-Request", "Plain-HX-Fragment", "Plain-HX-Action"]
         )
         return response
 
-    def get_request_handler(self) -> Callable[..., Any]:
-        if self.is_htmx_request():
+    def get_request_handler(self) -> Callable[[], Any] | None:
+        if self.is_htmx_request() and self.request.method:
             # You can use an htmx_{method} method on views
             # (or htmx_{method}_{action} for specific actions)
-            method = f"htmx_{self.request.method.lower()}"  # type: ignore[attr-defined]
+            method = f"htmx_{self.request.method.lower()}"
 
             if action := self.get_htmx_action_name():
                 # If an action is specified, we throw an error if
@@ -52,14 +52,14 @@ def get_request_handler(self) -> Callable[..., Any]:
                 # to a regular post method if it's not found
                 return handler
 
-        return super().get_request_handler()  # type: ignore[misc]
+        return super().get_request_handler()
 
     def is_htmx_request(self) -> bool:
-        return self.request.headers.get("HX-Request") == "true"  # type: ignore[attr-defined]
+        return self.request.headers.get("HX-Request") == "true"
 
     def get_htmx_fragment_name(self) -> str:
         # A custom header that we pass with the {% htmxfragment %} tag
-        return self.request.headers.get("Plain-HX-Fragment", "")  # type: ignore[attr-defined]
+        return self.request.headers.get("Plain-HX-Fragment", "")
 
     def get_htmx_action_name(self) -> str:
-        return self.request.headers.get("Plain-HX-Action", "")  # type: ignore[attr-defined]
+        return self.request.headers.get("Plain-HX-Action", "")

plain-htmx/tests/test_views.py

@@ -1,10 +1,9 @@
-from plain.htmx.views import HTMXViewMixin
+from plain.htmx.views import HTMXView
 from plain.http import Response
 from plain.test import RequestFactory
-from plain.views import View
 
 
-class V(HTMXViewMixin, View):
+class V(HTMXView):
     def get(self):
         return Response("Ok")
 

plain-loginlink/plain/loginlink/views.py

@@ -3,7 +3,7 @@
 from typing import Any
 
 from plain.auth import login, logout
-from plain.auth.views import AuthViewMixin
+from plain.auth.views import AuthView
 from plain.forms import BaseForm
 from plain.http import Response, ResponseRedirect
 from plain.runtime import settings
@@ -19,7 +19,7 @@
 )
 
 
-class LoginLinkFormView(AuthViewMixin, FormView):
+class LoginLinkFormView(AuthView, FormView):
     form_class = LoginLinkForm
     success_url = reverse_lazy("loginlink:sent")
 
@@ -44,7 +44,7 @@ def get_success_url(self, form: BaseForm) -> str:
             return self.success_url
 
 
-class LoginLinkSentView(AuthViewMixin, TemplateView):
+class LoginLinkSentView(AuthView, TemplateView):
     template_name = "loginlink/sent.html"
 
     def get(self) -> Response:
@@ -66,7 +66,7 @@ def get_template_context(self) -> dict[str, Any]:
         return context
 
 
-class LoginLinkLoginView(AuthViewMixin, View):
+class LoginLinkLoginView(AuthView, View):
     success_url = "/"
 
     def get(self) -> Response:

plain-oauth/plain/oauth/views.py

@@ -1,7 +1,7 @@
 import logging
 
 from plain.auth.requests import get_request_user
-from plain.auth.views import AuthViewMixin
+from plain.auth.views import AuthView
 from plain.http import Response, ResponseRedirect
 from plain.views import TemplateView, View
 
@@ -50,15 +50,15 @@ def get_template_context(self) -> dict:
         return context
 
 
-class OAuthConnectView(AuthViewMixin, View):
+class OAuthConnectView(AuthView):
     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):
+class OAuthDisconnectView(AuthView):
     def post(self) -> Response:
         request = self.request
         provider = self.url_kwargs["provider"]

plain-oauth/tests/app/urls.py

@@ -1,11 +1,11 @@
-from plain.auth.views import AuthViewMixin, LogoutView
+from plain.auth.views import AuthView, LogoutView
 from plain.oauth.providers import get_provider_keys
 from plain.oauth.urls import OAuthRouter
 from plain.urls import Router, include, path
 from plain.views import TemplateView
 
 
-class LoggedInView(AuthViewMixin, TemplateView):
+class LoggedInView(AuthView, TemplateView):
     template_name = "index.html"
     login_required = True