Merge pull request #285 from praw-dev/delayed-session-support

Support delayed session creation

Author: LilSpazJoekp

CHANGES.rst

@@ -9,6 +9,7 @@ Unreleased
 **Added**
 
 - Add support for Python 3.13.
+- Support delayed session creation in asyncprawcore 2.5.0+.
 
 **Changed**
 

asyncpraw/models/reddit/emoji.py

@@ -213,8 +213,9 @@ async def add(
         # TODO(@LilSpazJoekp): This is a blocking operation. It should be made async.
         with file.open("rb") as image:  # noqa: ASYNC230
             upload_data["file"] = image
-            response = await self._reddit._core._requestor._http.post(upload_url, data=upload_data)
-        response.raise_for_status()
+            async with self._reddit._core._requestor.request("POST", upload_url, data=upload_data
+            ) as response:
+                response.raise_for_status()
 
         data = {
             "mod_flair_only": mod_flair_only,

asyncpraw/models/reddit/subreddit.py

@@ -4,12 +4,13 @@
 
 import contextlib
 from asyncio import TimeoutError as AsyncTimeoutError
+from contextlib import asynccontextmanager
 from copy import deepcopy
 from csv import writer
 from io import StringIO
 from json import dumps
 from pathlib import Path
-from typing import TYPE_CHECKING, Any
+from typing import TYPE_CHECKING, Any, AsyncGenerator
 from urllib.parse import urljoin
 
 from aiohttp.http_exceptions import HttpProcessingError
@@ -3012,10 +3013,15 @@ async def _fetch(self):
     def _fetch_info(self):
         return "subreddit_about", {"subreddit": self}, None
 
-    async def _read_and_post_media(self, file: Path, upload_url: str, upload_data: dict[str, Any]) -> ClientResponse:
+    @asynccontextmanager
+    async def _read_and_post_media(
+        self, file: Path, upload_url: str, upload_data: dict[str, Any]
+    ) -> AsyncGenerator[ClientResponse]:
         with file.open("rb") as media:
             upload_data["file"] = media
-            return await self._reddit._core._requestor._http.post(upload_url, data=upload_data)
+            async with self._reddit._core._requestor.request("POST", upload_url, data=upload_data
+            ) as response:
+                yield response
 
     async def _submit_media(
         self, *, data: dict[Any, Any], timeout: int, without_websockets: bool
@@ -3107,13 +3113,13 @@ async def _upload_media(
         upload_url = f"https:{upload_lease['action']}"
         upload_data = {item["name"]: item["value"] for item in upload_lease["fields"]}
 
-        response = await self._read_and_post_media(file, upload_url, upload_data)
-        if response.status != 201:
-            await self._parse_xml_response(response)
-        try:
-            response.raise_for_status()
-        except HttpProcessingError:
-            raise ServerError(response=response) from None
+        async with self._read_and_post_media(file, upload_url, upload_data) as response:
+            if response.status != 201:
+                await self._parse_xml_response(response)
+            try:
+                response.raise_for_status()
+            except HttpProcessingError:
+                raise ServerError(response=response) from None
 
         if upload_type == "link":
             return f"{upload_url}/{upload_data['key']}"

asyncpraw/models/reddit/widgets.py

@@ -1876,7 +1876,8 @@ async def upload_image(self, file_path: str) -> str:
         # TODO(@LilSpazJoekp): This is a blocking operation. It should be made async.
         with file.open("rb") as image:  # noqa: ASYNC230
             upload_data["file"] = image
-            response = await self._reddit._core._requestor._http.post(upload_url, data=upload_data)
-        response.raise_for_status()
+            async with self._reddit._core._requestor.request("POST", upload_url, data=upload_data
+            ) as response:
+                response.raise_for_status()
 
         return f"{upload_url}/{upload_data['key']}"

pyproject.toml

@@ -24,7 +24,7 @@ dependencies = [
   "aiofiles",
   "aiohttp <4",
   "aiosqlite <=0.17.0",
-  "asyncprawcore >=2.4, <3",
+  "asyncprawcore >=3.0.1, <4",
   "defusedxml ==0.7.1",
   "update_checker >=0.18"
 ]
@@ -54,7 +54,6 @@ readthedocs = [
   "sphinxcontrib-trio"
 ]
 test = [
-  "mock ==4.*",
   "pytest ==7.*",
   "pytest-asyncio ==0.18.*",
   "pytest-vcr ==1.*",

tests/integration/__init__.py

@@ -90,14 +90,14 @@ def cassette_name(self, request, vcr_cassette_name):
         return marker.args[0]
 
     @pytest.fixture
-    async def reddit(self, vcr, event_loop: asyncio.AbstractEventLoop):
+    async def reddit(self, vcr):
         """Configure Reddit."""
         reddit_kwargs = {
             "client_id": pytest.placeholders.client_id,
             "client_secret": pytest.placeholders.client_secret,
             "requestor_kwargs": {
                 "session": aiohttp.ClientSession(
-                    loop=event_loop, headers={"Accept-Encoding": "identity"}
+                    headers={"Accept-Encoding": "identity"}
                 )
             },
             "user_agent": pytest.placeholders.user_agent,

tests/integration/models/reddit/test_subreddit.py

@@ -2,6 +2,7 @@
 
 import socket
 from asyncio import TimeoutError
+from contextlib import asynccontextmanager
 
 import pytest
 from aiohttp import ClientResponse
@@ -1585,18 +1586,20 @@ async def test_submit_image__large(self, reddit, tmp_path):
             "<HostId>iYEVOuRfbLiKwMgHt2ewqQRIm0NWL79uiC2rPLj9P0PwW55MhjY2/O8d9JdKTf1iwzLjwWMnGQ=</HostId>"
             "</Error>"
         )
-        _post = reddit._core._requestor._http.post
+        _request = reddit._core._requestor.request
 
-        async def patch_request(url, *args, **kwargs):
+        def patch_request(method, url, *args, **kwargs):
             """Patch requests to return mock data on specific url."""
             if "https://reddit-uploaded-media.s3-accelerate.amazonaws.com" in url:
-                response = ClientResponse
-                response.text = AsyncMock(return_value=mock_data)
+                response = MagicMock(spec=ClientResponse)
+                response.__aenter__.return_value.text = AsyncMock(
+                    return_value=mock_data
+                )
                 response.status = 400
                 return response
-            return await _post(url, *args, **kwargs)
+            return _request(method, url, *args, **kwargs)
 
-        reddit._core._requestor._http.post = patch_request
+        reddit._core._requestor.request = patch_request
 
         fake_png = PNG_HEADER + b"\x1a" * 10  # Normally 1024 ** 2 * 20 (20 MB)
         with open(tmp_path.joinpath("fake_img.png"), "wb") as tempfile:

tests/unit/models/reddit/test_subreddit.py

@@ -6,6 +6,8 @@
 from unittest import mock
 from unittest.mock import AsyncMock, MagicMock
 
+from aiohttp import ClientResponse
+
 from asyncpraw.exceptions import ClientException, MediaPostFailed
 from asyncpraw.models import InlineGif, InlineImage, InlineVideo, Subreddit, WikiPage
 from asyncpraw.models.reddit.subreddit import SubredditFlairTemplates
@@ -97,12 +99,12 @@ async def test_media_upload_500(self, mock_method, reddit):
         from aiohttp.http_exceptions import HttpProcessingError
         from asyncprawcore.exceptions import ServerError
 
-        response = MagicMock()
-        response.status = 201
+        response = MagicMock(spec=ClientResponse)
         response.raise_for_status = MagicMock(
             side_effect=HttpProcessingError(code=500, message="")
         )
-        mock_method.return_value = response
+        response.status = 201
+        mock_method.return_value.__aenter__.return_value = response
         with pytest.raises(ServerError):
             await Subreddit(reddit, display_name="test").submit_image(
                 "Test", "/dev/null"

tests/unit/test_reddit.py

@@ -1,5 +1,4 @@
 import configparser
-import sys
 import types
 
 import pytest
@@ -17,6 +16,15 @@
 from . import UnitTest
 
 
+class MockClientSession:
+    def __init__(self, *args, **kwargs):
+        self.closed = False
+        self.headers = {}
+
+    async def close(self):
+        self.closed = True
+
+
 class TestReddit(UnitTest):
     REQUIRED_DUMMY_SETTINGS = {
         x: "dummy" for x in ["client_id", "client_secret", "user_agent"]
@@ -37,8 +45,10 @@ async def test_check_for_updates_update_checker_missing(self, mock_update_check)
         assert not mock_update_check.called
 
     async def test_close_session(self):
-        temp_reddit = Reddit(**self.REQUIRED_DUMMY_SETTINGS)
-        assert not temp_reddit.requestor._http.closed
+        temp_reddit = Reddit(
+            **self.REQUIRED_DUMMY_SETTINGS,
+            requestor_kwargs={"session": MockClientSession()},
+        )
         async with temp_reddit as reddit:
             pass
         assert reddit.requestor._http.closed and temp_reddit.requestor._http.closed
@@ -47,7 +57,10 @@ def test_comment(self, reddit):
         assert Comment(reddit, id="cklfmye").id == "cklfmye"
 
     async def test_context_manager(self):
-        async with Reddit(**self.REQUIRED_DUMMY_SETTINGS) as reddit:
+        async with Reddit(
+            **self.REQUIRED_DUMMY_SETTINGS,
+            requestor_kwargs={"session": MockClientSession()},
+        ) as reddit:
             assert not reddit.requestor._http.closed
         assert reddit.requestor._http.closed