From 837264442fdcd68f616cbd082f3d4d2e732cd870 Mon Sep 17 00:00:00 2001 From: Harmon Date: Wed, 7 Apr 2021 09:57:21 -0500 Subject: [PATCH] Update and improve documentation for API.list_members Automatically use docstring for documentation Improve method and documentation order Add count, include_entities, and skip_status parameters to documentation Improve parameter order in documentation --- docs/api.rst | 15 ++------------- tweepy/api.py | 40 ++++++++++++++++++++++++++++------------ 2 files changed, 30 insertions(+), 25 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index 46d73dc..6972d71 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -72,6 +72,8 @@ Create and manage lists .. automethod:: API.lists_all +.. automethod:: API.list_members + User methods ------------ @@ -760,19 +762,6 @@ List Methods :rtype: :class:`List` object -.. method:: API.list_members(list_id/slug, [owner_id/owner_screen_name], \ - [cursor]) - - Returns the members of the specified list. - - :param list_id: |list_id| - :param slug: |slug| - :param owner_id: |owner_id| - :param owner_screen_name: |owner_screen_name| - :param cursor: |cursor| - :rtype: list of :class:`User` objects - - .. method:: API.show_list_member(list_id/slug, screen_name/user_id, \ [owner_id/owner_screen_name]) diff --git a/tweepy/api.py b/tweepy/api.py index 4496ed9..34021d8 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -903,6 +903,34 @@ class API: ), **kwargs ) + @pagination(mode='cursor') + @payload('user', list=True) + def list_members(self, **kwargs): + """list_members(*, list_id, slug, owner_screen_name, owner_id, count, \ + cursor, include_entities, skip_status) + + Returns the members of the specified list. + + :param list_id: |list_id| + :param slug: |slug| + :param owner_screen_name: |owner_screen_name| + :param owner_id: |owner_id| + :param count: |count| + :param cursor: |cursor| + :param include_entities: |include_entities| + :param skip_status: |skip_status| + + :rtype: list of :class:`User` objects + + :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members + """ + return self.request( + 'GET', 'lists/members', endpoint_parameters=( + 'list_id', 'slug', 'owner_screen_name', 'owner_id', 'count', + 'cursor', 'include_entities', 'skip_status' + ), **kwargs + ) + def media_upload(self, filename, *, file=None, chunked=False, media_category=None, additional_owners=None, **kwargs): """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/overview @@ -1618,18 +1646,6 @@ class API: ), **kwargs ) - @pagination(mode='cursor') - @payload('user', list=True) - def list_members(self, **kwargs): - """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members - """ - return self.request( - 'GET', 'lists/members', endpoint_parameters=( - 'list_id', 'slug', 'owner_screen_name', 'owner_id', 'count', - 'cursor', 'include_entities', 'skip_status' - ), **kwargs - ) - @payload('user') def show_list_member(self, **kwargs): """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-members-show -- 2.25.1