Sort praw.models.helpers.SubredditHelper.create arguments

praw-dev · Jan 15, 2022 · 3b8cd6c · 3b8cd6c
1 parent 6f13676
commit 3b8cd6c
Show file tree

Hide file tree

Showing 3 changed files with 15 additions and 13 deletions.
diff --git a/praw/models/helpers.py b/praw/models/helpers.py
@@ -327,27 +327,29 @@ def __call__(self, display_name: str) -> "praw.models.Subreddit":
 
         return Subreddit(self._reddit, display_name=display_name)
 
+    @_deprecate_args("name", "title", "link_type", "subreddit_type", "wikimode")
     def create(
         self,
         name: str,
-        title: Optional[str] = None,
+        *,
         link_type: str = "any",
         subreddit_type: str = "public",
+        title: Optional[str] = None,
         wikimode: str = "disabled",
         **other_settings: Optional[str],
     ) -> "praw.models.Subreddit":
         """Create a new :class:`.Subreddit`.
 
         :param name: The name for the new subreddit.
-        :param title: The title of the subreddit. When ``None`` or ``""`` use the value
-            of ``"name"``.
         :param link_type: The types of submissions users can make. One of ``"any"``,
             ``"link"``, or ``"self"`` (default: ``"any"``).
         :param subreddit_type: One of ``"archived"``, ``"employees_only"``,
             ``"gold_only"``, ``"gold_restricted"``, ``"private"``, ``"public"``, or
-            ``"restricted"`` (default: "public").
+            ``"restricted"`` (default: ``"public"``).
+        :param title: The title of the subreddit. When ``None`` or ``""`` use the value
+            of ``name``.
         :param wikimode: One of ``"anyone"``, ``"disabled"``, or ``"modonly"`` (default:
-            ``disabled``).
+            ``"disabled"``).
 
         Any keyword parameters not provided, or set explicitly to ``None``, will take on
         a default value assigned by the Reddit server.

diff --git a/praw/reddit.py b/praw/reddit.py
@@ -370,7 +370,7 @@ def request(self, *args, **kwargs):
 
         .. code-block:: python
 
-            reddit.subreddit.create("coolnewsubname")
+            reddit.subreddit.create(name="coolnewsubname")
 
         To obtain a lazy :class:`.Subreddit` instance run:
 

diff --git a/tests/integration/models/reddit/test_subreddit.py b/tests/integration/models/reddit/test_subreddit.py
@@ -104,10 +104,10 @@ def test_create(self, _):
         new_name = "PRAW_rrldkyrfln"
         with self.use_cassette():
             subreddit = self.reddit.subreddit.create(
-                name=new_name,
-                title="Sub",
+                new_name,
                 link_type="any",
                 subreddit_type="public",
+                title="Sub",
                 wikimode="disabled",
             )
             assert subreddit.display_name == new_name
@@ -119,9 +119,9 @@ def test_create__exists(self):
             with pytest.raises(RedditAPIException) as excinfo:
                 self.reddit.subreddit.create(
                     "redditdev",
-                    title="redditdev",
                     link_type="any",
                     subreddit_type="public",
+                    title="redditdev",
                     wikimode="disabled",
                 )
             assert excinfo.value.items[0].error_type == "SUBREDDIT_EXISTS"
@@ -132,10 +132,10 @@ def test_create__invalid_parameter(self):
             with pytest.raises(RedditAPIException) as excinfo:
                 # Supplying invalid setting for link_type
                 self.reddit.subreddit.create(
-                    name="PRAW_iavynavffv",
-                    title="sub",
+                    "PRAW_iavynavffv",
                     link_type="abcd",
                     subreddit_type="public",
+                    title="sub",
                     wikimode="disabled",
                 )
             assert excinfo.value.items[0].error_type == "INVALID_OPTION"
@@ -146,10 +146,10 @@ def test_create__missing_parameter(self):
             with pytest.raises(RedditAPIException) as excinfo:
                 # Not supplying required field title.
                 self.reddit.subreddit.create(
-                    name="PRAW_iavynavffv",
-                    title=None,
+                    "PRAW_iavynavffv",
                     link_type="any",
                     subreddit_type="public",
+                    title=None,
                     wikimode="disabled",
                 )
             assert excinfo.value.items[0].error_type == "NO_TEXT"