chore: Add PyPI package support for uvx/pip installation (#1764)

* Initial plan * Add package structure and resource path utilities - Created langbot/ package with __init__.py and __main__.py entry point - Added paths utility to find frontend and resource files from package installation - Updated config loading to use resource paths - Updated frontend serving to use resource paths - Added MANIFEST.in for package data inclusion - Updated pyproject.toml with build system and entry points Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com> * Add PyPI publishing workflow and update license - Created GitHub Actions workflow to build frontend and publish to PyPI - Added license field to pyproject.toml to fix deprecation warning - Updated .gitignore to exclude build artifacts - Tested package building successfully Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com> * Add PyPI installation documentation - Created PYPI_INSTALLATION.md with detailed installation and usage instructions - Updated README.md to feature uvx/pip installation as recommended method - Updated README_EN.md with same changes for English documentation Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com> * Address code review feedback - Made package-data configuration more specific to langbot package only - Improved path detection with caching to avoid repeated file I/O - Removed sys.path searching which was incorrect for package data - Removed interactive input() call for non-interactive environment compatibility - Simplified error messages for version check Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com> * Fix code review issues - Use specific exception types instead of bare except - Fix misleading comments about directory levels - Remove redundant existence check before makedirs with exist_ok=True - Use context manager for file opening to ensure proper cleanup Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com> * Simplify package configuration and document behavioral differences - Removed redundant package-data configuration, relying on MANIFEST.in - Added documentation about behavioral differences between package and source installation - Clarified that include-package-data=true uses MANIFEST.in for data files Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com> * chore: update pyproject.toml * chore: try pack templates in langbot/ * chore: update * chore: update * chore: update * chore: update * chore: update * chore: adjust dir structure * chore: fix imports * fix: read default-pipeline-config.json * fix: read default-pipeline-config.json * fix: tests * ci: publish pypi * chore: bump version 4.6.0-beta.1 for testing * chore: add templates/** * fix: send adapters and requesters icons * chore: bump version 4.6.0b2 for testing * chore: add platform field for docker-compose.yaml --------- Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: RockChinQ <45992437+RockChinQ@users.noreply.github.com> Co-authored-by: Junyan Qin <rockchinq@gmail.com>
2026-08-21 17:57:14 +00:00 · 2025-11-16 19:53:01 +08:00
parent 6a24c951e0
commit e642ffa5b3
477 changed files with 1001 additions and 1002 deletions
@@ -0,0 +1,333 @@
+# 加了之后会导致：https://github.com/Lxns-Network/nakuru-project/issues/25
+# from __future__ import annotations
+
+import asyncio
+import typing
+import traceback
+
+
+import nakuru
+import nakuru.entities.components as nkc
+
+from ....pipeline.longtext.strategies import forward
+import langbot_plugin.api.entities.builtin.platform.message as platform_message
+import langbot_plugin.api.entities.builtin.platform.entities as platform_entities
+import langbot_plugin.api.entities.builtin.platform.events as platform_events
+import langbot_plugin.api.definition.abstract.platform.adapter as abstract_platform_adapter
+from ...logger import EventLogger
+
+
+class NakuruProjectMessageConverter(abstract_platform_adapter.AbstractMessageConverter):
+    """消息转换器"""
+
+    @staticmethod
+    def yiri2target(message_chain: platform_message.MessageChain) -> list:
+        msg_list = []
+        if type(message_chain) is platform_message.MessageChain:
+            msg_list = message_chain.__root__
+        elif type(message_chain) is list:
+            msg_list = message_chain
+        elif type(message_chain) is str:
+            msg_list = [platform_message.Plain(message_chain)]
+        else:
+            raise Exception('Unknown message type: ' + str(message_chain) + str(type(message_chain)))
+
+        nakuru_msg_list = []
+
+        # 遍历并转换
+        for component in msg_list:
+            if type(component) is platform_message.Plain:
+                nakuru_msg_list.append(nkc.Plain(component.text, False))
+            elif type(component) is platform_message.Image:
+                if component.url is not None:
+                    nakuru_msg_list.append(nkc.Image.fromURL(component.url))
+                elif component.base64 is not None:
+                    nakuru_msg_list.append(nkc.Image.fromBase64(component.base64))
+                elif component.path is not None:
+                    nakuru_msg_list.append(nkc.Image.fromFileSystem(component.path))
+            elif type(component) is platform_message.At:
+                nakuru_msg_list.append(nkc.At(qq=component.target))
+            elif type(component) is platform_message.AtAll:
+                nakuru_msg_list.append(nkc.AtAll())
+            elif type(component) is platform_message.Voice:
+                if component.url is not None:
+                    nakuru_msg_list.append(nkc.Record.fromURL(component.url))
+                elif component.path is not None:
+                    nakuru_msg_list.append(nkc.Record.fromFileSystem(component.path))
+            elif type(component) is forward.Forward:
+                # 转发消息
+                yiri_forward_node_list = component.node_list
+                nakuru_forward_node_list = []
+
+                # 遍历并转换
+                for yiri_forward_node in yiri_forward_node_list:
+                    try:
+                        content_list = NakuruProjectMessageConverter.yiri2target(yiri_forward_node.message_chain)
+                        nakuru_forward_node = nkc.Node(
+                            name=yiri_forward_node.sender_name,
+                            uin=yiri_forward_node.sender_id,
+                            time=int(yiri_forward_node.time.timestamp())
+                            if yiri_forward_node.time is not None
+                            else None,
+                            content=content_list,
+                        )
+                        nakuru_forward_node_list.append(nakuru_forward_node)
+                    except Exception:
+                        import traceback
+
+                        traceback.print_exc()
+
+                nakuru_msg_list.append(nakuru_forward_node_list)
+            else:
+                nakuru_msg_list.append(nkc.Plain(str(component)))
+
+        return nakuru_msg_list
+
+    @staticmethod
+    def target2yiri(message_chain: typing.Any, message_id: int = -1) -> platform_message.MessageChain:
+        """将Yiri的消息链转换为YiriMirai的消息链"""
+        assert type(message_chain) is list
+
+        yiri_msg_list = []
+        import datetime
+
+        # 添加Source组件以标记message_id等信息
+        yiri_msg_list.append(platform_message.Source(id=message_id, time=datetime.datetime.now()))
+        for component in message_chain:
+            if type(component) is nkc.Plain:
+                yiri_msg_list.append(platform_message.Plain(text=component.text))
+            elif type(component) is nkc.Image:
+                yiri_msg_list.append(platform_message.Image(url=component.url))
+            elif type(component) is nkc.At:
+                yiri_msg_list.append(platform_message.At(target=component.qq))
+            elif type(component) is nkc.AtAll:
+                yiri_msg_list.append(platform_message.AtAll())
+            else:
+                pass
+        # logging.debug("转换后的消息链: " + str(yiri_msg_list))
+        chain = platform_message.MessageChain(yiri_msg_list)
+        return chain
+
+
+class NakuruProjectEventConverter(abstract_platform_adapter.AbstractEventConverter):
+    """事件转换器"""
+
+    @staticmethod
+    def yiri2target(event: typing.Type[platform_events.Event]):
+        if event is platform_events.GroupMessage:
+            return nakuru.GroupMessage
+        elif event is platform_events.FriendMessage:
+            return nakuru.FriendMessage
+        else:
+            raise Exception('未支持转换的事件类型: ' + str(event))
+
+    @staticmethod
+    def target2yiri(event: typing.Any) -> platform_events.Event:
+        yiri_chain = NakuruProjectMessageConverter.target2yiri(event.message, event.message_id)
+        if type(event) is nakuru.FriendMessage:  # 私聊消息事件
+            return platform_events.FriendMessage(
+                sender=platform_entities.Friend(
+                    id=event.sender.user_id,
+                    nickname=event.sender.nickname,
+                    remark=event.sender.nickname,
+                ),
+                message_chain=yiri_chain,
+                time=event.time,
+            )
+        elif type(event) is nakuru.GroupMessage:  # 群聊消息事件
+            permission = 'MEMBER'
+
+            if event.sender.role == 'admin':
+                permission = 'ADMINISTRATOR'
+            elif event.sender.role == 'owner':
+                permission = 'OWNER'
+
+            return platform_events.GroupMessage(
+                sender=platform_entities.GroupMember(
+                    id=event.sender.user_id,
+                    member_name=event.sender.nickname,
+                    permission=permission,
+                    group=platform_entities.Group(
+                        id=event.group_id,
+                        name=event.sender.nickname,
+                        permission=platform_entities.Permission.Member,
+                    ),
+                    special_title=event.sender.title,
+                    join_timestamp=0,
+                    last_speak_timestamp=0,
+                    mute_time_remaining=0,
+                ),
+                message_chain=yiri_chain,
+                time=event.time,
+            )
+        else:
+            raise Exception('未支持转换的事件类型: ' + str(event))
+
+
+class NakuruAdapter(abstract_platform_adapter.AbstractMessagePlatformAdapter):
+    """nakuru-project适配器"""
+
+    bot: nakuru.CQHTTP
+    bot_account_id: int
+
+    message_converter: NakuruProjectMessageConverter = NakuruProjectMessageConverter()
+    event_converter: NakuruProjectEventConverter = NakuruProjectEventConverter()
+
+    listener_list: list[dict]
+
+    # ap: app.Application
+
+    cfg: dict
+
+    def __init__(self, cfg: dict, ap, logger: EventLogger):
+        """初始化nakuru-project的对象"""
+        cfg['port'] = cfg['ws_port']
+        del cfg['ws_port']
+        self.cfg = cfg
+        self.ap = ap
+        self.logger = logger
+        self.listener_list = []
+        self.bot = nakuru.CQHTTP(**self.cfg)
+
+    async def send_message(
+        self,
+        target_type: str,
+        target_id: str,
+        message: typing.Union[platform_message.MessageChain, list],
+        converted: bool = False,
+    ):
+        task = None
+
+        converted_msg = self.message_converter.yiri2target(message) if not converted else message
+
+        # 检查是否有转发消息
+        has_forward = False
+        for msg in converted_msg:
+            if type(msg) is list:  # 转发消息，仅回复此消息组件
+                has_forward = True
+                converted_msg = msg
+                break
+        if has_forward:
+            if target_type == 'group':
+                task = self.bot.sendGroupForwardMessage(int(target_id), converted_msg)
+            elif target_type == 'person':
+                task = self.bot.sendPrivateForwardMessage(int(target_id), converted_msg)
+            else:
+                raise Exception('Unknown target type: ' + target_type)
+        else:
+            if target_type == 'group':
+                task = self.bot.sendGroupMessage(int(target_id), converted_msg)
+            elif target_type == 'person':
+                task = self.bot.sendFriendMessage(int(target_id), converted_msg)
+            else:
+                raise Exception('Unknown target type: ' + target_type)
+
+        await task
+
+    async def reply_message(
+        self,
+        message_source: platform_events.MessageEvent,
+        message: platform_message.MessageChain,
+        quote_origin: bool = False,
+    ):
+        message = self.message_converter.yiri2target(message)
+        if quote_origin:
+            # 在前方添加引用组件
+            message.insert(
+                0,
+                nkc.Reply(
+                    id=message_source.message_chain.message_id,
+                ),
+            )
+        if type(message_source) is platform_events.GroupMessage:
+            await self.send_message('group', message_source.sender.group.id, message, converted=True)
+        elif type(message_source) is platform_events.FriendMessage:
+            await self.send_message('person', message_source.sender.id, message, converted=True)
+        else:
+            raise Exception('Unknown message source type: ' + str(type(message_source)))
+
+    def is_muted(self, group_id: int) -> bool:
+        import time
+
+        # 检查是否被禁言
+        group_member_info = asyncio.run(self.bot.getGroupMemberInfo(group_id, self.bot_account_id))
+        return group_member_info.shut_up_timestamp > int(time.time())
+
+    def register_listener(
+        self,
+        event_type: typing.Type[platform_events.Event],
+        callback: typing.Callable[
+            [platform_events.Event, abstract_platform_adapter.AbstractMessagePlatformAdapter], None
+        ],
+    ):
+        try:
+            source_cls = NakuruProjectEventConverter.yiri2target(event_type)
+
+            # 包装函数
+            async def listener_wrapper(app: nakuru.CQHTTP, source: source_cls):  # type: ignore
+                await callback(self.event_converter.target2yiri(source), self)
+
+            # 将包装函数和原函数的对应关系存入列表
+            self.listener_list.append(
+                {
+                    'event_type': event_type,
+                    'callable': callback,
+                    'wrapper': listener_wrapper,
+                }
+            )
+
+            # 注册监听器
+            self.bot.receiver(source_cls.__name__)(listener_wrapper)
+        except Exception as e:
+            self.logger.error(f'Error in nakuru register_listener: {traceback.format_exc()}')
+            raise e
+
+    def unregister_listener(
+        self,
+        event_type: typing.Type[platform_events.Event],
+        callback: typing.Callable[
+            [platform_events.Event, abstract_platform_adapter.AbstractMessagePlatformAdapter], None
+        ],
+    ):
+        nakuru_event_name = self.event_converter.yiri2target(event_type).__name__
+
+        new_event_list = []
+
+        # 从本对象的监听器列表中查找并删除
+        target_wrapper = None
+        for listener in self.listener_list:
+            if listener['event_type'] == event_type and listener['callable'] == callback:
+                target_wrapper = listener['wrapper']
+                self.listener_list.remove(listener)
+                break
+
+        if target_wrapper is None:
+            raise Exception('未找到对应的监听器')
+
+        for func in self.bot.event[nakuru_event_name]:
+            if func.callable != target_wrapper:
+                new_event_list.append(func)
+
+        self.bot.event[nakuru_event_name] = new_event_list
+
+    async def run_async(self):
+        try:
+            import requests
+
+            resp = requests.get(
+                url='http://{}:{}/get_login_info'.format(self.cfg['host'], self.cfg['http_port']),
+                headers={'Authorization': 'Bearer ' + self.cfg['token'] if 'token' in self.cfg else ''},
+                timeout=5,
+                proxies=None,
+            )
+            if resp.status_code == 403:
+                raise Exception('go-cqhttp拒绝访问，请检查配置文件中nakuru适配器的配置')
+            self.bot_account_id = int(resp.json()['data']['user_id'])
+        except Exception:
+            raise Exception('获取go-cqhttp账号信息失败, 请检查是否已启动go-cqhttp并配置正确')
+        await self.bot._run()
+        while True:
+            await asyncio.sleep(1)
+
+    async def kill(self) -> bool:
+        return False