Add type hints using basedpyright

Author: mrgalopes

inertia/http.py

@@ -1,6 +1,7 @@
 from functools import wraps
 from http import HTTPStatus
 from json import dumps as json_encode
+from typing import Any, Callable
 
 from django.core.exceptions import ImproperlyConfigured
 from django.http import HttpRequest, HttpResponse
@@ -65,6 +66,11 @@ def should_encrypt_history(self):
 
 
 class BaseInertiaResponseMixin:
+    request: InertiaRequest
+    component: str
+    props: dict[str, Any]
+    template_data: dict[str, Any]
+
     def page_data(self):
         clear_history = validate_type(
             self.request.session.pop(INERTIA_SESSION_CLEAR_HISTORY, False),
@@ -147,7 +153,7 @@ def build_first_load(self, data):
                 "inertia_layout": layout,
                 **context,
             },
-            self.request,
+            self.request.request,
             using=None,
         )
 
@@ -238,8 +244,8 @@ def clear_history(request):
     request.session[INERTIA_SESSION_CLEAR_HISTORY] = True
 
 
-def inertia(component):
-    def decorator(func):
+def inertia(component: str):
+    def decorator(func: Callable[..., HttpResponse | InertiaResponse | dict[str, Any]]):
         @wraps(func)
         def process_inertia_response(request, *args, **kwargs):
             props = func(request, *args, **kwargs)

inertia/middleware.py

@@ -50,5 +50,9 @@ def is_stale_inertia_get(self, request):
         return request.method == "GET" and self.is_stale(request)
 
     def force_refresh(self, request):
-        messages.get_messages(request).used = False
+        # If the storage middleware is not defined, get_messages returns an empty list
+        storage = messages.get_messages(request)
+        if not isinstance(storage, list):
+            storage.used = False
+
         return location(request.build_absolute_uri())

inertia/prop_classes.py

@@ -11,7 +11,7 @@ def __call__(self):
 
 class MergeableProp(ABC):
     @abstractmethod
-    def should_merge(self):
+    def should_merge(self) -> bool:
         pass
 
 

inertia/test.py

@@ -9,7 +9,7 @@
 
 
 class ClientWithLastResponse:
-    def __init__(self, client):
+    def __init__(self, client: Client):
         self.client = client
         self.last_response = None
 
@@ -29,10 +29,6 @@ def setUp(self):
     def last_response(self):
         return self.inertia.last_response or self.client.last_response
 
-    def assertJSONResponse(self, response, json_obj):
-        self.assertEqual(response.headers["Content-Type"], "application/json")
-        self.assertEqual(response.json(), json_obj)
-
 
 class InertiaTestCase(BaseInertiaTestCase, TestCase):
     def setUp(self):
@@ -47,11 +43,12 @@ def tearDown(self):
         self.mock_inertia.stop()
 
     def page(self):
-        page_data = (
-            self.mock_render.call_args[0][1]["page"]
-            if self.mock_render.call_args
-            else self.last_response().content
-        )
+        if self.mock_render.call_args:
+            page_data = self.mock_render.call_args[0][1]["page"]
+        elif response := self.last_response():
+            page_data = response.content
+        else:
+            page_data = ""
 
         return loads(page_data)
 
@@ -75,6 +72,10 @@ def template_data(self):
     def component(self):
         return self.page()["component"]
 
+    def assertJSONResponse(self, response, json_obj):
+        self.assertEqual(response.headers["Content-Type"], "application/json")
+        self.assertEqual(response.json(), json_obj)
+
     def assertIncludesProps(self, props):
         self.assertDictEqual(self.props(), {**self.props(), **props})
 

inertia/tests/testapp/urls.py

@@ -14,7 +14,7 @@
     path("defer-group/", views.defer_group_test),
     path("merge/", views.merge_test),
     path("complex-props/", views.complex_props_test),
-    path("share/", views.share_test),
+    path("share/", views.share_test),  # type: ignore
     path("inertia-redirect/", views.inertia_redirect_test),
     path("external-redirect/", views.external_redirect_test),
     path("encrypt-history/", views.encrypt_history_test),

inertia/tests/testapp/views.py

@@ -132,7 +132,7 @@ def encrypt_history_false_test(request):
 
 @inertia("TestComponent")
 def encrypt_history_type_error_test(request):
-    encrypt_history(request, "foo")
+    encrypt_history(request, "foo")  # pyright: ignore[reportArgumentType]
     return {}
 
 

inertia/utils.py

@@ -13,23 +13,22 @@ def model_to_dict(model):
 
 
 class InertiaJsonEncoder(DjangoJSONEncoder):
-    def default(self, value):
-        if hasattr(value.__class__, "InertiaMeta"):
+    def default(self, o):
+        if hasattr(o.__class__, "InertiaMeta"):
             return {
-                field: getattr(value, field)
-                for field in value.__class__.InertiaMeta.fields
+                field: getattr(o, field) for field in o.__class__.InertiaMeta.fields
             }
 
-        if isinstance(value, models.Model):
-            return model_to_dict(value)
+        if isinstance(o, models.Model):
+            return model_to_dict(o)
 
-        if isinstance(value, QuerySet):
+        if isinstance(o, QuerySet):
             return [
-                (model_to_dict(obj) if isinstance(value.model, models.Model) else obj)
-                for obj in value
+                (model_to_dict(obj) if isinstance(o.model, models.Model) else obj)
+                for obj in o
             ]
 
-        return super().default(value)
+        return super().default(o)
 
 
 def lazy(prop):

pyproject.toml

@@ -38,6 +38,8 @@ pytest = "^8.3.5"
 pytest-cov = "^6.0.0"
 pytest-django = "^4.10.0"
 ruff = "^0.11.2"
+django-stubs = "^5.2.1"
+basedpyright = "^1.30.1"
 
 [tool.ruff.lint]
 select = [
@@ -54,3 +56,6 @@ unfixable = ["B", "SIM"]
 [tool.pytest.ini_options]
 DJANGO_SETTINGS_MODULE = "inertia.tests.settings"
 django_find_project = false
+
+[tool.basedpyright]
+typeCheckingMode = "standard"