Replace uses of Generator[T, None, None] with Iterator[T]

Author: bboe

praw/models/helpers.py

@@ -12,7 +12,7 @@
 from praw.models.reddit.multi import Multireddit, Subreddit
 
 if TYPE_CHECKING:
-    from collections.abc import Generator
+    from collections.abc import Iterator
 
     import praw.models
 
@@ -180,7 +180,7 @@ def create(
             },
         )
 
-    def info(self, ids: list[str]) -> Generator[praw.models.LiveThread, None, None]:
+    def info(self, ids: list[str]) -> Iterator[praw.models.LiveThread]:
         """Fetch information about each live thread in ``ids``.
 
         :param ids: A list of IDs for a live thread.
@@ -213,7 +213,7 @@ def info(self, ids: list[str]) -> Generator[praw.models.LiveThread, None, None]:
             msg = "ids must be a list"
             raise TypeError(msg)
 
-        def generator() -> Generator[praw.models.LiveThread, None, None]:
+        def generator() -> Iterator[praw.models.LiveThread]:
             for position in range(0, len(ids), 100):
                 ids_chunk = ids[position : position + 100]
                 url = API_PATH["live_info"].format(ids=",".join(ids_chunk))

praw/models/mod_notes.py

@@ -12,7 +12,7 @@
 from praw.models.reddit.submission import Submission
 
 if TYPE_CHECKING:
-    from collections.abc import Generator
+    from collections.abc import Iterator
 
     import praw.models
     from praw.models.reddit.redditor import Redditor
@@ -49,7 +49,7 @@ def _all_generator(
 
     def _bulk_generator(
         self, redditors: list[Redditor | str], subreddits: list[Subreddit | str]
-    ) -> Generator[praw.models.ModNote, None, None]:
+    ) -> Iterator[praw.models.ModNote]:
         subreddits_iter = iter(subreddits)
         redditors_iter = iter(redditors)
         while True:
@@ -79,7 +79,7 @@ def _notes(
         redditors: list[Redditor | str],
         subreddits: list[Subreddit | str],
         **generator_kwargs: Any,
-    ) -> Generator[praw.models.ModNote, None, None]:
+    ) -> Iterator[praw.models.ModNote]:
         if all_notes:
             for subreddit in subreddits:
                 for redditor in redditors:
@@ -304,7 +304,7 @@ def subreddits(
         *subreddits: Subreddit | str,
         all_notes: bool | None = None,
         **generator_kwargs: Any,
-    ) -> Generator[praw.models.ModNote, None, None]:
+    ) -> Iterator[praw.models.ModNote]:
         """Return notes for this :class:`.Redditor` from one or more subreddits.
 
         :param subreddits: One or more subreddits to retrieve the notes from. Must be
@@ -400,7 +400,7 @@ def redditors(
         *redditors: Redditor | str,
         all_notes: bool | None = None,
         **generator_kwargs: Any,
-    ) -> Generator[praw.models.ModNote, None, None]:
+    ) -> Iterator[praw.models.ModNote]:
         """Return notes from this :class:`.Subreddit` for one or more redditors.
 
         :param redditors: One or more redditors to retrieve notes for. Must be either a
@@ -494,7 +494,7 @@ def __call__(
         subreddits: list[Subreddit | str] | None = None,
         things: list[Comment | Submission] | None = None,
         **generator_kwargs: Any,
-    ) -> Generator[praw.models.ModNote, None, None]:
+    ) -> Iterator[praw.models.ModNote]:
         """Get note(s) for each subreddit/user pair, or ``None`` if they don't have any.
 
         :param all_notes: Whether to return all notes or only the latest note for each
