feat(media): ✅ add tests for media upload api v2

Author: MerleLiuKun

pytwitter/api.py

@@ -768,7 +768,7 @@ def upload_media_chunked_status(
 
     def upload_media_simple_v2(
         self,
-        media: Optional[IO] = None,
+        media: Optional[bytes] = None,
         media_category: Optional[str] = None,
         additional_owners: Optional[List[str]] = None,
         return_json: bool = False,
@@ -779,16 +779,19 @@ def upload_media_simple_v2(
         Note: The simple upload endpoint can only be used to upload images.
 
         :param media: The raw binary file content being uploaded.
-        :param media_category: The category that represents how the media will be used.
-            This field is required when using the media with the Ads API.
+        :param media_category: A string enum value which identifies a media use-case.
+            This identifier is used to enforce use-case specific constraints (e.g. file size, video duration) and enable advanced features.
             Possible values:
                 - tweet_image
                 - tweet_gif
                 - tweet_video
                 - amplify_video
-        :param additional_owners: A comma-separated list of user IDs to set as additional owners
-            allowed to use the returned media_id in Tweets or Cards.
-            Up to 100 additional owners may be specified.
+                - dm_video
+                - subtitles
+        :param additional_owners: A comma-separated list of user IDs to set as additional owners allowed to use the
+            returned media_id in Tweets or Cards. Up to 100 additional owners may be specified.
+            Unique identifier of this User. This is returned as a string in order to avoid complications with
+            languages and tools that cannot handle large integers.
         :param return_json: Type for returned data. If you set True JSON data will be returned.
         :return: Media upload response.
         """
@@ -834,18 +837,19 @@ def upload_media_chunked_init_v2(
 
         :param total_bytes: The total size of the media being uploaded in bytes.
         :param media_type: The MIME type of the media being uploaded. example: image/jpeg, image/gif, and video/mp4.
-        :param media_category: The category that represents how the media will be used.
-            This field is required when using the media with the Ads API.
+        :param media_category: A string enum value which identifies a media use-case.
+            This identifier is used to enforce use-case specific constraints (e.g. file size, video duration) and enable advanced features.
             Possible values:
                 - tweet_image
                 - tweet_gif
                 - tweet_video
                 - amplify_video
                 - dm_video
                 - subtitles
-        :param additional_owners: A comma-separated list of user IDs to set as additional owners
-            allowed to use the returned media_id in Tweets or Cards.
-            Up to 100 additional owners may be specified.
+        :param additional_owners: A comma-separated list of user IDs to set as additional owners allowed to use the
+            returned media_id in Tweets or Cards. Up to 100 additional owners may be specified.
+            Unique identifier of this User. This is returned as a string in order to avoid complications with
+            languages and tools that cannot handle large integers.
         :param return_json: Type for returned data. If you set True JSON data will be returned.
         :return: Media upload response.
         """
@@ -877,15 +881,15 @@ def upload_media_chunked_append_v2(
         self,
         media_id: str,
         segment_index: int,
-        media: Optional[IO],
+        media: Optional[bytes],
     ) -> bool:
         """
         Used to upload a chunk (consecutive byte range) of the media file.
 
         :param media_id: The `media_id` returned from the INIT step.
         :param segment_index: An ordered index of file chunk. It must be between 0-999 inclusive.
             The first segment has index 0, second segment has index 1, and so on.
-        :param media: The raw binary file content being uploaded. Cannot be used with `media_data`.
+        :param media: The raw binary file content being uploaded.
         :return: True if upload success.
         """
         resp = self._request(

testdata/apis/media_upload_v2/upload_chunk_finalize_resp.json

@@ -0,0 +1 @@
+{"data":{"id":"1912090619981471744","media_key":"7_1912090619981471744","size":19048761,"expires_after_secs":86400,"processing_info":{"state":"succeeded"}}}

testdata/apis/media_upload_v2/upload_chunk_init_resp.json

@@ -0,0 +1 @@
+{"data":{"id":"1912103767639719936","expires_after_secs":86400,"media_key":"3_1912103767639719936"}}

testdata/apis/media_upload_v2/upload_chunk_status_resp.json

@@ -0,0 +1 @@
+{"data":{"expires_after_secs":83800,"id":"1912090619981471744","media_key":"7_1912090619981471744","processing_info":{"progress_percent":100,"state":"succeeded"},"size":19048761}}

testdata/apis/media_upload_v2/upload_simple_resp.json

@@ -0,0 +1 @@
+{"id":"1726817595448610817","media_key":"3_1726817595448610817","size":1864939,"expires_after_secs":86400,"image":{"image_type":"image/jpeg","w":4928,"h":3280}}

tests/apis/test_media_upload_v2.py

@@ -0,0 +1,148 @@
+"""
+    Tests for media upload API v2
+"""
+
+import pytest
+import responses
+
+from pytwitter import PyTwitterError
+
+
+@responses.activate
+def test_media_upload_simple_v2(api_with_user, helpers):
+    with pytest.raises(PyTwitterError):
+        api_with_user.upload_media_simple_v2()
+
+    responses.add(
+        responses.POST,
+        url="https://api.twitter.com/2/media/upload",
+        json=helpers.load_json_data(
+            "testdata/apis/media_upload_v2/upload_simple_resp.json"
+        ),
+    )
+
+    with open("testdata/apis/media_upload/x-logo.png", "rb") as media:
+        resp = api_with_user.upload_media_simple_v2(
+            media=media,
+            media_category="tweet_image",
+            additional_owners=["123456789"],
+        )
+        assert resp.id == "1726817595448610817"
+
+    with open("testdata/apis/media_upload/x-logo.png", "rb") as media:
+        resp = api_with_user.upload_media_simple_v2(
+            media=media, media_category="tweet_image", return_json=True
+        )
+        assert resp["id"] == "1726817595448610817"
+
+
+@responses.activate
+def test_upload_media_chunked_init_v2(api_with_user, helpers):
+    responses.add(
+        responses.POST,
+        url="https://api.twitter.com/2/media/upload",
+        json=helpers.load_json_data(
+            "testdata/apis/media_upload_v2/upload_chunk_init_resp.json"
+        ),
+    )
+
+    resp = api_with_user.upload_media_chunked_init_v2(
+        total_bytes=1000000,
+        media_type="video/mp4",
+        media_category="tweet_video",
+        additional_owners=["123456789"],
+    )
+    assert resp.data.id == "1912103767639719936"
+
+    resp_json = api_with_user.upload_media_chunked_init_v2(
+        total_bytes=1000000,
+        media_type="video/mp4",
+        return_json=True,
+    )
+    assert resp_json["data"]["id"] == "1912103767639719936"
+
+
+@responses.activate
+def test_upload_media_chunked_append_v2(api_with_user, helpers):
+    media_id = "1912090619981471744"
+
+    responses.add(
+        responses.POST,
+        url="https://api.twitter.com/2/media/upload",
+    )
+
+    with open("testdata/apis/media_upload/x-logo.png", "rb") as media:
+        segment_index = 0
+        while True:
+            chunk = media.read(1 * 1024 * 1024)
+            if not chunk:
+                break
+            status = api_with_user.upload_media_chunked_append_v2(
+                media_id=media_id,
+                media=media,
+                segment_index=segment_index,
+            )
+            assert status
+
+            segment_index += 1
+
+    responses.add(
+        responses.POST,
+        url="https://api.twitter.com/2/media/upload",
+        status=401,
+        json={"errors": [{"code": 32, "message": "Could not authenticate you."}]},
+    )
+    with pytest.raises(PyTwitterError):
+        api_with_user.upload_media_chunked_append_v2(
+            media_id=media_id,
+            media=b"",
+            segment_index=1,
+        )
+
+
+@responses.activate
+def test_upload_media_chunked_finalize_v2(api_with_user, helpers):
+    media_id = "1912090619981471744"
+
+    responses.add(
+        responses.POST,
+        url="https://api.twitter.com/2/media/upload",
+        json=helpers.load_json_data(
+            "testdata/apis/media_upload_v2/upload_chunk_finalize_resp.json"
+        ),
+    )
+
+    resp = api_with_user.upload_media_chunked_finalize_v2(
+        media_id=media_id,
+    )
+    assert resp.data.id == media_id
+
+    resp_json = api_with_user.upload_media_chunked_finalize_v2(
+        media_id=media_id,
+        return_json=True,
+    )
+    assert resp_json["data"]["id"] == media_id
+
+
+@responses.activate
+def test_upload_media_chunked_status_v2(api_with_user, helpers):
+    media_id = "1912090619981471744"
+
+    responses.add(
+        responses.GET,
+        url="https://api.twitter.com/2/media/upload",
+        json=helpers.load_json_data(
+            "testdata/apis/media_upload_v2/upload_chunk_status_resp.json"
+        ),
+    )
+
+    resp = api_with_user.upload_media_chunked_status_v2(
+        media_id=media_id,
+    )
+    assert resp.data.processing_info.state == "succeeded"
+
+    resp_json = api_with_user.upload_media_chunked_status_v2(
+        media_id=media_id,
+        return_json=True,
+    )
+    assert resp_json["data"]["processing_info"]["state"] == "succeeded"