From d488f216560ebc826ef5b62a1d7ed19ef411ccca Mon Sep 17 00:00:00 2001 From: Harmon Date: Thu, 27 May 2021 10:46:08 -0500 Subject: [PATCH] Update and improve documentation for API.chunked_upload --- tweepy/api.py | 37 +++++++++++++++++++++++++------------ 1 file changed, 25 insertions(+), 12 deletions(-) diff --git a/tweepy/api.py b/tweepy/api.py index ebfee16..652529d 100644 --- a/tweepy/api.py +++ b/tweepy/api.py @@ -3450,9 +3450,10 @@ class API: def chunked_upload(self, filename, *, file=None, file_type=None, wait_for_async_finalize=True, media_category=None, additional_owners=None, **kwargs): - """chunked_upload(filename, *, file, file_type, \ - wait_for_async_finalize, media_category, \ - additional_owners) + """chunked_upload( \ + filename, *, file, file_type, wait_for_async_finalize, \ + media_category, additional_owners \ + ) Use this to upload media to Twitter. This uses the chunked upload endpoints and calls :func:`API.chunked_upload_init`, @@ -3460,17 +3461,29 @@ class API: :func:`API.chunked_upload_finalize`. If ``wait_for_async_finalize`` is set, this calls :func:`API.get_media_upload_status` as well. - :param filename: |filename| - :param file: |file| - :param file_type: The MIME type of the media being uploaded. - :param wait_for_async_finalize: Whether to wait for Twitter's API to - finish processing the media. Defaults to ``True``. - :param media_category: |media_category| - :param additional_owners: |additional_owners| + Parameters + ---------- + filename + |filename| + file + |file| + file_type + The MIME type of the media being uploaded. + wait_for_async_finalize + Whether to wait for Twitter's API to finish processing the media. + Defaults to ``True``. + media_category + |media_category| + additional_owners + |additional_owners| - :rtype: :class:`Media` object + Returns + ------- + :class:`~tweepy.models.Media` - :reference: https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/chunked-media-upload + References + ---------- + https://developer.twitter.com/en/docs/twitter-api/v1/media/upload-media/uploading-media/chunked-media-upload """ fp = file or open(filename, 'rb') -- 2.25.1