@@ -636,7 +636,7 @@ def things(
         *things: Comment | Submission,
         all_notes: bool | None = None,
         **generator_kwargs: Any,
-    ) -> Generator[praw.models.ModNote, None, None]:
+    ) -> Iterator[praw.models.ModNote]:
         """Return notes associated with the author of a :class:`.Comment` or :class:`.Submission`.
 
         :param things: One or more things to return notes on. Must be a

praw/models/reddit/collections.py

@@ -13,7 +13,7 @@
 from praw.util.cache import cachedproperty
 
 if TYPE_CHECKING:
-    from collections.abc import Generator, Iterator
+    from collections.abc import Iterator
 
     import praw.models
 
@@ -359,7 +359,7 @@ def __init__(
         super().__init__(reddit, _data)
         self.subreddit = subreddit
 
-    def __iter__(self) -> Generator[Collection, None, None]:
+    def __iter__(self) -> Iterator[Collection]:
         r"""Iterate over the :class:`.Subreddit`'s :class:`.Collection`\ s.
 
         Example usage:

praw/models/reddit/mixins/modnote.py

@@ -5,15 +5,15 @@
 from typing import TYPE_CHECKING, Any
 
 if TYPE_CHECKING:
-    from collections.abc import Generator
+    from collections.abc import Iterator
 
     import praw.models
 
 
 class ModNoteMixin:
     """Interface for classes that can have a moderator note set on them."""
 
-    def author_notes(self, **generator_kwargs: Any) -> Generator[praw.models.ModNote, None, None]:
+    def author_notes(self, **generator_kwargs: Any) -> Iterator[praw.models.ModNote]:
         """Get the moderator notes for the author of this object in the subreddit it's posted in.
 
         :param generator_kwargs: Additional keyword arguments are passed in the

praw/models/reddit/redditor.py

@@ -13,7 +13,7 @@
 from praw.util.cache import cachedproperty
 
 if TYPE_CHECKING:
-    from collections.abc import Generator
+    from collections.abc import Iterator
 
     import praw.models
 
@@ -420,7 +420,7 @@ def __init__(self, redditor: praw.models.Redditor) -> None:
         """
         self.redditor = redditor
 
-    def comments(self, **stream_options: str | int | dict[str, str]) -> Generator[praw.models.Comment, None, None]:
+    def comments(self, **stream_options: str | int | dict[str, str]) -> Iterator[praw.models.Comment]:
         """Yield new comments as they become available.
 
         Comments are yielded oldest first. Up to 100 historical comments will initially
@@ -438,9 +438,7 @@ def comments(self, **stream_options: str | int | dict[str, str]) -> Generator[pr
         """
         return stream_generator(self.redditor.comments.new, **stream_options)
 
-    def submissions(
-        self, **stream_options: str | int | dict[str, str]
-    ) -> Generator[praw.models.Submission, None, None]:
+    def submissions(self, **stream_options: str | int | dict[str, str]) -> Iterator[praw.models.Submission]:
         """Yield new submissions as they become available.
 
         Submissions are yielded oldest first. Up to 100 historical submissions will

praw/models/reddit/submission.py

@@ -23,7 +23,7 @@
 from praw.util import cachedproperty
 
 if TYPE_CHECKING:
-    from collections.abc import Generator
+    from collections.abc import Iterator
 
     import praw.models
 
@@ -621,7 +621,7 @@ def _chunk(
         *,
         chunk_size: int,
         other_submissions: list[praw.models.Submission] | None,
-    ) -> Generator[str, None, None]:
+    ) -> Iterator[str]:
         all_submissions = [self.fullname]
         if other_submissions:
             all_submissions += [x.fullname for x in other_submissions]

praw/models/reddit/subreddit.py

@@ -224,7 +224,7 @@ def create(
         }
         return self.subreddit._reddit.post(API_PATH["modmail_conversations"], data=data)
 
-    def subreddits(self) -> Generator[praw.models.Subreddit, None, None]:
+    def subreddits(self) -> Iterator[praw.models.Subreddit]:
         """Yield subreddits using the new modmail that the user moderates.
 
         For example:
@@ -284,7 +284,7 @@ def __init__(self, subreddit: praw.models.Subreddit) -> None:
         """
         self.subreddit = subreddit
 
-    def __iter__(self) -> Generator[praw.models.Subreddit, None, None]:
+    def __iter__(self) -> Iterator[praw.models.Subreddit]:
         """Iterate through the special :class:`.Subreddit`'s filters.
 
         This method should be invoked as:
