♻️ refactor JSON serialization functions to private module

Author: Paillat-dev

discord/gateway.py

@@ -42,6 +42,7 @@
 from .activity import BaseActivity
 from .enums import SpeakingState
 from .errors import ConnectionClosed, InvalidArgument
+from .utils.private import _from_json, _to_json
 
 _log = logging.getLogger(__name__)
 
@@ -450,7 +451,7 @@ async def received_message(self, msg, /):
             self._buffer = bytearray()
 
         self.log_receive(msg)
-        msg = utils._from_json(msg)
+        msg = _from_json(msg)
 
         _log.debug("For Shard ID %s: WebSocket Event: %s", self.shard_id, msg)
         event = msg.get("t")
@@ -637,15 +638,15 @@ async def send(self, data, /):
 
     async def send_as_json(self, data):
         try:
-            await self.send(utils._to_json(data))
+            await self.send(_to_json(data))
         except RuntimeError as exc:
             if not self._can_handle_close():
                 raise ConnectionClosed(self.socket, shard_id=self.shard_id) from exc
 
     async def send_heartbeat(self, data):
         # This bypasses the rate limit handling code since it has a higher priority
         try:
-            await self.socket.send_str(utils._to_json(data))
+            await self.socket.send_str(_to_json(data))
         except RuntimeError as exc:
             if not self._can_handle_close():
                 raise ConnectionClosed(self.socket, shard_id=self.shard_id) from exc
@@ -671,7 +672,7 @@ async def change_presence(self, *, activity=None, status=None, since=0.0):
             },
         }
 
-        sent = utils._to_json(payload)
+        sent = _to_json(payload)
         _log.debug('Sending "%s" to change status', sent)
         await self.send(sent)
 
@@ -774,7 +775,7 @@ async def _hook(self, *args):
 
     async def send_as_json(self, data):
         _log.debug("Sending voice websocket frame: %s.", data)
-        await self.ws.send_str(utils._to_json(data))
+        await self.ws.send_str(_to_json(data))
 
     send_heartbeat = send_as_json
 
@@ -931,7 +932,7 @@ async def poll_event(self):
         # This exception is handled up the chain
         msg = await asyncio.wait_for(self.ws.receive(), timeout=30.0)
         if msg.type is aiohttp.WSMsgType.TEXT:
-            await self.received_message(utils._from_json(msg.data))
+            await self.received_message(_from_json(msg.data))
         elif msg.type is aiohttp.WSMsgType.ERROR:
             _log.debug("Received %s", msg)
             raise ConnectionClosed(self.ws, shard_id=None) from msg.data

discord/http.py

@@ -34,7 +34,7 @@
 
 import aiohttp
 
