Merge pull request #254 from praw-dev/flair_reorder

Added support for reordering flairs through reddit.flair.reorder

CHANGES.rst

@@ -6,6 +6,13 @@ Async PRAW follows `semantic versioning <https://semver.org/>`_.
 Unreleased
 ----------
 
+**Added**
+
+- :meth:`~.SubredditLinkFlairTemplates.reorder` to reorder a subreddit's link flair
+  templates.
+- :meth:`~.SubredditRedditorFlairTemplates.reorder` to reorder a subreddit's redditor
+  flair templates.
+
 **Fixed**
 
 - XML parsing error when media uploads fail.

asyncpraw/endpoints.py

@@ -63,6 +63,7 @@
     "flairtemplate_v2":        "r/{subreddit}/api/flairtemplate_v2",
     "flairtemplateclear":      "r/{subreddit}/api/clearflairtemplates/",
     "flairtemplatedelete":     "r/{subreddit}/api/deleteflairtemplate/",
+    "flairtemplatereorder":    "r/{subreddit}/api/flair_template_order",
     "friend":                  "r/{subreddit}/api/friend/",
     "friend_v1":               "api/v1/me/friends/{user}",
     "friends":                 "api/v1/me/friends/",

asyncpraw/models/reddit/subreddit.py

@@ -2371,6 +2371,17 @@ async def delete(self, template_id: str):
         url = API_PATH["flairtemplatedelete"].format(subreddit=self.subreddit)
         await self.subreddit._reddit.post(url, data={"flair_template_id": template_id})
 
+    async def _reorder(self, flair_list: list, *, is_link: Optional[bool] = None):
+        url = API_PATH["flairtemplatereorder"].format(subreddit=self.subreddit)
+        await self.subreddit._reddit.patch(
+            url,
+            params={
+                "flair_type": self.flair_type(is_link),
+                "subreddit": self.subreddit.display_name,
+            },
+            json=flair_list,
+        )
+
     @_deprecate_args(
         "template_id",
         "text",
@@ -4400,6 +4411,22 @@ async def clear(self):
         """
         await self._clear(is_link=True)
 
+    async def reorder(self, flair_list: List[str]):
+        """Reorder a list of flairs.
+
+        :param flair_list: A list of flair IDs.
+
+        For example, to reverse the order of the link flair list try:
+
+        .. code-block:: python
+
+            subreddit = await reddit.subreddit("test")
+            flairs = [flair["id"] async for flair in subreddit.flair.link_templates]
+            await subreddit.flair.link_templates.reorder(list(reversed(flairs)))
+
+        """
+        await self._reorder(flair_list, is_link=True)
+
     async def user_selectable(
         self,
     ) -> AsyncGenerator[Dict[str, Union[str, bool]], None]:
@@ -4520,3 +4547,20 @@ async def clear(self):
 
         """
         await self._clear(is_link=False)
+
+    async def reorder(self, flair_list: List[str]):
+        """Reorder a list of flairs.
+
+        :param flair_list: A list of flair IDs.
+
+        For example, to reverse the order of the :class:`.Redditor` flair templates list
+        try:
+
+        .. code-block:: python
+
+            subreddit = reddit.subreddit("test")
+            flairs = [flair["id"] for flair in subreddit.flair.templates]
+            subreddit.flair.templates.reorder(list(reversed(flairs)))
+
+        """
+        await self._reorder(flair_list, is_link=False)

asyncpraw/reddit.py

@@ -13,6 +13,7 @@
     AsyncGenerator,
     Dict,
     Iterable,
+    List,
     Optional,
     Type,
     Union,
@@ -543,7 +544,7 @@ async def _objectify_request(
         *,
         data: Optional[Union[Dict[str, Union[str, Any]], bytes, IO, str]] = None,
         files: Optional[Dict[str, IO]] = None,
-        json: Optional[Dict[Any, Any]] = None,
+        json: Optional[Union[Dict[Any, Any], List[Any]]] = None,
         method: str = "",
         params: Optional[Union[str, Dict[str, str]]] = None,
         path: str = "",
@@ -743,7 +744,7 @@ async def delete(
         path: str,
         *,
         data: Optional[Union[Dict[str, Union[str, Any]], bytes, IO, str]] = None,
-        json: Optional[Dict[Any, Any]] = None,
+        json: Optional[Union[Dict[Any, Any], List[Any]]] = None,
         params: Optional[Union[str, Dict[str, str]]] = None,
     ) -> Any:
         """Return parsed objects returned from a DELETE request to ``path``.
@@ -870,7 +871,8 @@ async def patch(
         path: str,
         *,
         data: Optional[Union[Dict[str, Union[str, Any]], bytes, IO, str]] = None,
-        json: Optional[Dict[Any, Any]] = None,
+        json: Optional[Union[Dict[Any, Any], List[Any]]] = None,
+        params: Optional[Union[str, Dict[str, str]]] = None,
     ) -> Any:
         """Return parsed objects returned from a PATCH request to ``path``.
 
@@ -880,10 +882,11 @@ async def patch(
         :param json: JSON-serializable object to send in the body of the request with a
             Content-Type header of application/json (default: ``None``). If ``json`` is
             provided, ``data`` should not be.
+        :param params: The query parameters to add to the request (default: ``None``).
 
         """
         return await self._objectify_request(
-            data=data, json=json, method="PATCH", path=path
+            data=data, json=json, method="PATCH", params=params, path=path
         )
 
     @_deprecate_args("path", "data", "files", "params", "json")
@@ -893,7 +896,7 @@ async def post(
         *,
         data: Optional[Union[Dict[str, Union[str, Any]], bytes, IO, str]] = None,
         files: Optional[Dict[str, IO]] = None,
-        json: Optional[Dict[Any, Any]] = None,
+        json: Optional[Union[Dict[Any, Any], List[Any]]] = None,
         params: Optional[Union[str, Dict[str, str]]] = None,
     ) -> Any:
         """Return parsed objects returned from a POST request to ``path``.
@@ -941,7 +944,7 @@ async def put(
         path: str,
         *,
         data: Optional[Union[Dict[str, Union[str, Any]], bytes, IO, str]] = None,
-        json: Optional[Dict[Any, Any]] = None,
+        json: Optional[Union[Dict[Any, Any], List[Any]]] = None,
     ):
         """Return parsed objects returned from a PUT request to ``path``.
 
@@ -1006,7 +1009,7 @@ async def request(
         *,
         data: Optional[Union[Dict[str, Union[str, Any]], bytes, IO, str]] = None,
         files: Optional[Dict[str, IO]] = None,
-        json: Optional[Dict[Any, Any]] = None,
+        json: Optional[Union[Dict[Any, Any], List[Any]]] = None,
         method: str,
         params: Optional[Union[str, Dict[str, Union[str, int]]]] = None,
         path: str,