(#1164) Add types to listing/mixins/redditor.py

praw/models/listing/mixins/redditor.py

@@ -1,17 +1,37 @@
 """Provide the RedditorListingMixin class."""
+from typing import Any, Dict, Generator, TypeVar, Union
 from urllib.parse import urljoin
 
 from ....util.cache import cachedproperty
 from ..generator import ListingGenerator
 from .base import BaseListingMixin
 from .gilded import GildedListingMixin
 
+Reddit = TypeVar("Reddit")
+
+
+class SubListing(BaseListingMixin):
+    """Helper class for generating :class:`.ListingGenerator` objects."""
+
+    def __init__(self, reddit: Reddit, base_path: str, subpath: str):
+        """Initialize a SubListing instance.
+
+        :param reddit: An instance of :class:`.Reddit`.
+        :param base_path: The path to the object up to this point.
+        :param subpath: The additional path to this sublisting.
+
+        """
+        super().__init__(reddit, _data=None)
+        self._listing_use_sort = True
+        self._reddit = reddit
+        self._path = urljoin(base_path, subpath)
+
 
 class RedditorListingMixin(BaseListingMixin, GildedListingMixin):
     """Adds additional methods pertaining to Redditor instances."""
 
     @cachedproperty
-    def comments(self):
+    def comments(self) -> SubListing:
         r"""Provide an instance of :class:`.SubListing` for comment access.
 
         For example, to output the first line of all new comments by
@@ -26,7 +46,7 @@ def comments(self):
         return SubListing(self._reddit, self._path, "comments")
 
     @cachedproperty
-    def submissions(self):
+    def submissions(self) -> SubListing:
         """Provide an instance of :class:`.SubListing` for submission access.
 
         For example, to output the title's of top 100 of all time submissions
@@ -40,7 +60,9 @@ def submissions(self):
         """
         return SubListing(self._reddit, self._path, "submitted")
 
-    def downvoted(self, **generator_kwargs):
+    def downvoted(
+        self, **generator_kwargs: Union[str, int, Dict[str, str]]
+    ) -> Generator[Any, None, None]:
         """Return a :class:`.ListingGenerator` for items the user has downvoted.
 
         May raise ``prawcore.Forbidden`` after issuing the request if the user
@@ -56,7 +78,9 @@ def downvoted(self, **generator_kwargs):
             self._reddit, urljoin(self._path, "downvoted"), **generator_kwargs
         )
 
-    def gildings(self, **generator_kwargs):
+    def gildings(
+        self, **generator_kwargs: Union[str, int, Dict[str, str]]
+    ) -> Generator[Any, None, None]:
         """Return a :class:`.ListingGenerator` for items the user has gilded.
 
         May raise ``prawcore.Forbidden`` after issuing the request if the user
@@ -74,7 +98,9 @@ def gildings(self, **generator_kwargs):
             **generator_kwargs
         )
 
-    def hidden(self, **generator_kwargs):
+    def hidden(
+        self, **generator_kwargs: Union[str, int, Dict[str, str]]
+    ) -> Generator[Any, None, None]:
         """Return a :class:`.ListingGenerator` for items the user has hidden.
 
         May raise ``prawcore.Forbidden`` after issuing the request if the user
@@ -90,7 +116,9 @@ def hidden(self, **generator_kwargs):
             self._reddit, urljoin(self._path, "hidden"), **generator_kwargs
         )
 
-    def saved(self, **generator_kwargs):
+    def saved(
+        self, **generator_kwargs: Union[str, int, Dict[str, str]]
+    ) -> Generator[Any, None, None]:
         """Return a :class:`.ListingGenerator` for items the user has saved.
 
         May raise ``prawcore.Forbidden`` after issuing the request if the user
@@ -106,7 +134,9 @@ def saved(self, **generator_kwargs):
             self._reddit, urljoin(self._path, "saved"), **generator_kwargs
         )
 
-    def upvoted(self, **generator_kwargs):
+    def upvoted(
+        self, **generator_kwargs: Union[str, int, Dict[str, str]]
+    ) -> Generator[Any, None, None]:
         """Return a :class:`.ListingGenerator` for items the user has upvoted.
 
         May raise ``prawcore.Forbidden`` after issuing the request if the user
@@ -121,20 +151,3 @@ def upvoted(self, **generator_kwargs):
         return ListingGenerator(
             self._reddit, urljoin(self._path, "upvoted"), **generator_kwargs
         )
-
-
-class SubListing(BaseListingMixin):
-    """Helper class for generating :class:`.ListingGenerator` objects."""
-
-    def __init__(self, reddit, base_path, subpath):
-        """Initialize a SubListing instance.
-
-        :param reddit: An instance of :class:`.Reddit`.
-        :param base_path: The path to the object up to this point.
-        :param subpath: The additional path to this sublisting.
-
-        """
-        super().__init__(reddit, _data=None)
-        self._listing_use_sort = True
-        self._reddit = reddit
-        self._path = urljoin(base_path, subpath)