satori-python-adapter-qq 0.2.0__tar.gz → 0.3.0__tar.gz

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/.mina/adapter_qq.toml

@@ -6,7 +6,7 @@ raw-dependencies = [
 
 [project]
 name = "satori-python-adapter-qq"
-version = "0.2.0"
+version = "0.3.0"
 authors = [
   {name = "RF-Tar-Railt", email = "rf_tar_railt@qq.com"}
 ]
@@ -19,11 +19,11 @@ classifiers = [
     "Typing :: Typed",
     "Development Status :: 4 - Beta",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Operating System :: OS Independent",
 ]
 

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: satori-python-adapter-qq
-Version: 0.2.0
+Version: 0.3.0
 Summary: Satori Protocol SDK for python, adapter for QQ
 Home-page: https://github.com/RF-Tar-Railt/satori-python
 Author-Email: RF-Tar-Railt <rf_tar_railt@qq.com>
@@ -8,11 +8,11 @@ License: MIT
 Classifier: Typing :: Typed
 Classifier: Development Status :: 4 - Beta
 Classifier: License :: OSI Approved :: MIT License
-Classifier: Programming Language :: Python :: 3.8
-Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
 Classifier: Operating System :: OS Independent
 Project-URL: Homepage, https://github.com/RF-Tar-Railt/satori-python
 Project-URL: Repository, https://github.com/RF-Tar-Railt/satori-python
@@ -28,11 +28,11 @@ Description-Content-Type: text/markdown
 [![PyPI](https://img.shields.io/pypi/v/satori-python)](https://pypi.org/project/satori-python)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/satori-python)](https://www.python.org/)
 
-基于 [Satori](https://satori.chat/zh-CN/) 协议的 Python 开发工具包
+基于 [Satori](https://satori.chat/zh-CN/protocol) 协议的 Python 开发工具包
 
 ## 协议介绍
 
-[Satori Protocol](https://satori.chat/zh-CN/)
+[Satori Protocol](https://satori.chat/zh-CN/protocol)
 
 ### 协议端
 

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/README.md

@@ -5,11 +5,11 @@
 [![PyPI](https://img.shields.io/pypi/v/satori-python)](https://pypi.org/project/satori-python)
 [![PyPI - Python Version](https://img.shields.io/pypi/pyversions/satori-python)](https://www.python.org/)
 
-基于 [Satori](https://satori.chat/zh-CN/) 协议的 Python 开发工具包
+基于 [Satori](https://satori.chat/zh-CN/protocol) 协议的 Python 开发工具包
 
 ## 协议介绍
 
-[Satori Protocol](https://satori.chat/zh-CN/)
+[Satori Protocol](https://satori.chat/zh-CN/protocol)
 
 ### 协议端
 

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "satori-python-adapter-qq"
-version = "0.2.0"
+version = "0.3.0"
 authors = [
     { name = "RF-Tar-Railt", email = "rf_tar_railt@qq.com" },
 ]
@@ -15,11 +15,11 @@ classifiers = [
     "Typing :: Typed",
     "Development Status :: 4 - Beta",
     "License :: OSI Approved :: MIT License",
-    "Programming Language :: Python :: 3.8",
-    "Programming Language :: Python :: 3.9",
     "Programming Language :: Python :: 3.10",
     "Programming Language :: Python :: 3.11",
     "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
     "Operating System :: OS Independent",
 ]
 

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/src/satori/adapters/qq/api.py

@@ -29,7 +29,7 @@ from satori.server.route import (
 )
 
 from .message import QQGroupMessageEncoder, QQGuildMessageEncoder, decode_segments
-from .utils import QQBotNetwork, decode_channel, decode_guild, decode_member, decode_user
+from .utils import ROLE_MAPPING, QQBotNetwork, decode_channel, decode_guild, decode_member, decode_user
 
 
 def apply(
@@ -356,7 +356,13 @@ def apply(
                 "get",
                 f"guilds/{guild_id}/roles",
             )
-            roles = [Role(role["id"], role.get("name", "")) for role in res]
+            # roles = [Role(role["id"], role.get("name", "")) for role in res]
+            roles = []
+            for role in res:
+                if role["id"] in ROLE_MAPPING:
+                    roles.append(ROLE_MAPPING[role["id"]])
+                else:
+                    roles.append(Role(role["id"], role.get("name", "")))
             return PageResult(roles, next=None)
         raise NotFoundException("qq platform does not support guild.role.list")
 

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/src/satori/adapters/qq/events/group.py

@@ -3,7 +3,7 @@ from __future__ import annotations
 from datetime import datetime
 
 from satori import EventType
-from satori.model import Event, Guild, User
+from satori.model import Channel, ChannelType, Event, Guild, User
 
 from ..utils import Payload
 from .base import register_event
@@ -27,6 +27,8 @@ async def friend_event(login, guild_login, net, payload: Payload):
         ),
         login,
         user=user,
+        channel=Channel(f"private:{user.id}", type=ChannelType.DIRECT),
+        referrer={"event_id": payload.id},
     )
 
 
@@ -52,5 +54,7 @@ async def group_event(login, guild_login, net, payload: Payload):
         ),
         login,
         guild=guild,
+        channel=Channel(guild.id, type=ChannelType.TEXT),
         operator=operator,
+        referrer={"event_id": payload.id},
     )

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/src/satori/adapters/qq/events/guild.py

@@ -5,7 +5,7 @@ from datetime import datetime
 from satori import EventType
 from satori.model import Event, Guild, Member, Role, User
 
-from ..utils import Payload, decode_channel, decode_guild, decode_user
+from ..utils import ROLE_MAPPING, Payload, decode_channel, decode_guild, decode_user
 from .base import register_event
 
 
@@ -57,7 +57,7 @@ async def guild_member_event(login, guild_login, net, payload: Payload):
         nick=raw["nick"],
         avatar=user.avatar,
         joined_at=datetime.fromisoformat(raw["joined_at"]),
-        roles=[Role(r) for r in raw["roles"]],
+        roles=[(ROLE_MAPPING.get(r) or Role(r)) for r in raw["roles"]],
     )
     operator = User(raw["op_user_id"])
     return Event(t, datetime.now(), guild_login, guild=guild, user=user, member=member, operator=operator)

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/src/satori/adapters/qq/events/message.py

@@ -6,7 +6,7 @@ from satori import At, EventType, Text
 from satori.model import Channel, ChannelType, EmojiObject, Event, Guild, Member, MessageObject, Role, User
 
 from ..message import decode_segments
-from ..utils import USER_AVATAR_URL, Payload, decode_user
+from ..utils import ROLE_MAPPING, USER_AVATAR_URL, Payload, decode_user
 from .base import register_event
 
 
@@ -21,7 +21,7 @@ async def at_message(login, guild_login, net, payload: Payload):
         user,
         avatar=user.avatar,
         joined_at=datetime.fromisoformat(raw["member"]["joined_at"]),
-        roles=[Role(r) for r in raw["member"]["roles"]],
+        roles=[(ROLE_MAPPING.get(r) or Role(r)) for r in raw["member"]["roles"]],
     )
     msg = decode_segments(raw)
     if len(msg) >= 2 and isinstance(msg[0], At) and isinstance(msg[1], Text):
@@ -90,13 +90,17 @@ async def group_at_message_create(login, guild_login, net, payload: Payload):
     else:
         channel = Channel(raw["group_id"], ChannelType.TEXT)
     app_id = net.bot_id_mapping[login.id]
+    name = raw["author"].get("username")
     if "member_openid" in raw["author"]:
         user = User(
             raw["author"]["member_openid"],
+            name=name,
             avatar=USER_AVATAR_URL.format(app_id=app_id, user_id=raw["author"]["member_openid"]),
         )
     else:
-        user = User(raw["author"]["id"], avatar=USER_AVATAR_URL.format(app_id=app_id, user_id=raw["author"]["id"]))
+        user = User(
+            raw["author"]["id"], name=name, avatar=USER_AVATAR_URL.format(app_id=app_id, user_id=raw["author"]["id"])
+        )
     member = Member(user, avatar=user.avatar)
     msg = decode_segments(raw)
     msg.insert(0, At(login.id))
@@ -122,6 +126,7 @@ async def group_at_message_create(login, guild_login, net, payload: Payload):
         referrer={
             "msg_id": raw["id"],
             "msg_seq": -1,
+            "msg_scene": raw["message_scene"],
         },
     )
 
@@ -130,13 +135,17 @@ async def group_at_message_create(login, guild_login, net, payload: Payload):
 async def c2c_message_create(login, guild_login, net, payload: Payload):
     raw = payload.data
     app_id = net.bot_id_mapping[login.id]
+    name = raw["author"].get("username")
     if "user_openid" in raw["author"]:
         user = User(
             raw["author"]["user_openid"],
+            name,
             avatar=USER_AVATAR_URL.format(app_id=app_id, user_id=raw["author"]["user_openid"]),
         )
     else:
-        user = User(raw["author"]["id"], avatar=USER_AVATAR_URL.format(app_id=app_id, user_id=raw["author"]["id"]))
+        user = User(
+            raw["author"]["id"], name, avatar=USER_AVATAR_URL.format(app_id=app_id, user_id=raw["author"]["id"])
+        )
     channel = Channel(f"private:{user.id}", ChannelType.DIRECT)
     return Event(
         EventType.MESSAGE_CREATED,
@@ -153,6 +162,7 @@ async def c2c_message_create(login, guild_login, net, payload: Payload):
             "direct": True,
             "msg_id": raw["id"],
             "msg_seq": -1,
+            "msg_scene": raw["message_scene"],
         },
     )
 
@@ -169,7 +179,7 @@ async def message_delete(login, guild_login, new, payload: Payload):
         user,
         avatar=user.avatar,
         joined_at=datetime.fromisoformat(raw["message"]["member"]["joined_at"]),
-        roles=[Role(r) for r in raw["message"]["member"]["roles"]],
+        roles=[(ROLE_MAPPING.get(r) or Role(r)) for r in raw["message"]["member"]["roles"]],
     )
     return Event(
         EventType.MESSAGE_DELETED,

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/src/satori/adapters/qq/main.py

@@ -438,5 +438,8 @@ class QQBotWebhookAdapter(BaseAdapter):
         await self.handle_event(app_id, payload)
         return Response(status_code=200)
 
+    def __str__(self):
+        return self.id
+
 
 __all__ = ["QQBotWebhookAdapter"]

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/src/satori/adapters/qq/message.py

@@ -9,7 +9,7 @@ from pathlib import Path
 
 from loguru import logger
 
-from satori.element import Button, Custom, E, Element, select, transform
+from satori.element import Button, Custom, E, Element, Raw, select, transform
 from satori.model import Login, MessageObject
 from satori.parser import Element as RawElement
 from satori.parser import parse
@@ -241,9 +241,12 @@ class QQGroupMessageEncoder(QQBotMessageEncoder):
     def __init__(self, login: Login, net: QQBotNetwork, channel_id: str, referrer: dict | None = None):
         super().__init__(login, net, channel_id, referrer)
         self.use_markdown = False
+        self.has_ark = False
         self.content = ""
+        self.reference = ""
         self.attachment: dict | None = None
         self.rows: list[list[dict]] = []
+        self.md_templates: dict | None = None
         # self.file_url = ""
         # self.file_data = {}  # value, content_type, filename
 
@@ -251,24 +254,33 @@ class QQGroupMessageEncoder(QQBotMessageEncoder):
         if not self.content and not self.attachment and not self.rows:
             return
         self.strip_buttons()
+        event_id = self.referrer.get("event_id") if self.referrer else None
         msg_id = self.referrer.get("msg_id") if self.referrer else None
         msg_seq = self.referrer.get("msg_seq") if self.referrer else None
+        msg_scene = self.referrer.get("msg_scene", {}) if self.referrer else {}
+        refidx = msg_scene.get("ext", ["="])[0].partition("=")[-1]
         data = {
             "content": self.content,
+            "message_reference": {"message_id": refidx or self.reference} if refidx or self.reference else None,
             "msg_type": 0,
+            "event_id": event_id,
             "msg_id": msg_id,
             "msg_seq": (msg_seq + 1) if isinstance(msg_seq, int) else 0,
         }
-        if self.attachment:
+        if self.has_ark:
+            data["msg_type"] = 3
+            data["ark"] = json.loads(self.content) if self.content else {}
+        elif self.attachment:
             if not self.content:
                 self.content = " "
             data["media"] = self.attachment
             data["msg_type"] = 7
-        if self.use_markdown:
+        elif self.use_markdown:
             data["msg_type"] = 2
             del data["content"]
             data["markdown"] = {
-                "content": escape_markdown(self.content) or " ",
+                "content": self.content or " ",  # escape_markdown(self.content) or " ",
+                **(self.md_templates or {}),
             }
             if self.rows:
                 data["keyboard"] = {"content": {"rows": self.export_buttons()}}
@@ -286,6 +298,7 @@ class QQGroupMessageEncoder(QQBotMessageEncoder):
                 resp = await self.net.call_api("post", endpoint, remove_empty(data))
             referrer = self.referrer.copy() if self.referrer else {}
             referrer |= {
+                "event_id": event_id,
                 "msg_id": msg_id,
                 "msg_seq": data["msg_seq"],
             }
@@ -293,8 +306,11 @@ class QQGroupMessageEncoder(QQBotMessageEncoder):
         except Exception as e:
             logger.error(f"Failed to send message to {self.channel_id}: {self._raw_content}\nError: {e}")
         self.content = ""
+        self.reference = ""
         self.attachment = None
+        self.has_ark = False
         self.use_markdown = False
+        self.md_templates = None
         self.rows = []
 
     async def send_file(self, type_: str, attrs: dict) -> dict | None:
@@ -340,7 +356,7 @@ class QQGroupMessageEncoder(QQBotMessageEncoder):
                 self.content += attrs["text"]
             case "img" | "image":
                 if attrs.get("src") or attrs.get("url"):
-                    await self.flush()
+                    # await self.flush()
                     if data := (await self.send_file(type_, attrs)):
                         self.attachment = data
             case "video" | "audio" | "file":
@@ -357,6 +373,11 @@ class QQGroupMessageEncoder(QQBotMessageEncoder):
                 await self.render(children)
                 if not self.content.endswith("\n"):
                     self.content += "\n"
+            case "qq:ark":
+                await self.flush()
+                self.has_ark = True
+                await self.render(children)
+                await self.flush()
             case "qq:button-group":
                 self.use_markdown = True
                 self.rows.append([])
@@ -369,10 +390,21 @@ class QQGroupMessageEncoder(QQBotMessageEncoder):
             case "markdown":
                 self.use_markdown = True
                 await self.render(children)
+            case "qq:markdown":
+                self.use_markdown = True
+                if attrs.get("template_id"):
+                    self.md_templates = {
+                        "custom_template_id": attrs["template_id"],
+                        "params": [{"key": k, "value": v} for k, v in attrs.items() if k != "template_id"],
+                    }
+                await self.render(children)
             case "message":
                 await self.flush()
                 await self.render(children)
                 await self.flush()
+            case "quote":
+                self.reference = attrs["id"]
+                await self.flush()
             case _:
                 await self.render(children)
 
@@ -466,5 +498,5 @@ def decode_segments(event: dict) -> list[Element]:
         for i in embeds:
             result.append(Custom("qq:embed", i))
     if ark := event.get("ark"):
-        result.append(Custom("qq:ark", ark))
+        result.append(Custom("qq:ark", children=[Raw(json.dumps(ark, ensure_ascii=False))]))
     return result

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/src/satori/adapters/qq/utils.py

@@ -122,15 +122,16 @@ def decode_member(profile: dict) -> Member:
         decode_user(profile["user"]) if "user" in profile else None,
         profile.get("nick"),
         joined_at=datetime.fromisoformat(profile["joined_at"]) if "joined_at" in profile else None,
-        roles=[Role(r) for r in profile["roles"]],
+        roles=[(ROLE_MAPPING.get(r) or Role(r)) for r in profile["roles"]],
     )
 
 
 USER_AVATAR_URL = "https://q.qlogo.cn/qqapp/{app_id}/{user_id}/100"
 
 
-# ROLE_MAPPING = {
-#     "member": Role("MEMBER", "群成员"),
-#     "admin": Role("ADMINISTRATOR", "管理员"),
-#     "owner": Role("OWNER", "群主"),
-# }
+ROLE_MAPPING = {
+    "1": Role("member", "成员"),
+    "5": Role("channel_admin", "子频道管理员"),
+    "2": Role("admin", "管理员"),
+    "4": Role("owner", "创建者"),
+}

{satori_python_adapter_qq-0.2.0 → satori_python_adapter_qq-0.3.0}/src/satori/adapters/qq/websocket.py

@@ -55,25 +55,36 @@ QQ_GUILD_FEATURES = [
 @dataclass
 class Intents:
     guilds: bool = True
+    """频道和子频道的基础事件"""
     guild_members: bool = True
+    """频道成员事件"""
     guild_messages: bool = False
-    """GUILD_MESSAGES"""
+    """频道消息事件，仅私域机器人能够设置此 intents。"""
     guild_message_reactions: bool = True
-    direct_message: bool = False
-    """DIRECT_MESSAGES"""
+    """频道消息表态事件"""
+    direct_messages: bool = False
+    """频道私信消息事件"""
     open_forum_event: bool = False
     audio_live_member: bool = False
     c2c_group_at_messages: bool = False
+    """群聊和单聊事件"""
     interaction: bool = False
+    """互动事件（由按钮等组件触发的事件）"""
     message_audit: bool = True
+    """频道消息审核事件（由消息审核结果触发的事件）"""
     forum_event: bool = False
+    """频道论坛事件，仅私域机器人能够设置此 intents。"""
     audio_action: bool = False
+    """语音频道事件"""
     at_messages: bool = True
-    """PUBLIC_GUILD_MESSAGES"""
+    """频道消息事件（只包含被 @ 的消息），为公域的消息事件"""
 
     def __post_init__(self):
         if self.at_messages and self.guild_messages:
-            logger.warning("at_messages and guild_messages are both enabled, which is not recommended.")
+            logger.warning(
+                "检测到 at_messages 和 guild_messages 同时开启。"
+                "请确认 bot 是否为公域机器人，若为公域机器人，则开启 guild_messages 将导致连接鉴权失败。"
+            )
 
     def to_int(self) -> int:
         return (
@@ -81,7 +92,7 @@ class Intents:
             | self.guild_members << 1
             | self.guild_messages << 9
             | self.guild_message_reactions << 10
-            | self.direct_message << 12
+            | self.direct_messages << 12
             | self.open_forum_event << 18
             | self.audio_live_member << 19
             | self.c2c_group_at_messages << 25
@@ -554,5 +565,8 @@ class QQBotWebsocketAdapter(BaseAdapter):
                 logger.info(f"{self} Reconnecting...")
                 continue
 
+    def __str__(self):
+        return self.id
+
 
 __all__ = ["QQBotWebsocketAdapter", "Intents"]