♻️ Tighten prepared transport request typing

Author: shoucandanghehe

nonebot/adapters/discord/serialization.py

@@ -179,7 +179,7 @@ def _build_multipart_payload(
 
 def encode_prepared_request(
     prepared: PreparedRequest,
-) -> dict[Literal["files", "json"], Any]:
+) -> EncodedPreparedRequest:
     payload = encode_model_json_data(
         prepared.body,
         include=prepared.include,

tests/test_api_nullability.py

@@ -1,5 +1,6 @@
 from datetime import datetime, timezone
 import json
+from typing import Any
 
 from nonebot.adapters.discord.api import (
     ActionRow,
@@ -16,25 +17,41 @@
 )
 from nonebot.adapters.discord.api.types import UNSET
 from nonebot.adapters.discord.api.utils import parse_data, parse_forum_thread_message
-from nonebot.adapters.discord.serialization import encode_prepared_request
+from nonebot.adapters.discord.serialization import (
+    PreparedRequest,
+    encode_prepared_request,
+)
 from nonebot.adapters.discord.utils import omit_unset
 
 
+def _json_payload(prepared: PreparedRequest) -> dict[str, Any]:
+    encoded = encode_prepared_request(prepared)
+    assert "json" in encoded
+    return encoded["json"]
+
+
+def _payload_json_text(prepared: PreparedRequest) -> str:
+    encoded = encode_prepared_request(prepared)
+    assert "files" in encoded
+    payload_json = encoded["files"]["payload_json"]
+    assert isinstance(payload_json, tuple)
+    assert len(payload_json) >= 2
+    payload_body = payload_json[1]
+    assert isinstance(payload_body, (bytes, str))
+    return payload_body.decode() if isinstance(payload_body, bytes) else payload_body
+
+
 def _assert_transport_datetime(actual: str, expected: datetime) -> None:
     assert datetime.fromisoformat(actual.replace("Z", "+00:00")) == expected
 
 
 def test_parse_data_keeps_explicit_null() -> None:
-    payload = encode_prepared_request(parse_data({"content": None}, MessageEditParams))[
-        "json"
-    ]
+    payload = _json_payload(parse_data({"content": None}, MessageEditParams))
     assert payload == {"content": None}
 
 
 def test_parse_data_omits_unset() -> None:
-    payload = encode_prepared_request(
-        parse_data({"content": UNSET}, MessageEditParams)
-    )["json"]
+    payload = _json_payload(parse_data({"content": UNSET}, MessageEditParams))
     assert payload == {}
 
 
@@ -44,61 +61,59 @@ def test_omit_unset_filters_unset_in_list() -> None:
 
 
 def test_parse_data_message_send_omits_unset_fields() -> None:
-    payload = encode_prepared_request(parse_data({}, MessageSend))["json"]
+    payload = _json_payload(parse_data({}, MessageSend))
     assert payload == {}
 
 
 def test_parse_data_execute_webhook_omits_unset_fields() -> None:
-    payload = encode_prepared_request(parse_data({}, ExecuteWebhookParams))["json"]
+    payload = _json_payload(parse_data({}, ExecuteWebhookParams))
     assert payload == {}
 
 
 def test_parse_data_serializes_embed_timestamp() -> None:
     timestamp = datetime(2026, 3, 14, 12, 0, tzinfo=timezone.utc)
-    payload = encode_prepared_request(
+    payload = _json_payload(
         parse_data(
             {"embeds": [Embed(timestamp=timestamp)]},
             MessageSend,
         )
-    )["json"]
+    )
 
     _assert_transport_datetime(payload["embeds"][0]["timestamp"], timestamp)
 
 
 def test_parse_data_multipart_keeps_null_attachments() -> None:
-    res = encode_prepared_request(
-        parse_data(
-            {
-                "files": [File(content=b"1", filename="a.txt")],
-                "attachments": None,
-            },
-            MessageEditParams,
+    payload = json.loads(
+        _payload_json_text(
+            parse_data(
+                {
+                    "files": [File(content=b"1", filename="a.txt")],
+                    "attachments": None,
+                },
+                MessageEditParams,
+            )
         )
     )
-    multipart = res["files"]
-    _, payload_json, _ = multipart["payload_json"]
-    payload = json.loads(payload_json)
     assert payload["attachments"] is None
 
 
 def test_parse_data_multipart_maps_attachment_id() -> None:
-    res = encode_prepared_request(
-        parse_data(
-            {
-                "files": [File(content=b"1", filename="a.txt")],
-                "attachments": [{"filename": "a.txt"}],
-            },
-            MessageEditParams,
+    payload = json.loads(
+        _payload_json_text(
+            parse_data(
+                {
+                    "files": [File(content=b"1", filename="a.txt")],
+                    "attachments": [{"filename": "a.txt"}],
+                },
+                MessageEditParams,
+            )
         )
     )
-    multipart = res["files"]
-    _, payload_json, _ = multipart["payload_json"]
-    payload = json.loads(payload_json)
     assert payload["attachments"][0]["id"] == 0
 
 
 def test_parse_data_keeps_action_row_type_for_components() -> None:
-    payload = encode_prepared_request(
+    payload = _json_payload(
         parse_data(
             {
                 "components": [
@@ -115,54 +130,50 @@ def test_parse_data_keeps_action_row_type_for_components() -> None:
             },
             MessageSend,
         )
-    )["json"]
+    )
     assert "content" not in payload
     assert int(payload["components"][0]["type"]) == int(ComponentType.ActionRow)
 
 
 def test_parse_forum_thread_message_keeps_name() -> None:
-    payload = encode_prepared_request(
+    payload = _json_payload(
         parse_forum_thread_message({"name": "thread-name", "content": "hello"})
-    )["json"]
+    )
     assert payload["name"] == "thread-name"
 
 
 def test_parse_forum_thread_message_without_content() -> None:
-    payload = encode_prepared_request(
-        parse_forum_thread_message({"name": "thread-name"})
-    )["json"]
+    payload = _json_payload(parse_forum_thread_message({"name": "thread-name"}))
     assert payload["message"] == {}
 
 
 def test_parse_forum_thread_message_serializes_embed_timestamp_in_multipart() -> None:
     timestamp = datetime(2026, 3, 14, 12, 0, tzinfo=timezone.utc)
-    res = encode_prepared_request(
-        parse_forum_thread_message(
-            {
-                "name": "thread-name",
-                "files": [File(content=b"1", filename="a.txt")],
-                "embeds": [Embed(timestamp=timestamp)],
-            }
+    payload = json.loads(
+        _payload_json_text(
+            parse_forum_thread_message(
+                {
+                    "name": "thread-name",
+                    "files": [File(content=b"1", filename="a.txt")],
+                    "embeds": [Embed(timestamp=timestamp)],
+                }
+            )
         )
     )
-    multipart = res["files"]
-    _, payload_json, _ = multipart["payload_json"]
-    payload = json.loads(payload_json)
 
     _assert_transport_datetime(payload["message"]["embeds"][0]["timestamp"], timestamp)
 
 
 def test_parse_forum_thread_message_maps_message_attachment_id() -> None:
-    res = encode_prepared_request(
-        parse_forum_thread_message(
-            {
-                "name": "thread-name",
-                "files": [File(content=b"1", filename="a.txt")],
-                "attachments": [{"filename": "a.txt"}],
-            }
+    payload = json.loads(
+        _payload_json_text(
+            parse_forum_thread_message(
+                {
+                    "name": "thread-name",
+                    "files": [File(content=b"1", filename="a.txt")],
+                    "attachments": [{"filename": "a.txt"}],
+                }
+            )
         )
     )
-    multipart = res["files"]
-    _, payload_json, _ = multipart["payload_json"]
-    payload = json.loads(payload_json)
     assert payload["message"]["attachments"][0]["id"] == 0