@@ -597,7 +597,7 @@ def __init__(self, subreddit: praw.models.Subreddit) -> None:
         """
         self.subreddit = subreddit
 
-    def __iter__(self) -> Generator[None, None, None]:
+    def __iter__(self) -> Iterator[None]:
         """Abstract method to return flair templates."""
         raise NotImplementedError
 
@@ -1112,7 +1112,7 @@ def __init__(self, subreddit: praw.models.Subreddit) -> None:
 
     def edited(
         self, *, only: str | None = None, **stream_options: Any
-    ) -> Generator[praw.models.Comment | praw.models.Submission, None, None]:
+    ) -> Iterator[praw.models.Comment | praw.models.Submission]:
         """Yield edited comments and submissions as they become available.
 
         :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
@@ -1137,7 +1137,7 @@ def log(
         action: str | None = None,
         mod: str | praw.models.Redditor | None = None,
         **stream_options: Any,
-    ) -> Generator[praw.models.ModAction, None, None]:
+    ) -> Iterator[praw.models.ModAction]:
         """Yield moderator log entries as they become available.
 
         :param action: If given, only return log entries for the specified action.
@@ -1168,7 +1168,7 @@ def modmail_conversations(
         sort: str | None = None,
         state: str | None = None,
         **stream_options: Any,
-    ) -> Generator[ModmailConversation, None, None]:
+    ) -> Iterator[ModmailConversation]:
         """Yield new-modmail conversations as they become available.
 
         :param other_subreddits: A list of :class:`.Subreddit` instances for which to
@@ -1206,7 +1206,7 @@ def modmail_conversations(
 
     def modqueue(
         self, *, only: str | None = None, **stream_options: Any
-    ) -> Generator[praw.models.Comment | praw.models.Submission, None, None]:
+    ) -> Iterator[praw.models.Comment | praw.models.Submission]:
         r"""Yield :class:`.Comment`\ s and :class:`.Submission`\ s in the modqueue as they become available.
 
         :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
@@ -1226,7 +1226,7 @@ def modqueue(
 
     def reports(
         self, *, only: str | None = None, **stream_options: Any
-    ) -> Generator[praw.models.Comment | praw.models.Submission, None, None]:
+    ) -> Iterator[praw.models.Comment | praw.models.Submission]:
         r"""Yield reported :class:`.Comment`\ s and :class:`.Submission`\ s as they become available.
 
         :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
@@ -1246,7 +1246,7 @@ def reports(
 
     def spam(
         self, *, only: str | None = None, **stream_options: Any
-    ) -> Generator[praw.models.Comment | praw.models.Submission, None, None]:
+    ) -> Iterator[praw.models.Comment | praw.models.Submission]:
         r"""Yield spam :class:`.Comment`\ s and :class:`.Submission`\ s as they become available.
 
         :param only: If specified, one of ``"comments"`` or ``"submissions"`` to yield
@@ -1264,7 +1264,7 @@ def spam(
         """
         return stream_generator(self.subreddit.mod.spam, only=only, **stream_options)
 
-    def unmoderated(self, **stream_options: Any) -> Generator[praw.models.Submission, None, None]:
+    def unmoderated(self, **stream_options: Any) -> Iterator[praw.models.Submission]:
         r"""Yield unmoderated :class:`.Submission`\ s as they become available.
 
         Keyword arguments are passed to :func:`.stream_generator`.
@@ -1413,7 +1413,7 @@ def __init__(self, subreddit: praw.models.Subreddit) -> None:
         """
         self.subreddit = subreddit
 
-    def comments(self, **stream_options: Any) -> Generator[praw.models.Comment, None, None]:
+    def comments(self, **stream_options: Any) -> Iterator[praw.models.Comment]:
         """Yield new comments as they become available.
 
         Comments are yielded oldest first. Up to 100 historical comments will initially
@@ -1445,7 +1445,7 @@ def comments(self, **stream_options: Any) -> Generator[praw.models.Comment, None
         """
         return stream_generator(self.subreddit.comments, **stream_options)
 
