Rename API.friends to API.get_friends

tweepy · Jun 3, 2021 · 6f3fccb · 6f3fccb
1 parent fa5e7c4
commit 6f3fccb
Show file tree

Hide file tree

Showing 5 changed files with 9 additions and 9 deletions.
diff --git a/cassettes/testfriends.yaml → cassettes/testgetfriends.yaml b/cassettes/testfriends.yaml → cassettes/testgetfriends.yaml
diff --git a/docs/api.rst b/docs/api.rst
@@ -116,7 +116,7 @@
     +------------------------------------------+--------------------------------------+
     | `GET friends/ids`_                       | :meth:`API.friends_ids`              |
     +------------------------------------------+--------------------------------------+
-    | `GET friends/list`_                      | :meth:`API.friends`                  |
+    | `GET friends/list`_                      | :meth:`API.get_friends`              |
     +------------------------------------------+--------------------------------------+
     | `GET friendships/incoming`_              | :meth:`API.incoming_friendships`     |
     +------------------------------------------+--------------------------------------+
@@ -476,7 +476,7 @@ Follow, search, and get users
 
 .. automethod:: API.friends_ids
 
-.. automethod:: API.friends
+.. automethod:: API.get_friends
 
 .. automethod:: API.incoming_friendships
 

diff --git a/tests/test_api.py b/tests/test_api.py
@@ -170,9 +170,9 @@ def testfriendsids(self):
     def testgetfollowerids(self):
         self.api.get_follower_ids(screen_name=username)
 
-    @tape.use_cassette('testfriends.yaml', serializer='yaml')
-    def testfriends(self):
-        self.api.friends(screen_name=username)
+    @tape.use_cassette('testgetfriends.yaml', serializer='yaml')
+    def testgetfriends(self):
+        self.api.get_friends(screen_name=username)
 
     @tape.use_cassette('testgetfollowers.yaml', serializer='yaml')
     def testgetfollowers(self):

diff --git a/tweepy/api.py b/tweepy/api.py
@@ -2132,9 +2132,9 @@ def friends_ids(self, **kwargs):
 
     @pagination(mode='cursor')
     @payload('user', list=True)
-    def friends(self, **kwargs):
-        """friends(*, user_id, screen_name, cursor, count, skip_status, \
-                   include_user_entities)
+    def get_friends(self, **kwargs):
+        """get_friends(*, user_id, screen_name, cursor, count, skip_status, \
+                       include_user_entities)
 
         Returns a user's friends ordered in which they were added 100 at a
         time. If no user is specified it defaults to the authenticated user.

diff --git a/tweepy/models.py b/tweepy/models.py
@@ -412,7 +412,7 @@ def timeline(self, **kwargs):
         return self._api.user_timeline(user_id=self.id, **kwargs)
 
     def friends(self, **kwargs):
-        return self._api.friends(user_id=self.id, **kwargs)
+        return self._api.get_friends(user_id=self.id, **kwargs)
 
     def followers(self, **kwargs):
         return self._api.get_followers(user_id=self.id, **kwargs)