Switch back to "Submission" alias

Author: Electronic-Mango

README.md

@@ -132,7 +132,9 @@ ArticlesSortType.CONTROVERSIAL
 
 ### Returned articles type
 
-Returned type is a list of articles, where each article is a `dict`/`json` directly returned by official Reddit API.
+Returned type is a list of articles, where each article is a `Submission`.
+`Submission` is just an alias to `dict[str, Any]`.
+Returned data is directly representing JSON returned by official Reddit API, there are no modification to responses.
 
 You can check official Reddit API documentation for:
  * users - https://www.reddit.com/dev/api/#GET_user_{username}_submitted

redditpythonapi/reddit.py

@@ -10,6 +10,8 @@
 
 from httpx import AsyncClient, BasicAuth, Response
 
+Submission = dict[str, Any]
+
 
 class ArticlesSortType(Enum):
     """Enum with all viable sorting types"""
@@ -52,7 +54,7 @@ def __init__(
 
     async def subreddit_articles(
         self, subreddit: str, limit: int, sort: ArticlesSortType
-    ) -> list[dict[str, Any]]:
+    ) -> list[Submission]:
         """Get a list of Reddit articles from the given subreddit
 
         Args:
@@ -61,7 +63,7 @@ async def subreddit_articles(
             sort (ArticlesSortType): sort type to use when loading articles
 
         Returns:
-            list[dict[str, Any]: list of loaded articles from the given subreddit
+            list[Submission]: list of loaded articles from the given subreddit
         """
         self._logger.info(f"Loading subreddit articles [{subreddit}] [{limit}] [{sort.name}]")
         url = self._SUBREDDIT_ARTICLES_URL.format(subreddit=subreddit, sort=sort.name.lower())
@@ -70,7 +72,7 @@ async def subreddit_articles(
 
     async def user_articles(
         self, user: str, limit: int, sort: ArticlesSortType
-    ) -> list[dict[str, Any]]:
+    ) -> list[Submission]:
         """Get a list of Reddit articles from the given Reddit user
 
         Args:
@@ -79,7 +81,7 @@ async def user_articles(
             sort (ArticlesSortType): sort type to use when loading articles
 
         Returns:
-            list[dict[str, Any]: list of loaded articles from the Reddit user
+            list[Submission]: list of loaded articles from the Reddit user
         """
         self._logger.info(f"Loading user articles [{user}] [{limit}] [{sort.name}]")
         url = self._USER_ARTICLES_URL.format(user=user)
@@ -105,7 +107,7 @@ async def _request_access_token(self) -> Response:
                 headers=self._auth_headers,
             )
 
-    async def _get_articles(self, url: str, params: dict[str, Any]) -> list[dict[str, Any]]:
+    async def _get_articles(self, url: str, params: dict[str, Any]) -> list[Submission]:
         if self._access_token_expires_in <= time_ns():
             self._logger.info("Access token expired, requesting new one")
             await self._authorize()