-    def submissions(self, **stream_options: Any) -> Generator[praw.models.Submission, None, None]:
+    def submissions(self, **stream_options: Any) -> Iterator[praw.models.Submission]:
         r"""Yield new :class:`.Submission`\ s as they become available.
 
         Submissions are yielded oldest first. Up to 100 historical submissions will
@@ -1925,7 +1925,7 @@ def __init__(self, subreddit: praw.models.Subreddit) -> None:
         self.contributor = SubredditRelationship(subreddit, "wikicontributor")
         self.subreddit = subreddit
 
-    def __iter__(self) -> Generator[WikiPage, None, None]:
+    def __iter__(self) -> Iterator[WikiPage]:
         """Iterate through the pages of the wiki.
 
         This method is to be used to discover all wikipages for a subreddit:
@@ -3661,7 +3661,7 @@ class SubredditLinkFlairTemplates(SubredditFlairTemplates):
 
     def __iter__(
         self,
-    ) -> Generator[dict[str, str | int | bool | list[dict[str, str]]], None, None]:
+    ) -> Iterator[dict[str, str | int | bool | list[dict[str, str]]]]:
         """Iterate through the link flair templates as a moderator.
 
         For example:
@@ -3758,7 +3758,7 @@ def reorder(self, flair_list: list[str]) -> None:
 
     def user_selectable(
         self,
-    ) -> Generator[dict[str, str | bool], None, None]:
+    ) -> Iterator[dict[str, str | bool]]:
         """Iterate through the link flair templates as a regular user.
 
         For example:
@@ -3778,7 +3778,7 @@ class SubredditRedditorFlairTemplates(SubredditFlairTemplates):
 
     def __iter__(
         self,
-    ) -> Generator[dict[str, str | int | bool | list[dict[str, str]]], None, None]:
+    ) -> Iterator[dict[str, str | int | bool | list[dict[str, str]]]]:
         """Iterate through the user flair templates.
 
         For example:

praw/models/reddit/wikipage.py

@@ -11,7 +11,7 @@
 from praw.util.cache import cachedproperty
 
 if TYPE_CHECKING:
-    from collections.abc import Generator, Iterator
+    from collections.abc import Iterator
 
     import praw.models
 
@@ -174,7 +174,7 @@ def _revision_generator(
         generator_kwargs: dict[str, Any],
         subreddit: praw.models.Subreddit,
         url: str,
-    ) -> Generator[dict[str, Redditor | WikiPage | str | int | bool | None], None, None]:
+    ) -> Iterator[dict[str, Redditor | WikiPage | str | int | bool | None]]:
         for revision in ListingGenerator(subreddit._reddit, url, **generator_kwargs):
             if revision["author"] is not None:
                 revision["author"] = Redditor(subreddit._reddit, _data=revision["author"]["data"])
@@ -289,7 +289,7 @@ def revision(self, revision: str) -> WikiPage:
         """
         return WikiPage(self.subreddit._reddit, self.subreddit, self.name, revision)
 
-    def revisions(self, **generator_kwargs: str | int | dict[str, str]) -> Generator[WikiPage, None, None]:
+    def revisions(self, **generator_kwargs: str | int | dict[str, str]) -> Iterator[WikiPage]:
         """Return a :class:`.ListingGenerator` for page revisions.
 
         Additional keyword arguments are passed in the initialization of

praw/models/util.py

@@ -8,7 +8,7 @@
 from typing import TYPE_CHECKING, Any, Callable
 
 if TYPE_CHECKING:
-    from collections.abc import Generator
+    from collections.abc import Iterator
 
 
 def permissions_string(*, known_permissions: set[str], permissions: list[str] | None) -> str:
@@ -42,7 +42,7 @@ def stream_generator(
     pause_after: int | None = None,
     skip_existing: bool = False,
     **function_kwargs: Any,
-) -> Generator[Any, None, None]:
+) -> Iterator[Any]:
     """Yield new items from ``function`` as they become available.
 
     :param function: A callable that returns a :class:`.ListingGenerator`, e.g.,