From 18a1bbe52fe9c849612883f6ebb3ec0b9e531ef2 Mon Sep 17 00:00:00 2001 From: Harmon Date: Wed, 7 Apr 2021 10:24:06 -0500 Subject: [PATCH] Update and improve documentation for API.list_subscribers Automatically use docstring for documentation Improve method and documentation order Improve parameter order in documentation --- docs/api.rst | 20 ++------------------ tweepy/api.py | 41 +++++++++++++++++++++++++++++------------ 2 files changed, 31 insertions(+), 30 deletions(-) diff --git a/docs/api.rst b/docs/api.rst index b2b75ab..d294e8d 100644 --- a/docs/api.rst +++ b/docs/api.rst @@ -84,6 +84,8 @@ Create and manage lists .. automethod:: API.list_timeline +.. automethod:: API.list_subscribers + User methods ------------ @@ -728,24 +730,6 @@ List Methods :rtype: :class:`List` object -.. method:: API.list_subscribers(list_id/slug, [owner_id/owner_screen_name], \ - [cursor], [count], [include_entities], \ - [skip_status]) - - Returns the subscribers of the specified list. Private list subscribers will - only be shown if the authenticated user owns 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| - :param count: |count| - :param include_entities: |include_entities| - :param skip_status: |skip_status| - :rtype: list of :class:`User` objects - - .. method:: API.show_list_subscriber(list_id/slug, screen_name/user_id, \ [owner_id/owner_screen_name]) diff --git a/tweepy/api.py b/tweepy/api.py index 0733ac9..d25f9b9 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -1071,6 +1071,35 @@ class API: ), **kwargs ) + @pagination(mode='cursor') + @payload('user', list=True) + def list_subscribers(self, **kwargs): + """list_subscribers(*, list_id, slug, owner_screen_name, owner_id, \ + count, cursor, include_entities, skip_status) + + Returns the subscribers of the specified list. Private list subscribers + will only be shown if the authenticated user owns 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-subscribers + """ + return self.request( + 'GET', 'lists/subscribers', 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 @@ -1761,18 +1790,6 @@ class API: ), **kwargs ) - @pagination(mode='cursor') - @payload('user', list=True) - def list_subscribers(self, **kwargs): - """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers - """ - return self.request( - 'GET', 'lists/subscribers', endpoint_parameters=( - 'list_id', 'slug', 'owner_screen_name', 'owner_id', 'count', - 'cursor', 'include_entities', 'skip_status' - ), **kwargs - ) - @payload('user') def show_list_subscriber(self, **kwargs): """ :reference: https://developer.twitter.com/en/docs/twitter-api/v1/accounts-and-users/create-manage-lists/api-reference/get-lists-subscribers-show -- 2.25.1