Merge pull request #220 from praw-dev/fix_notes

Fix iterating mod notes when there is more than a single page

CHANGES.rst

@@ -6,6 +6,11 @@ Async PRAW follows `semantic versioning <http://semver.org/>`_.
 Unreleased
 ----------
 
+**Fixed**
+
+- An issue with with iterating :class:`.ModNote` when a user has more than a hundred
+  notes.
+
 7.6.1 (2022/11/28)
 ------------------
 

asyncpraw/models/listing/generator.py

@@ -93,7 +93,9 @@ async def _next_batch(self):
         if not self._listing:
             raise StopAsyncIteration()
 
-        if self._listing.after and self._listing.after != self.params.get("after"):
-            self.params["after"] = self._listing.after
+        if self._listing.after and self._listing.after != self.params.get(
+            self._listing.AFTER_PARAM
+        ):
+            self.params[self._listing.AFTER_PARAM] = self._listing.after
         else:
             self._exhausted = True

asyncpraw/models/listing/listing.py

@@ -7,6 +7,7 @@
 class Listing(AsyncPRAWBase):
     """A listing is a collection of :class:`.RedditBase` instances."""
 
+    AFTER_PARAM = "after"
     CHILD_ATTRIBUTE = "children"
 
     def __len__(self) -> int:
@@ -44,6 +45,7 @@ class ModeratorListing(Listing):
 class ModNoteListing(Listing):
     """Special Listing for handling :class:`.ModNote` lists."""
 
+    AFTER_PARAM = "before"
     CHILD_ATTRIBUTE = "mod_notes"
 
     @property

tests/integration/__init__.py

@@ -42,7 +42,7 @@ def cassette_tracker(self):
                 existing_cassettes.add(cassette.replace(".json", ""))
         yield
         unused_cassettes = existing_cassettes - used_cassettes
-        if unused_cassettes:
+        if unused_cassettes and os.getenv("ensure_no_unused_cassettes", "0") == "1":
             raise AssertionError(
                 f"The following cassettes are unused: {', '.join(unused_cassettes)}."
             )

tests/integration/models/reddit/test_subreddit.py

@@ -1257,6 +1257,18 @@ async def test_notes(self, reddit):
         assert notes[1].user.name.lower() == "watchful12"
         assert notes[2] is None
 
+    async def test_notes_iterate(self, reddit):
+        reddit.read_only = False
+        subreddit = await reddit.subreddit(pytest.placeholders.test_subreddit)
+        distinct_ids = set()
+        count_notes = 0
+        async for note in subreddit.mod.notes.redditors("watchful12", limit=None):
+            distinct_ids.add(note.id)
+            count_notes += 1
+
+        assert len(distinct_ids) == 359
+        assert count_notes == 359
+
     async def test_reports(self, reddit):
         reddit.read_only = False
         count = 0