Rename HttpRequest to Request

Author: davegaeddert

plain-admin/plain/admin/cards/base.py

@@ -1,6 +1,6 @@
 from enum import Enum
 
-from plain.http import HttpRequest
+from plain.http import Request
 from plain.templates import Template
 from plain.views import View
 
@@ -29,7 +29,7 @@ class Sizes(Enum):
 
     # These will be accessible at render time
     view: View
-    request: HttpRequest
+    request: Request
 
     def render(self, view, request):
         self.view = view

plain-auth/plain/auth/test.py

@@ -1,6 +1,6 @@
 from http.cookies import SimpleCookie
 
-from plain.http.request import HttpRequest
+from plain.http.request import Request
 from plain.runtime import settings
 from plain.sessions import SessionStore
 
@@ -9,7 +9,7 @@
 
 def login_client(client, user):
     """Log a user into a test client."""
-    request = HttpRequest()
+    request = Request()
     if client.session:
         request.session = client.session
     else:
@@ -30,7 +30,7 @@ def login_client(client, user):
 
 def logout_client(client):
     """Log out a user from a test client."""
-    request = HttpRequest()
+    request = Request()
     if client.session:
         request.session = client.session
         request.user = get_user(request)

plain-oauth/plain/oauth/providers.py

@@ -4,7 +4,7 @@
 from urllib.parse import urlencode
 
 from plain.auth import login as auth_login
-from plain.http import HttpRequest, Response, ResponseRedirect
+from plain.http import Request, Response, ResponseRedirect
 from plain.runtime import settings
 from plain.urls import reverse
 from plain.utils.cache import add_never_cache_headers
