refactor: First migration attempt from requests to httpx.

Author: bvanelli

actual/__init__.py

@@ -147,6 +147,7 @@ def __exit__(self, exc_type, exc_val, exc_tb):
             self._session.close()
         if self.engine:
             self.engine.dispose()
+        self._requests_session.close()
         self._in_context = False
 
     @property

actual/api/__init__.py

@@ -4,7 +4,7 @@
 import json
 from typing import Literal
 
-import requests
+import httpx
 
 from actual.api.models import (
     BankSyncAccountResponseDTO,
@@ -65,11 +65,12 @@ def __init__(
         """
         self.api_url: str = base_url
         self._token: str | None = token
-        self._requests_session: requests.Session = requests.Session()
-        if extra_headers:
-            self._requests_session.headers = extra_headers
-        if cert is not None:
-            self._requests_session.verify = cert
+        _verify = cert if cert is not None else True
+        self._requests_session: httpx.Client = httpx.Client(
+            headers=extra_headers,
+            verify=_verify,
+        )
+        self._requests_session.verify = _verify
         if token is None and password is None and not self.is_open_id_owner_created():
             raise ValueError("Either provide a valid token or a password.")
         # already try to log-in if password was provided
@@ -231,7 +232,7 @@ def upload_user_file(
             base_headers["X-ACTUAL-ENCRYPT-META"] = json.dumps(encryption_meta)
         request = self._requests_session.post(
             f"{self.api_url}/{Endpoints.UPLOAD_USER_FILE}",
-            data=binary_data,
+            content=binary_data,
             headers=self.headers(extra_headers=base_headers),
         )
         request.raise_for_status()
@@ -315,7 +316,7 @@ def sync_sync(self, request: SyncRequest) -> SyncResponse:
         response = self._requests_session.post(
             f"{self.api_url}/{Endpoints.SYNC}",
             headers=self.headers(request.fileId, extra_headers={"Content-Type": "application/actual-sync"}),
-            data=SyncRequest.serialize(request),
+            content=SyncRequest.serialize(request),
         )
         response.raise_for_status()
         parsed_response = SyncResponse.deserialize(response.content)
@@ -339,7 +340,9 @@ def is_open_id_owner_created(self) -> bool:
     def open_id_config(self, password: str) -> OpenIDConfigResponseDTO:
         """Gets the OpenID configuration for the server. You will need to provide the main password to access this
         config."""
-        response = self._requests_session.post(f"{self.api_url}/{Endpoints.OPEN_ID_CONFIG}", {"password": password})
+        response = self._requests_session.post(
+            f"{self.api_url}/{Endpoints.OPEN_ID_CONFIG}", json={"password": password}
+        )
         response.raise_for_status()
         return OpenIDConfigResponseDTO.model_validate(response.json())
 
@@ -366,7 +369,7 @@ def create_open_id_user(
             "owner": owner,
             "role": role,
         }
-        response = self._requests_session.post(f"{self.api_url}/{Endpoints.OPEN_ID_USERS}", payload)
+        response = self._requests_session.post(f"{self.api_url}/{Endpoints.OPEN_ID_USERS}", json=payload)
         response.raise_for_status()
         model_response = OpenIDUserDTO.model_validate(payload)
         # fill entity since the endpoint does not return a DTO
@@ -401,7 +404,7 @@ def update_open_id_user(
         elif user.role is None:
             user.role = "BASIC"  # seems like a bug from actual
         response = self._requests_session.patch(
-            f"{self.api_url}/{Endpoints.OPEN_ID_USERS}", user.model_dump(by_alias=True)
+            f"{self.api_url}/{Endpoints.OPEN_ID_USERS}", json=user.model_dump(by_alias=True)
         )
         response.raise_for_status()
         return user

actual/exceptions.py

@@ -1,7 +1,7 @@
-import requests
+import httpx
 
 
-def get_exception_from_response(response: requests.Response) -> Exception:
+def get_exception_from_response(response: httpx.Response) -> Exception:
     text = response.content.decode()
     if text == "internal-error" or response.status_code == 500:
         return ActualError(text)

pyproject.toml

@@ -11,7 +11,7 @@ authors = [
 ]
 requires-python = ">=3.10.0"
 dependencies = [
-    "requests>=2",
+    "httpx>=0.27",
     "sqlmodel>=0.0.18",
     "pydantic>=2,<3",
     "sqlalchemy>=2",

tests/test_api.py

@@ -2,7 +2,7 @@
 from unittest.mock import patch
 
 import pytest
-from requests import Session
+from httpx import Client
 
 from actual import Actual, reflect_model
 from actual.api import ListUserFilesDTO
@@ -41,7 +41,7 @@ def test_rename_delete_budget_without_file(login_mocks):
         actual.rename_budget("foo")
 
 
-@patch.object(Session, "post", return_value=RequestsMock({"status": "error", "reason": "proxy-not-trusted"}))
+@patch.object(Client, "post", return_value=RequestsMock({"status": "error", "reason": "proxy-not-trusted"}))
 def test_api_login_unknown_error(_post, login_mocks):
     actual = Actual(token="foo")
     actual.api_url = "localhost"
@@ -50,7 +50,7 @@ def test_api_login_unknown_error(_post, login_mocks):
         actual.login("foo")
 
 
-@patch.object(Session, "post", return_value=RequestsMock({}, status_code=403))
+@patch.object(Client, "post", return_value=RequestsMock({}, status_code=403))
 def test_api_login_http_error(_post, login_mocks):
     actual = Actual(token="foo")
     actual.api_url = "localhost"

tests/test_bank_sync.py

@@ -3,7 +3,7 @@
 import decimal
 
 import pytest
-from requests import Session
+from httpx import Client
 
 from actual import Actual, ActualBankSyncError
 from actual.api.bank_sync import TransactionItem
@@ -91,8 +91,8 @@ def generate_bank_sync_data(mocker, starting_balance: int | None = None):
         response_full["startingBalance"] = starting_balance
     response_empty = copy.deepcopy(response)
     response_empty["transactions"]["all"] = []
-    mocker.patch.object(Session, "get").return_value = RequestsMock({"status": "ok", "data": {"validated": True}})
-    main_mock = mocker.patch.object(Session, "post")
+    mocker.patch.object(Client, "get").return_value = RequestsMock({"status": "ok", "data": {"validated": True}})
+    main_mock = mocker.patch.object(Client, "post")
     main_mock.side_effect = [
         RequestsMock({"status": "ok", "data": {"configured": True}}),
         RequestsMock({"status": "ok", "data": response_full}),
@@ -187,8 +187,8 @@ def test_bank_sync_with_starting_balance(session, bank_sync_data_no_match):
 
 
 def test_bank_sync_unconfigured(mocker, session):
-    mocker.patch.object(Session, "get").return_value = RequestsMock({"status": "ok", "data": {"validated": True}})
-    main_mock = mocker.patch.object(Session, "post")
+    mocker.patch.object(Client, "get").return_value = RequestsMock({"status": "ok", "data": {"validated": True}})
+    main_mock = mocker.patch.object(Client, "post")
     main_mock.return_value = RequestsMock({"status": "ok", "data": {"configured": False}})
 
     with Actual(token="foo") as actual:
@@ -198,8 +198,8 @@ def test_bank_sync_unconfigured(mocker, session):
 
 
 def test_bank_sync_exception(session, mocker):
-    mocker.patch.object(Session, "get").return_value = RequestsMock({"status": "ok", "data": {"validated": True}})
-    main_mock = mocker.patch.object(Session, "post")
+    mocker.patch.object(Client, "get").return_value = RequestsMock({"status": "ok", "data": {"validated": True}})
+    main_mock = mocker.patch.object(Client, "post")
     main_mock.side_effect = [
         RequestsMock({"status": "ok", "data": {"configured": True}}),
         RequestsMock({"status": "ok", "data": fail_response}),

tests/test_integration.py

@@ -163,11 +163,11 @@ def test_reset_password(actual_server):
         actual.reset_password("mynewpass")
         response = actual.list_user_files()
         assert len(response.data) == 1
-    with Actual(f"http://localhost:{port}", password="mynewpass"):
-        assert len(actual.list_user_files().data) == 1
+    with Actual(f"http://localhost:{port}", password="mynewpass") as actual2:
+        assert len(actual2.list_user_files().data) == 1
         with pytest.raises(AuthorizationError):
             # login with old password should fail
-            actual.login("mypass")
+            actual2.login("mypass")
 
 
 def test_models(actual_server):

tests/test_openid.py

@@ -1,8 +1,9 @@
 import threading
 import time
 
+import httpx
 import pytest
-from requests import Session, get
+from httpx import Client
 from testcontainers.core.container import DockerContainer
 from testcontainers.core.waiting_utils import wait_for_logs
 
@@ -44,7 +45,7 @@ def test_openid_endpoints(actual_server, mocker):
         assert len(permissions) == 1
         assert all(user.owner is False for user in permissions)
         # Delete user does not work due to some internal exception (when not set), so we mock the response for now
-        mocker.patch.object(Session, "delete").return_value = RequestsMock(
+        mocker.patch.object(Client, "delete").return_value = RequestsMock(
             {"status": "ok", "data": {"someDeletionsFailed": False}}
         )
         actual.delete_open_id_user(user.id)
@@ -55,7 +56,7 @@ def _threading_call(url: str):
         # This thread will do the interaction of the user logging in via browser
         # We just wait a second then call the endpoint passing the token from the open id callback to the API
         time.sleep(1)
-        get(url, params={"token": "mytoken"})
+        httpx.get(url, params={"token": "mytoken"})
 
     def _login_fn(_url: str, json: dict):
         assert "returnUrl" in json
@@ -66,7 +67,7 @@ def _login_fn(_url: str, json: dict):
     mocker.patch.object(Actual, "validate")
     mocker.patch.object(Actual, "is_open_id_owner_created", return_value=True)
     mocker.patch.object(Actual, "needs_bootstrap", return_value=True)
-    mocker.patch.object(Session, "post").side_effect = _login_fn
+    mocker.patch.object(Client, "post").side_effect = _login_fn
 
     # If the handshake is successful, the token would be set
     with Actual("http://localhost:123") as actual: