Rename API.followers_ids to API.get_follower_ids

Rename models.User.followers_ids to models.User.follower_ids
tweepy · Jun 3, 2021 · fa5e7c4 · fa5e7c4
1 parent ce768d9
commit fa5e7c4
Show file tree

Hide file tree

Showing 6 changed files with 12 additions and 11 deletions.
diff --git a/cassettes/testfollowersids.yaml → cassettes/testgetfollowerids.yaml b/cassettes/testfollowersids.yaml → cassettes/testgetfollowerids.yaml
diff --git a/docs/api.rst b/docs/api.rst
@@ -110,7 +110,7 @@
     +------------------------------------------+--------------------------------------+
     | .. centered:: |Follow, search, and get users|_                                  |
     +------------------------------------------+--------------------------------------+
-    | `GET followers/ids`_                     | :meth:`API.followers_ids`            |
+    | `GET followers/ids`_                     | :meth:`API.get_follower_ids`         |
     +------------------------------------------+--------------------------------------+
     | `GET followers/list`_                    | :meth:`API.get_followers`            |
     +------------------------------------------+--------------------------------------+
@@ -470,7 +470,7 @@ Create and manage lists
 Follow, search, and get users
 -----------------------------
 
-.. automethod:: API.followers_ids
+.. automethod:: API.get_follower_ids
 
 .. automethod:: API.get_followers
 

diff --git a/tests/test_api.py b/tests/test_api.py
@@ -166,9 +166,9 @@ def testgetfriendship(self):
     def testfriendsids(self):
         self.api.friends_ids(screen_name=username)
 
-    @tape.use_cassette('testfollowersids.yaml', serializer='yaml')
-    def testfollowersids(self):
-        self.api.followers_ids(screen_name=username)
+    @tape.use_cassette('testgetfollowerids.yaml', serializer='yaml')
+    def testgetfollowerids(self):
+        self.api.get_follower_ids(screen_name=username)
 
     @tape.use_cassette('testfriends.yaml', serializer='yaml')
     def testfriends(self):

diff --git a/tests/test_cursors.py b/tests/test_cursors.py
@@ -18,15 +18,15 @@ def testcursorcursoritems(self):
         items = list(Cursor(self.api.friends_ids).items(2))
         self.assertEqual(len(items), 2)
 
-        items = list(Cursor(self.api.followers_ids, screen_name=username).items(1))
+        items = list(Cursor(self.api.get_follower_ids, screen_name=username).items(1))
         self.assertEqual(len(items), 1)
 
     @tape.use_cassette('testcursorcursorpages.yaml', serializer='yaml')
     def testcursorcursorpages(self):
         pages = list(Cursor(self.api.friends_ids).pages(1))
         self.assertTrue(len(pages) == 1)
 
-        pages = list(Cursor(self.api.followers_ids, screen_name=username).pages(1))
+        pages = list(Cursor(self.api.get_follower_ids, screen_name=username).pages(1))
         self.assertTrue(len(pages) == 1)
 
     @tape.use_cassette('testcursorsetstartcursor.json')

diff --git a/tweepy/api.py b/tweepy/api.py
@@ -2021,8 +2021,9 @@ def update_list(self, **kwargs):
 
     @pagination(mode='cursor')
     @payload('ids')
-    def followers_ids(self, **kwargs):
-        """followers_ids(*, user_id, screen_name, cursor, stringify_ids, count)
+    def get_follower_ids(self, **kwargs):
+        """get_follower_ids(*, user_id, screen_name, cursor, stringify_ids, \
+                            count)
 
         Returns an array containing the IDs of users following the specified
         user.

diff --git a/tweepy/models.py b/tweepy/models.py
@@ -439,8 +439,8 @@ def list_subscriptions(self, *args, **kwargs):
     def lists(self, *args, **kwargs):
         return self._api.get_lists(user_id=self.id, *args, **kwargs)
 
-    def followers_ids(self, *args, **kwargs):
-        return self._api.followers_ids(user_id=self.id, *args, **kwargs)
+    def follower_ids(self, *args, **kwargs):
+        return self._api.get_follower_ids(user_id=self.id, *args, **kwargs)
 
 
 class IDModel(Model):