-from .utils.private import get_mime_type_for_image
+from .utils.private import get_mime_type_for_image, _to_json, _from_json
 from . import __version__, utils
 from .errors import (
     DiscordServerError,
@@ -98,7 +98,7 @@ async def json_or_text(response: aiohttp.ClientResponse) -> dict[str, Any] | str
     text = await response.text(encoding="utf-8")
     try:
         if response.headers["content-type"] == "application/json":
-            return utils._from_json(text)
+            return _from_json(text)
     except KeyError:
         # Thanks Cloudflare
         pass
@@ -261,7 +261,7 @@ async def request(
         # some checking if it's a JSON request
         if "json" in kwargs:
             headers["Content-Type"] = "application/json"
-            kwargs["data"] = utils._to_json(kwargs.pop("json"))
+            kwargs["data"] = _to_json(kwargs.pop("json"))
 
         try:
             reason = kwargs.pop("reason")
@@ -569,7 +569,7 @@ def send_multipart_helper(
                 }
             )
         payload["attachments"] = attachments
-        form[0]["value"] = utils._to_json(payload)
+        form[0]["value"] = _to_json(payload)
         return self.request(route, form=form, files=files)
 
     def send_files(
@@ -642,7 +642,7 @@ def edit_multipart_helper(
             payload["attachments"] = attachments
         else:
             payload["attachments"].extend(attachments)
-        form[0]["value"] = utils._to_json(payload)
+        form[0]["value"] = _to_json(payload)
 
         return self.request(route, form=form, files=files)
 
@@ -1242,7 +1242,7 @@ def start_forum_thread(
                 )
 
             payload["attachments"] = attachments
-            form[0]["value"] = utils._to_json(payload)
+            form[0]["value"] = _to_json(payload)
             return self.request(route, form=form, reason=reason)
         return self.request(route, json=payload, reason=reason)
 
@@ -2589,7 +2589,7 @@ def _edit_webhook_helper(
         form: list[dict[str, Any]] = [
             {
                 "name": "payload_json",
-                "value": utils._to_json(payload),
+                "value": _to_json(payload),
             }
         ]
 

discord/utils/__init__.py

@@ -25,7 +25,6 @@
 
 from __future__ import annotations
 
-import json
 from typing import (
     TYPE_CHECKING,
     Any,
@@ -56,13 +55,6 @@
     escape_markdown,
 )
 
-try:
-    import msgspec
-except ModuleNotFoundError:
-    HAS_MSGSPEC = False
-else:
-    HAS_MSGSPEC = True
-
 DISCORD_EPOCH = 1420070400000
 
 
@@ -181,18 +173,3 @@ async def get_or_fetch(obj, attr: str, id: int, *, default: Any = MISSING) -> An
             else:
                 raise
     return getter
-
-
-if HAS_MSGSPEC:
-
-    def _to_json(obj: Any) -> str:  # type: ignore
-        return msgspec.json.encode(obj).decode("utf-8")
-
-    _from_json = msgspec.json.decode  # type: ignore
-
-else:
-
-    def _to_json(obj: Any) -> str:
-        return json.dumps(obj, separators=(",", ":"), ensure_ascii=True)
-
-    _from_json = json.loads

discord/utils/private.py

@@ -530,3 +530,20 @@ def decorator(func: Callable[[T], T_co]) -> CachedSlotProperty[T, T_co]:
         return CachedSlotProperty(name, func)
 
     return decorator
+
+
+try:
+    import msgspec
+
+    def _to_json(obj: Any) -> str:  # type: ignore
+        return msgspec.json.encode(obj).decode("utf-8")
+
+    _from_json = msgspec.json.decode  # type: ignore
+
+except ModuleNotFoundError:
+    import json
+
+    def _to_json(obj: Any) -> str:
+        return json.dumps(obj, separators=(",", ":"), ensure_ascii=True)
+
+    _from_json = json.loads

discord/webhook/async_.py

@@ -36,7 +36,7 @@
 
 import aiohttp
 
-from ..utils.private import bytes_to_base64_data, get_as_snowflake, parse_ratelimit_header
+from ..utils.private import bytes_to_base64_data, get_as_snowflake, parse_ratelimit_header, _to_json
 from .. import utils
 from ..asset import Asset
 from ..channel import ForumChannel, PartialMessageable
@@ -135,7 +135,7 @@ async def request(
 
         if payload is not None:
             headers["Content-Type"] = "application/json"
-            to_send = utils._to_json(payload)
+            to_send = _to_json(payload)
 
         if auth_token is not None:
             headers["Authorization"] = f"Bot {auth_token}"
@@ -509,7 +509,7 @@ def create_interaction_response(
             )
         if attachments:
             payload["data"]["attachments"] = attachments
-        form[0]["value"] = utils._to_json(payload)
+        form[0]["value"] = _to_json(payload)
 
         route = Route(
             "POST",
@@ -701,7 +701,7 @@ def handle_message_parameters(
         payload["thread_name"] = thread_name
 
     if multipart_files:
-        multipart.append({"name": "payload_json", "value": utils._to_json(payload)})
+        multipart.append({"name": "payload_json", "value": _to_json(payload)})
         payload = None
         multipart += multipart_files
 

discord/webhook/sync.py

@@ -41,7 +41,7 @@
 from urllib.parse import quote as urlquote
 
 from .. import utils
-from ..utils.private import parse_ratelimit_header, bytes_to_base64_data
+from ..utils.private import parse_ratelimit_header, bytes_to_base64_data, _to_json
 from ..channel import PartialMessageable
 from ..errors import (
     DiscordServerError,
@@ -125,7 +125,7 @@ def request(
 
         if payload is not None:
             headers["Content-Type"] = "application/json"
-            to_send = utils._to_json(payload)
+            to_send = _to_json(payload)
 
         if auth_token is not None:
             headers["Authorization"] = f"Bot {auth_token}"