refactor: 给kook适配器事件data类和ws信令枚举使用更清晰的命名,默认使用by_alias来原样转换数据类为json字符串

Author: shuiping233

astrbot/core/platform/sources/kook/kook_adapter.py

@@ -25,7 +25,7 @@
     KmarkdownElement,
     KookCardMessageContainer,
     KookChannelType,
-    KookMessageEvent,
+    KookMessageEventData,
     KookMessageType,
     PlainTextElement,
     SectionModule,
@@ -72,7 +72,7 @@ def meta(self) -> PlatformMetadata:
     def _should_ignore_event_by_bot_nickname(self, author_id: str) -> bool:
         return self.client.bot_id == author_id
 
-    async def _on_received(self, event: KookMessageEvent):
+    async def _on_received(self, event: KookMessageEventData):
         logger.debug(f"KOOK 收到数据: {event.to_json()}")
         event_type = event.type
         if event_type in (KookMessageType.KMARKDOWN, KookMessageType.CARD):
@@ -185,7 +185,7 @@ async def _cleanup(self):
         logger.info("[KOOK] 资源清理完成")
 
     def _parse_kmarkdown_text_message(
-        self, data: KookMessageEvent, self_id: str
+        self, data: KookMessageEventData, self_id: str
     ) -> tuple[list, str]:
         kmarkdown = data.extra.kmarkdown
         content = data.content or ""
@@ -263,7 +263,7 @@ def _parse_kmarkdown_text_message(
 
         return components, message_str
 
-    def _parse_card_message(self, data: KookMessageEvent) -> tuple[list, str]:
+    def _parse_card_message(self, data: KookMessageEventData) -> tuple[list, str]:
         content = data.content
         if not isinstance(content, str):
             content = str(content)
@@ -316,7 +316,7 @@ def _handle_image_group(
             valid_urls.append(el.src)
         return valid_urls
 
-    async def convert_message(self, data: KookMessageEvent) -> AstrBotMessage:
+    async def convert_message(self, data: KookMessageEventData) -> AstrBotMessage:
         abm = AstrBotMessage()
         abm.raw_message = data.to_dict()
         abm.self_id = self.client.bot_id

astrbot/core/platform/sources/kook/kook_client.py

@@ -19,11 +19,11 @@
 from .kook_types import (
     KookApiPaths,
     KookGatewayIndexResponse,
-    KookHelloEvent,
-    KookMessageEvent,
+    KookHelloEventData,
+    KookMessageEventData,
     KookMessageSignal,
     KookMessageType,
-    KookResumeAckEvent,
+    KookResumeAckEventData,
     KookUserMeResponse,
     KookWebsocketEvent,
 )
@@ -228,27 +228,27 @@ async def _handle_signal(self, event: KookWebsocketEvent):
         """处理不同类型的信令"""
 
         match event.data:
-            case KookMessageEvent() as data:
+            case KookMessageEventData() as data:
                 if event.sn is not None:
                     self.last_sn = event.sn
                 await self.event_callback(data)
 
-            case KookHelloEvent() as data:
+            case KookHelloEventData() as data:
                 await self._handle_hello(data)
 
-            case KookResumeAckEvent() as data:
+            case KookResumeAckEventData() as data:
                 await self._handle_resume_ack(data)
 
             case _:
                 match event.signal:
-                    case KookMessageSignal.HEARTBEAT_ACK:
+                    case KookMessageSignal.PONG:
                         await self._handle_pong()
                     case KookMessageSignal.RECONNECT:
                         await self._handle_reconnect()
                     case _:
                         logger.debug(f"[KOOK] 未处理的信令类型: {event.signal}")
 
-    async def _handle_hello(self, data: KookHelloEvent):
+    async def _handle_hello(self, data: KookHelloEventData):
         """处理HELLO握手"""
         code = data.code
 
@@ -276,7 +276,7 @@ async def _handle_reconnect(self):
         self.session_id = None
         self.running = False
 
-    async def _handle_resume_ack(self, data: KookResumeAckEvent):
+    async def _handle_resume_ack(self, data: KookResumeAckEventData):
         """处理RESUME确认"""
         self.session_id = data.session_id
         logger.info(f"[KOOK] Resume成功，session_id: {self.session_id}")

astrbot/core/platform/sources/kook/kook_types.py

@@ -85,7 +85,7 @@ def to_json(
         self,
         indent: int | None = None,
         ensure_ascii=False,
-        by_alias=False,
+        by_alias=True,
         exclude_none=True,
     ) -> str:
         return self.model_dump_json(
@@ -281,9 +281,9 @@ class KookMessageSignal(IntEnum):
     """server->client  消息(s包含聊天和通知消息)"""
     HELLO = 1
     """server->client  客户端连接 ws 时, 服务端返回握手结果"""
-    HEARTBEAT = 2
+    PING = 2
     """client->server  心跳，ping"""
-    HEARTBEAT_ACK = 3
+    PONG = 3
     """server->client  心跳，pong"""
     RESUME = 4
     """client->server  resume, 恢复会话"""
@@ -330,7 +330,7 @@ class KookExtra(KookBaseDataClass):
     mention_here: bool = False
 
 
-class KookMessageEvent(KookBaseDataClass):
+class KookMessageEventData(KookBaseDataClass):
     signal: Literal[KookMessageSignal.MESSAGE] = Field(
         KookMessageSignal.MESSAGE, exclude=True
     )
@@ -348,7 +348,7 @@ class KookMessageEvent(KookBaseDataClass):
     extra: KookExtra
 
 
-class KookHelloEvent(KookBaseDataClass):
+class KookHelloEventData(KookBaseDataClass):
     signal: Literal[KookMessageSignal.HELLO] = Field(
         KookMessageSignal.HELLO, exclude=True
     )
@@ -358,7 +358,7 @@ class KookHelloEvent(KookBaseDataClass):
     session_id: str
 
 
-class KookResumeAckEvent(KookBaseDataClass):
+class KookResumeAckEventData(KookBaseDataClass):
     signal: Literal[KookMessageSignal.RESUME_ACK] = Field(
         KookMessageSignal.RESUME_ACK, exclude=True
     )
@@ -373,7 +373,7 @@ class KookWebsocketEvent(KookBaseDataClass):
     signal: KookMessageSignal = Field(..., alias="s")
     """信令类型"""
     data: Annotated[
-        KookMessageEvent | KookHelloEvent | KookResumeAckEvent | None,
+        KookMessageEventData | KookHelloEventData | KookResumeAckEventData | None,
         Field(discriminator="signal"),
     ] = Field(None, alias="d")
     """数据事件主体,对应原字段是'd'"""