From e1dd7414783e531de903a40cb75682166ca00c91 Mon Sep 17 00:00:00 2001 From: Harmon Date: Tue, 1 Mar 2022 16:19:16 -0600 Subject: [PATCH] Add version changed directives for API method renamings --- tweepy/api.py | 101 ++++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 98 insertions(+), 3 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index 2ccf71a..e6e78fd 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -586,6 +586,9 @@ class API: Returns the favorite statuses for the authenticating user or user specified by the ID parameter. + .. versionchanged:: 4.0 + Renamed from ``API.favorites`` + Parameters ---------- user_id @@ -624,6 +627,9 @@ class API: Returns full Tweet objects for up to 100 Tweets per request, specified by the ``id`` parameter. + .. versionchanged:: 4.0 + Renamed from ``API.statuses_lookup`` + Parameters ---------- id @@ -752,6 +758,9 @@ class API: Returns up to 100 user IDs belonging to users who have retweeted the Tweet specified by the ``id`` parameter. + .. versionchanged:: 4.0 + Renamed from ``API.retweeters`` + Parameters ---------- id @@ -783,6 +792,9 @@ class API: Returns up to 100 of the first Retweets of the given Tweet. + .. versionchanged:: 4.0 + Renamed from ``API.retweets`` + Parameters ---------- id @@ -815,6 +827,9 @@ class API: Returns the 20 most recent Tweets of the authenticated user that have been retweeted by others. + .. versionchanged:: 4.0 + Renamed from ``API.retweets_of_me`` + Parameters ---------- count @@ -1135,13 +1150,16 @@ class API: status, filename, *, file, possibly_sensitive, \ in_reply_to_status_id, lat, long, place_id, display_coordinates \ ) - - .. deprecated:: 3.7.0 - Use :func:`API.media_upload` instead. Update the authenticated user's status. Statuses that are duplicates or too long will be silently ignored. + .. deprecated:: 3.7.0 + Use :func:`API.media_upload` instead. + + .. versionchanged:: 4.0 + Renamed from ``API.update_with_media`` + Parameters ---------- status @@ -1209,6 +1227,9 @@ class API: authenticating user) are not currently supported on this endpoint. [#]_\ [#]_ + .. versionchanged:: 4.0 + Renamed from ``API.search`` + Parameters ---------- q @@ -1290,6 +1311,9 @@ class API: lists first, so with ``reverse=true``, 20 owned lists and 80 subscriptions would be returned. + .. versionchanged:: 4.0 + Renamed from ``API.lists_all`` + Parameters ---------- user_id @@ -1323,6 +1347,9 @@ class API: Returns the members of the specified list. + .. versionchanged:: 4.0 + Renamed from ``API.list_members`` + Parameters ---------- list_id @@ -1366,6 +1393,9 @@ class API: Check if the specified user is a member of the specified list. + .. versionchanged:: 4.0 + Renamed from ``API.show_list_member`` + Parameters ---------- list_id @@ -1416,6 +1446,9 @@ class API: or ``screen_name`` are not provided, the memberships for the authenticating user are returned. + .. versionchanged:: 4.0 + Renamed from ``API.lists_memberships`` + Parameters ---------- user_id @@ -1575,6 +1608,9 @@ class API: Returns the subscribers of the specified list. Private list subscribers will only be shown if the authenticated user owns the specified list. + .. versionchanged:: 4.0 + Renamed from ``API.list_subscribers`` + Parameters ---------- list_id @@ -1618,6 +1654,9 @@ class API: Check if the specified user is a subscriber of the specified list. + .. versionchanged:: 4.0 + Renamed from ``API.show_list_subscriber`` + Parameters ---------- owner_screen_name @@ -1665,6 +1704,9 @@ class API: Obtain a collection of the lists the specified user is subscribed to, 20 lists per page by default. Does not include the user's own lists. + .. versionchanged:: 4.0 + Renamed from ``API.lists_subscriptions`` + Parameters ---------- user_id @@ -2031,6 +2073,9 @@ class API: Returns an array containing the IDs of users following the specified user. + .. versionchanged:: 4.0 + Renamed from ``API.followers_ids`` + Parameters ---------- user_id @@ -2067,6 +2112,8 @@ class API: Returns a user's followers ordered in which they were added. If no user is specified by id/screen name, it defaults to the authenticated user. + .. versionchanged:: 4.0 + Renamed from ``API.followers`` Parameters ---------- @@ -2107,6 +2154,9 @@ class API: Returns an array containing the IDs of users being followed by the specified user. + .. versionchanged:: 4.0 + Renamed from ``API.friends_ids`` + Parameters ---------- user_id @@ -2143,6 +2193,9 @@ class API: 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. + .. versionchanged:: 4.0 + Renamed from ``API.friends`` + Parameters ---------- user_id @@ -2181,6 +2234,9 @@ class API: Returns a collection of numeric IDs for every user who has a pending request to follow the authenticating user. + .. versionchanged:: 4.0 + Renamed from ``API.friendships_incoming`` + Parameters ---------- cursor @@ -2265,6 +2321,9 @@ class API: Returns a collection of numeric IDs for every protected user for whom the authenticating user has a pending follow request. + .. versionchanged:: 4.0 + Renamed from ``API.friendships_outgoing`` + Parameters ---------- cursor @@ -2293,6 +2352,9 @@ class API: Returns detailed information about the relationship between two users. + .. versionchanged:: 4.0 + Renamed from ``API.show_friendship`` + Parameters ---------- source_id @@ -2582,6 +2644,9 @@ class API: Returns the authenticated user's saved search queries. + .. versionchanged:: 4.0 + Renamed from ``API.saved_searches`` + Returns ------- :py:class:`List`\[:class:`~tweepy.models.SavedSearch`] @@ -2894,6 +2959,9 @@ class API: Returns an array of numeric user IDs the authenticating user is blocking. + .. versionchanged:: 4.0 + Renamed from ``API.blocks_ids`` + Parameters ---------- stringify_ids @@ -2923,6 +2991,9 @@ class API: Returns an array of user objects that the authenticating user is blocking. + .. versionchanged:: 4.0 + Renamed from ``API.blocks`` + Parameters ---------- include_entities @@ -2953,6 +3024,9 @@ class API: Returns an array of numeric user IDs the authenticating user has muted. + .. versionchanged:: 4.0 + Renamed from ``API.mutes_ids`` + Parameters ---------- stringify_ids @@ -2981,6 +3055,9 @@ class API: Returns an array of user objects the authenticating user has muted. + .. versionchanged:: 4.0 + Renamed from ``API.mutes`` + Parameters ---------- cursor @@ -3168,6 +3245,9 @@ class API: user context provided. Other members of the conversation can still access the Direct Messages. + .. versionchanged:: 4.0 + Renamed from ``API.destroy_direct_message`` + Parameters ---------- id @@ -3191,6 +3271,9 @@ class API: Returns all Direct Message events (both sent and received) within the last 30 days. Sorted in reverse-chronological order. + .. versionchanged:: 4.0 + Renamed from ``API.list_direct_messages`` + Parameters ---------- count @@ -3654,6 +3737,9 @@ class API: information such as a canonical name and country the location belongs in. + .. versionchanged:: 4.0 + Renamed from ``API.trends_available`` + Returns ------- :class:`dict` @@ -3678,6 +3764,9 @@ class API: A WOEID is a Yahoo! Where On Earth ID. + .. versionchanged:: 4.0 + Renamed from ``API.trends_closest`` + Parameters ---------- lat @@ -3726,6 +3815,9 @@ class API: The tweet_volume for the last 24 hours is also returned for many trends if this is available. + .. versionchanged:: 4.0 + Renamed from ``API.trends_place`` + Parameters ---------- id @@ -3841,6 +3933,9 @@ class API: of other parameters. For instance, ``lat`` is required if ``long`` is provided, and vice-versa. + .. versionchanged:: 4.0 + Renamed from ``API.geo_search`` + Parameters ---------- lat -- 2.25.1