Move requests (required for SSR only) to an extra

Author: akx

.github/workflows/pytest.yml

@@ -22,7 +22,7 @@ jobs:
         run: |
           python -m pip install -U pip
           pip install poetry
-          poetry install
+          poetry install -E ssr
       - name: Run python tests
         run: |
           poetry run pytest

README.md

@@ -297,11 +297,14 @@ class LogoutView(auth_views.LogoutView):
         return response
 ```
 
-### SSR 
+### SSR
 
 #### Backend
 
-Enable SSR via the `INERTIA_SSR_URL` and `INERTIA_SSR_ENABLED` settings
+* Ensure `requests` is installed, so inertia-django can do SSR requests.
+  * `requests` is configured as a dependency if you install the `[ssr]` extra,
+    e.g. `inertia-django[ssr]` in your requirements.
+* Enable SSR via the `INERTIA_SSR_URL` and `INERTIA_SSR_ENABLED` settings.
 
 #### Frontend
 

inertia/http.py

@@ -2,14 +2,21 @@
 from http import HTTPStatus
 from json import dumps as json_encode
 
-import requests
 from django.http import HttpResponse
 from django.template.loader import render_to_string
 
 from .helpers import deep_transform_callables, validate_type
 from .prop_classes import DeferredProp, IgnoreOnFirstLoadProp, MergeableProp
 from .settings import settings
 
+try:
+    # Must be early-imported so tests can patch it with
+    # a mock module
+    import requests
+except ImportError:
+    requests = None
+
+
 INERTIA_REQUEST_ENCRYPT_HISTORY = "_inertia_encrypt_history"
 INERTIA_SESSION_CLEAR_HISTORY = "_inertia_clear_history"
 

inertia/tests/test_ssr.py

@@ -2,7 +2,6 @@
 from unittest.mock import Mock, patch
 
 from django.test import override_settings
-from requests.exceptions import RequestException
 
 from inertia.test import InertiaTestCase, inertia_div, inertia_page
 
@@ -66,7 +65,7 @@ def test_it_uses_inertia_if_inertia_requests_are_made(self, mock_requests):
     @patch("inertia.http.requests")
     def test_it_fallsback_on_failure(self, mock_requests):
         def uh_oh(*args, **kwargs):
-            raise RequestException()
+            raise ValueError()  # all exceptions are caught and ignored
 
         mock_response = Mock()
         mock_response.raise_for_status.side_effect = uh_oh

pyproject.toml

@@ -22,7 +22,10 @@ packages = [
 [tool.poetry.dependencies]
 python = "^3.8"
 django = ">=4"
-requests = "^2"
+requests = {version = "^2", optional = true}
+
+[tool.poetry.extras]
+ssr = ["requests"]
 
 [tool.poetry.dev-dependencies]
 pytest = "^7.1.2"