@@ -65,7 +65,7 @@ def __init__(
         self.client_secret = client_secret
         self.scope = scope
 
-    def get_authorization_url_params(self, *, request: HttpRequest) -> dict:
+    def get_authorization_url_params(self, *, request: Request) -> dict:
         return {
             "redirect_uri": self.get_callback_url(request=request),
             "client_id": self.get_client_id(),
@@ -77,13 +77,13 @@ def get_authorization_url_params(self, *, request: HttpRequest) -> dict:
     def refresh_oauth_token(self, *, oauth_token: OAuthToken) -> OAuthToken:
         raise NotImplementedError()
 
-    def get_oauth_token(self, *, code: str, request: HttpRequest) -> OAuthToken:
+    def get_oauth_token(self, *, code: str, request: Request) -> OAuthToken:
         raise NotImplementedError()
 
     def get_oauth_user(self, *, oauth_token: OAuthToken) -> OAuthUser:
         raise NotImplementedError()
 
-    def get_authorization_url(self, *, request: HttpRequest) -> str:
+    def get_authorization_url(self, *, request: Request) -> str:
         return self.authorization_url
 
     def get_client_id(self) -> str:
@@ -95,14 +95,14 @@ def get_client_secret(self) -> str:
     def get_scope(self) -> str:
         return self.scope
 
-    def get_callback_url(self, *, request: HttpRequest) -> str:
+    def get_callback_url(self, *, request: Request) -> str:
         url = reverse("oauth:callback", provider=self.provider_key)
         return request.build_absolute_uri(url)
 
     def generate_state(self) -> str:
         return get_random_string(length=32)
 
-    def check_request_state(self, *, request: HttpRequest) -> None:
+    def check_request_state(self, *, request: Request) -> None:
         if error := request.query_params.get("error"):
             raise OAuthError(error)
 
@@ -117,7 +117,7 @@ def check_request_state(self, *, request: HttpRequest) -> None:
             raise OAuthStateMismatchError()
 
     def handle_login_request(
-        self, *, request: HttpRequest, redirect_to: str = ""
+        self, *, request: Request, redirect_to: str = ""
     ) -> Response:
         authorization_url = self.get_authorization_url(request=request)
         authorization_params = self.get_authorization_url_params(request=request)
@@ -138,11 +138,11 @@ def handle_login_request(
         return self.get_redirect_response(redirect_url)
 
     def handle_connect_request(
-        self, *, request: HttpRequest, redirect_to: str = ""
+        self, *, request: Request, redirect_to: str = ""
     ) -> Response:
         return self.handle_login_request(request=request, redirect_to=redirect_to)
 
-    def handle_disconnect_request(self, *, request: HttpRequest) -> Response:
+    def handle_disconnect_request(self, *, request: Request) -> Response:
         provider_user_id = request.data["provider_user_id"]
         connection = OAuthConnection.query.get(
             provider_key=self.provider_key, provider_user_id=provider_user_id
@@ -151,7 +151,7 @@ def handle_disconnect_request(self, *, request: HttpRequest) -> Response:
         redirect_url = self.get_disconnect_redirect_url(request=request)
         return self.get_redirect_response(redirect_url)
 
-    def handle_callback_request(self, *, request: HttpRequest) -> Response:
+    def handle_callback_request(self, *, request: Request) -> Response:
         self.check_request_state(request=request)
 
         oauth_token = self.get_oauth_token(
@@ -181,13 +181,13 @@ def handle_callback_request(self, *, request: HttpRequest) -> Response:
         redirect_url = self.get_login_redirect_url(request=request)
         return self.get_redirect_response(redirect_url)
 
-    def login(self, *, request: HttpRequest, user: Any) -> None:
+    def login(self, *, request: Request, user: Any) -> None:
         auth_login(request=request, user=user)
 
-    def get_login_redirect_url(self, *, request: HttpRequest) -> str:
+    def get_login_redirect_url(self, *, request: Request) -> str:
         return request.session.pop(SESSION_NEXT_KEY, "/")
 
-    def get_disconnect_redirect_url(self, *, request: HttpRequest) -> str:
+    def get_disconnect_redirect_url(self, *, request: Request) -> str:
         return request.data.get("next", "/")
 
     def get_redirect_response(self, redirect_url: str) -> Response:

plain/plain/csrf/middleware.py

@@ -13,7 +13,7 @@
 
 if TYPE_CHECKING:
     from plain.http import Response
-    from plain.http.request import HttpRequest
+    from plain.http.request import Request
 
 logger = logging.getLogger("plain.security.csrf")
 
@@ -27,23 +27,23 @@ class CsrfViewMiddleware:
     like subdomains can have different trust levels and are rejected.
     """
 
-    def __init__(self, get_response: Callable[[HttpRequest], Response]):
+    def __init__(self, get_response: Callable[[Request], Response]):
         self.get_response = get_response
 
         # Compile CSRF exempt patterns once for performance
         self.csrf_exempt_patterns: list[re.Pattern[str]] = [
             re.compile(r) for r in settings.CSRF_EXEMPT_PATHS
         ]
 
-    def __call__(self, request: HttpRequest) -> Response:
+    def __call__(self, request: Request) -> Response:
         allowed, reason = self.should_allow_request(request)
 
         if allowed:
             return self.get_response(request)
         else:
             return self.reject(request, reason)
 
-    def should_allow_request(self, request: HttpRequest) -> tuple[bool, str]:
+    def should_allow_request(self, request: Request) -> tuple[bool, str]:
         # 1. Allow safe methods (GET, HEAD, OPTIONS)
         if request.method in ("GET", "HEAD", "OPTIONS"):
             return True, f"Safe HTTP method: {request.method}"
@@ -128,7 +128,7 @@ def should_allow_request(self, request: HttpRequest) -> tuple[bool, str]:
             f"Cross-origin request detected - Origin {origin} does not match Host",
         )
 
-    def reject(self, request: HttpRequest, reason: str) -> Response:
+    def reject(self, request: Request, reason: str) -> Response:
         """Reject a request with a 403 Forbidden response."""
 
         response = CsrfFailureView.as_view()(request, reason=reason)

plain/plain/forms/forms.py

@@ -14,7 +14,7 @@
 from .fields import Field, FileField
 
 if TYPE_CHECKING:
-    from plain.http import HttpRequest
+    from plain.http import Request
 
     from .boundfield import BoundField
 
@@ -70,7 +70,7 @@ class BaseForm:
     def __init__(
         self,
         *,
-        request: HttpRequest,
+        request: Request,
         auto_id: str | bool = "id_%s",
         prefix: str | None = None,
         initial: dict[str, Any] | None = None,

plain/plain/http/README.md

@@ -6,7 +6,7 @@
 
 ## Overview
 
-Typically you will interact with [request](request.py#HttpRequest) and [response](response.py#ResponseBase) objects in your views and middleware.
+Typically you will interact with [Request](request.py#Request) and [Response](response.py#ResponseBase) objects in your views and middleware.
 
 ```python
 from plain.views import View

plain/plain/http/__init__.py

@@ -1,9 +1,9 @@
 from plain.http.cookie import parse_cookie
 from plain.http.request import (
-    HttpHeaders,
-    HttpRequest,
     QueryDict,
     RawPostDataException,
+    Request,
+    RequestHeaders,
     UnreadablePostError,
 )
 from plain.http.response import (
@@ -26,8 +26,8 @@
 
 __all__ = [
     "parse_cookie",
-    "HttpHeaders",
-    "HttpRequest",
+    "Request",
+    "RequestHeaders",
     "QueryDict",
     "RawPostDataException",
     "UnreadablePostError",

plain/plain/http/request.py

@@ -47,7 +47,7 @@ class RawPostDataException(Exception):
     pass
 
 
-class HttpRequest:
+class Request:
     """A basic HTTP request."""
 
     # The encoding used in GET/POST dicts. None means use default setting.
@@ -89,7 +89,7 @@ def __getstate__(self) -> dict[str, Any]:
                 del obj_dict[attr]
         return obj_dict
 
-    def __deepcopy__(self, memo: dict[int, Any]) -> HttpRequest:
+    def __deepcopy__(self, memo: dict[int, Any]) -> Request:
         obj = copy.copy(self)
         for attr in self.non_picklable_attrs:
             if hasattr(self, attr):
@@ -98,8 +98,8 @@ def __deepcopy__(self, memo: dict[int, Any]) -> HttpRequest:
         return obj
 
     @cached_property
-    def headers(self) -> HttpHeaders:
-        return HttpHeaders(self.meta)
+    def headers(self) -> RequestHeaders:
+        return RequestHeaders(self.meta)
 
     @cached_property
     def accepted_types(self) -> list[MediaType]:
@@ -454,7 +454,7 @@ def get_signed_cookie(
         return unsign_cookie_value(key, cookie_value, salt, max_age, default)
 
 
-class HttpHeaders(CaseInsensitiveMapping):
+class RequestHeaders(CaseInsensitiveMapping):
     HTTP_PREFIX = "HTTP_"
     # PEP 333 gives two headers which aren't prepended with HTTP_.
     UNPREFIXED_HEADERS = {"CONTENT_TYPE", "CONTENT_LENGTH"}

plain/plain/internal/files/uploadhandler.py

@@ -19,7 +19,7 @@
 if TYPE_CHECKING:
     from typing import Any
 
-    from plain.http import HttpRequest
+    from plain.http import Request
 
 __all__ = [
     "UploadFileException",
@@ -85,7 +85,7 @@ class FileUploadHandler:
 
     chunk_size = 64 * 2**10  # : The default chunk size is 64 KB.
 
-    def __init__(self, request: HttpRequest | None = None) -> None:
+    def __init__(self, request: Request | None = None) -> None:
         self.file_name = None
         self.content_type = None
         self.content_length = None
@@ -265,8 +265,8 @@ def load_handler(path: str, *args: Any, **kwargs: Any) -> FileUploadHandler:
     Given a path to a handler, return an instance of that handler.
 
     E.g.::
-        >>> from plain.http import HttpRequest
-        >>> request = HttpRequest()
+        >>> from plain.http import Request
+        >>> request = Request()
         >>> load_handler(
         ...     'plain.internal.files.uploadhandler.TemporaryFileUploadHandler',
         ...     request,

plain/plain/internal/handlers/base.py

@@ -18,7 +18,7 @@
 if TYPE_CHECKING:
     from collections.abc import Callable
 
-    from plain.http import HttpRequest, Response
+    from plain.http import Request, Response
     from plain.urls import ResolverMatch
 
 logger = logging.getLogger("plain.request")
@@ -43,7 +43,7 @@
 
 
 class BaseHandler:
-    _middleware_chain: Callable[[HttpRequest], Response] | None = None
+    _middleware_chain: Callable[[Request], Response] | None = None
 
     def load_middleware(self) -> None:
         """
@@ -72,8 +72,8 @@ def load_middleware(self) -> None:
         # as a flag for initialization being complete.
         self._middleware_chain = handler
 
-    def get_response(self, request: HttpRequest) -> Response:
-        """Return a Response object for the given HttpRequest."""
+    def get_response(self, request: Request) -> Response:
+        """Return a Response object for the given Request."""
 
         span_attributes = {
             "plain.request.id": request.unique_id,
@@ -124,7 +124,7 @@ def get_response(self, request: HttpRequest) -> Response:
                 )
             return response
 
-    def _get_response(self, request: HttpRequest) -> Response:
+    def _get_response(self, request: Request) -> Response:
         """
         Resolve and call the view, then apply view, exception, and
         template_response middleware. This method is everything that happens
@@ -141,7 +141,7 @@ def _get_response(self, request: HttpRequest) -> Response:
 
         return response
 
-    def resolve_request(self, request: HttpRequest) -> ResolverMatch:
+    def resolve_request(self, request: Request) -> ResolverMatch:
         """
         Retrieve/set the urlrouter for the request. Return the view resolved,
         with its args and kwargs.