mirror of
https://github.com/AstrBotDevs/AstrBot
synced 2026-07-16 01:40:15 +08:00
* Add legacy session waiter compatibility * Expand legacy astrbot package compatibility * Tighten external legacy plugin compatibility smoke tests * Consolidate controlled legacy facade compatibility * docs: clarify compat package boundaries * test: align runtime fixtures with maintained samples * fix: preserve unicode sample fixtures in runtime tests * Implement legacy hook and tool compat runtime * Refactor legacy runtime execution boundary * 增强旧版兼容性,添加多个旧路径入口和相关功能 * 增强旧版兼容性,添加适配器边界的启动和关闭钩子支持 * Refactor legacy API and LLM compatibility logic - Moved legacy LLM and tool compatibility logic from `_legacy_api.py` to a new module `_legacy_llm.py` for better organization and separation of concerns. - Updated `_legacy_api.py` to import necessary components from `_legacy_llm.py`, removing redundant code. - Enhanced database client functionality by adding support for batch read/write operations and change event subscriptions. - Improved documentation in the database client and capability router to reflect new features. - Refined environment management process in the loader to better handle plugin grouping and virtual environment management. * 补充插件分组环境测试覆盖 * feat: Enhance CLI and testing capabilities - Added a new script entry point `astrbot-sdk` in `pyproject.toml`. - Introduced `has_waiter` method in `SessionWaiterManager` to check for existing waiters. - Updated `cli.py` to improve error handling and added context to error messages. - Implemented local development support in `cli.py` with a new `dev` command for running plugins against a mock core. - Created a new testing module `astrbot_sdk.testing` with utilities for local development and plugin testing. - Added comprehensive tests for the new testing module and CLI commands. - Improved compatibility and error messaging for plugin loading failures. * feat: 添加插件初始化、验证和构建命令,增强 CLI 功能 * feat: add platform client documentation and examples - Introduced platform client documentation in `docs/v4/clients/platform.md` detailing methods for sending messages, images, and managing group members. - Added example plugins for LLM chat and database functionalities in `docs/v4/examples/README.md`, `docs/v4/examples/llm-chat/README.md`, and `docs/v4/examples/database/README.md`. - Enhanced quickstart guide with links to new documentation and example plugins. - Implemented runtime contract tests to ensure compatibility of public capabilities and hooks. * Refactor legacy runtime handling and improve plugin loading - Updated `handler_dispatcher.py` to streamline legacy runtime preparation and dispatching results. - Enhanced `loader.py` to simplify legacy plugin detection and manifest building. - Added tests for new HTTPClient and MetadataClient functionalities. - Introduced tests for legacy context metadata methods and legacy loader helpers. - Improved legacy runtime tests to cover new functionality and edge cases. * refactor: 更新兼容层和导入路径,优化文档描述 * Support grouped plugin workers in shared environments - add group metadata driven worker startup for shared env plans - track per-plugin handler and capability ownership inside grouped workers - update runtime and smoke tests for grouped worker session behavior * Add v4 compat layer and legacy shims - Introduce private v4 compatibility surface using _legacy_api.py, _legacy_runtime.py, _legacy_loader.py plus new _legacy_context.py and _legacy_star.py to centralize legacy adapters while keeping public APIs thin. - Extend InitializeOutput to carry protocol_version for negotiated protocol, enabling runtime to adapt to the chosen v4 version. - Add lightweight legacy support for Star/Context via new LegacyStar and LegacyContext shims and expose legacy API through the aggregate _legacy_api entry point. - Ensure legacy loader preserves class declaration order by iterating module.__dict__ instead of relying on alphabetical sorting. - Add tests: protocol_version handling in InitializeOutput, legacy main component order preservation, and embedded-newline framing in transport tests. * Add architecture doc and refine API compat - Add PROJECT_ARCHITECTURE.md documenting architecture, compat surface, and testing notes. - Update astrbot_sdk.api.__init__ to clarify it is a compatibility implementation layer, not a simple facade, and list migration targets. - Normalize platform in AstrMessageEvent.to_payload to emit a string id by using get_platform_id(). * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * delete old sdk * delete old sdk (#7) Co-authored-by: whatevertogo <whatevertogo@users.noreply.github.com> * feat(cli): normalize plugin init skeletons Add interactive plugin init prompts and normalize generated plugin names to the astrbot_plugin_ convention. Update CLI tests for the new skeleton layout and ignore generated plugin directories in git and coverage tooling. Also include related runtime logging adjustments from the current worktree. * Create lint.yml * Update lint.yml * clean it * feat: Enhance handler and capability dispatchers with improved error handling - Updated HandlerDispatcher to raise TypeError for uninjectable required parameters, logging errors appropriately. - Refactored CapabilityDispatcher to raise TypeError for missing required parameters during capability execution. - Renamed _load_plugin_config to load_plugin_config for clarity and consistency. - Introduced _sync_plugin_registry method in SupervisorRuntime to manage plugin capabilities more effectively. - Enhanced capability registration logic to handle naming conflicts with better logging and automatic renaming. - Added tests for handler and capability dispatchers to ensure proper error handling and functionality. - Implemented new HTTP and metadata capabilities with corresponding tests for registration and retrieval. - Improved MemoryClient methods with additional tests for save_with_ttl, get_many, delete_many, and stats. - Added tests for the testing module to ensure proper import and functionality of PluginHarness. * feat: 更新 SDK 描述,重构插件调用上下文,移除插件 ID 传递,增强能力路由和 HTTP 客户端的插件身份管理 * refactor: 更新文档和代码注释,优化兼容性描述,增强可读性 * feat: 添加插件热重载功能,支持文件变更时自动重新加载插件 * feat: 增强错误处理,添加上下文信息,优化插件组件加载和参数注入校验 * feat: 添加 hello_plugin 示例,包含插件结构、命令处理和测试用例 * refactor: 删除过时的架构文档、变更日志和兼容矩阵文件 * refactor: 更新兼容层弃用通知,优化文档结构和可读性 * refactor: 更新项目架构文档,增强能力客户端和执行边界的描述,移除兼容层设计章节 * feat(errors): Enhance AstrBotError with detailed documentation and examples feat(events): Expand MessageEvent with reply capabilities and detailed docstrings fix(loader): Ensure plugin path is correctly managed in sys.path feat(star): Improve Star class documentation and lifecycle method descriptions feat(testing): Add plugin metadata handling in MockContext and enhance PluginHarness feat(hello): Refactor HelloPlugin to utilize new reply methods and structured capabilities test(decorators): Add tests for input/output model support in provide_capability test(events): Implement tests for reply_image and reply_chain methods in MessageEvent test(http): Validate API registration with capability handler references and error handling test(tests): Enhance tests for plugin harness and directory handling in dev commands * feat(runtime): add configurable msgpack wire codec support * fix(runtime): align msgpack framing with transport defaults * fix(runtime): preserve json transport compatibility * fix(cli): scope worker wire codec option * feat: 添加 AGENTS.md 文档,描述 v4 架构约束和开发命令 refactor: 更新 HandlerDispatcher 和 WorkerSession,增强参数处理和结果汇总逻辑 * fix(test): 更新 init_plugin 测试以匹配新的目录命名规范 CLI 的 _normalize_init_plugin_name 函数现在自动添加 astrbot_plugin_ 前缀, 测试期望的目录名从 demo_plugin 更新为 astrbot_plugin_demo_plugin。 * Refactor worker initialization and remove unused codec parameters; add schedule and session waiter modules - Simplified `GroupWorkerRuntime` and `PluginWorkerRuntime` constructors by removing the codec parameter and related logic. - Introduced `schedule.py` to define `ScheduleContext` for managing scheduled tasks with a clear structure and payload handling. - Added `session_waiter.py` for session-based conversational flow management, including `SessionController` and `SessionWaiterManager` for handling multi-turn dialogues. - Enhanced testing utilities in `testing.py` by removing unused classes and streamlining the structure. - Created `types.py` to introduce `GreedyStr` for improved command parameter parsing. * feat: 添加 LLM 工具管理和会话级别状态管理能力 - 新增 llm/ 模块,包含 LLMToolSpec、ProviderRequest、AgentSpec 等实体 - 新增 LLMToolManager 用于管理 LLM 工具注册和激活状态 - 新增 SessionPluginManager 用于会话级别的插件启用状态管理 - 新增 SessionServiceManager 用于会话级别的 LLM/TTS 服务状态管理 - 新增 RegistryClient 用于查询 handler 元数据和设置白名单 - 扩展 CapabilityRouter 内置能力,支持 session.* 和 registry.* 命名空间 - 增强描述符和装饰器以支持新的 trigger 类型 * feat: 大幅增强 SDK 核心功能和文档 新增模块: - clients/files.py: 文件上传/下载客户端 - clients/managers.py: 会话/LLM/Provider 管理器 - clients/provider.py: LLM Provider 客户端 - conversation.py: 对话上下文管理 - plugin_kv.py: 插件 KV 存储辅助 - runtime/limiter.py: 限流器 - star_tools.py: Star 工具函数 - docs/: 完整的 SDK 使用文档 (01-05) 功能增强: - Context 大幅扩展,增加 reply/send_image/typing 等便捷方法 - 装饰器增强,支持 on_llm_request/on_provider_request 等 - 内置 schemas 扩展,覆盖更多 capability 定义 - capability_router_builtins 大幅扩展内置能力实现 - handler_dispatcher 增强参数注入和错误处理 - Star 基类增加生命周期钩子和工具方法 * Add comprehensive API documentation for types and utilities in AstrBot SDK - Introduced `types.md` detailing type aliases, generics, and Pydantic models used in the SDK. - Added `utils.md` covering utility classes and functions including CancelToken, MessageSession, command groups, and session management. - Included usage examples and detailed descriptions for each component to enhance developer understanding and ease of use. * feat: 添加高级方法和辅助函数文档,增强消息组件和事件处理功能 * feat: 增强过滤器类型和能力路由文档,添加 Provider 和会话管理功能 * change location * delete no need thing * delete again * feat: add Star plugin base class and StarTools utility class - Introduced `Star` class as a base for v4 native plugins, providing lifecycle methods and context management. - Added `StarTools` class for accessing runtime context and managing LLM tools. - Implemented `PluginHarness` for local development and testing of plugins, allowing for message dispatching and lifecycle management. - Created `GreedyStr` type for enhanced command parameter parsing, enabling the capture of remaining command text as a single argument. - Added testing utilities and mock capabilities for plugin development. * delete: remove hello_plugin example and its related files * Remove obsolete test files for testing module, top-level modules, transport, and wire codecs - Deleted `test_testing_module.py` as it is no longer needed. - Removed `test_top_level_modules.py` which had no content. - Eliminated `test_transport.py` due to redundancy. - Cleared out `test_wire_codecs.py` as part of the cleanup. * fix(runtime): avoid creating Star instance in on_error fallback * fix(runtime): avoid virtual dispatch in Star.on_error fallback * refactor(runtime): unify command matching logic (#25) * refactor(testing): share command matching with handler dispatcher * fix:添加公共函数文件 * fix: simplify register_task completion handling (#27) * fix: simplify register_task completion handling Remove duplicated cancellation logging in Context.register_task while keeping Future inputs compatible with asyncio.create_task semantics. Add regression coverage for coroutine, Future, cancellation, and failure paths. * fix: prioritize local src in tests_v4 Ensure tests_v4 always imports the working tree package by moving src to sys.path[0] even when another checkout or installed copy is already present. * chore: sync subtree from AstrBot * feat: replay non-sdk changes on clean sdk subtree baseline * feat(sdk): add merged provider config capability support Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> * feat(sdk): add merged provider config bridge and client Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> * feat(sdk): add merged provider config capability support Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> * fix(sdk): tighten bridge cast typing Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> * feat(sdk): add merged provider config bridge and client Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> * test(sdk): cover merged provider config parity Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> * feat: 完善 memory 向量检索与索引统计 (#28) Co-authored-by: united_pooh <united_pooh@outlook.com> * feat(tests): 添加测试用例以验证 register_task 的行为并更新测试运行说明 * Merge commit 'e45bade147ff44b43860ecff12067309e59c151a' into feat/sdk-integration * Squashed 'astrbot-sdk/' changes from 7dda6077..85342f1485342f14feat(tests): 添加测试用例以验证 register_task 的行为并更新测试运行说明fdffc09bMerge pull request #26 from united-pooh/fix/fix-star-on-error-fallback3b09747cfeat: 完善 memory 向量检索与索引统计 (#28)665c9c69fix(runtime): avoid virtual dispatch in Star.on_error fallback200559a5fix(runtime): avoid creating Star instance in on_error fallback git-subtree-dir: astrbot-sdk git-subtree-split:85342f149b* feat(tests): 添加测试用例以验证平台和消息类型过滤器的冲突处理 * docs: remove redundant testing instructions from AGENTS.md * docs: remove redundant testing instructions from AGENTS.md * docs: remove redundant testing instructions from AGENTS.md * Merge commit '5ac9401852ddb46f337da6bcc0f9b66eed265da9' into feat/sdk-integration * Squashed 'astrbot-sdk/' changes from 85342f14..09beabeb09beabebfeat(tests): 添加测试用例以验证平台和消息类型过滤器的冲突处理 git-subtree-dir: astrbot-sdk git-subtree-split:09beabeb62* feat: enhance SDK plugin configuration handling and logging * feat: enhance SDK plugin configuration handling and logging * feat: enhance SDK plugin configuration handling and logging * feat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器 * feat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器 * feat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器 * feat: 更新文档以反映SDK负载的JSON可序列化要求和延迟导入设计约束 * feat: add conversation.get_current capability and related schemas - Introduced CONVERSATION_GET_CURRENT_INPUT_SCHEMA and CONVERSATION_GET_CURRENT_OUTPUT_SCHEMA for handling current conversation requests. - Implemented _conversation_get_current method in BuiltinCapabilityRouterMixin to manage current conversation retrieval and creation. - Registered the new capability in CoreCapabilityBridge. - Enhanced HandlerDispatcher to inject provider request, LLM response, and event result payloads into the event handling process. - Updated tests to validate the new functionality and ensure proper payload handling. * feat: add conversation.get_current capability and related schemas - Introduced CONVERSATION_GET_CURRENT_INPUT_SCHEMA and CONVERSATION_GET_CURRENT_OUTPUT_SCHEMA for handling current conversation requests. - Implemented _conversation_get_current method in BuiltinCapabilityRouterMixin to manage current conversation retrieval and creation. - Registered the new capability in CoreCapabilityBridge. - Enhanced HandlerDispatcher to inject provider request, LLM response, and event result payloads into the event handling process. - Updated tests to validate the new functionality and ensure proper payload handling. * feat: add conversation.get_current capability and related schemas - Introduced CONVERSATION_GET_CURRENT_INPUT_SCHEMA and CONVERSATION_GET_CURRENT_OUTPUT_SCHEMA for handling current conversation requests. - Implemented _conversation_get_current method in BuiltinCapabilityRouterMixin to manage current conversation retrieval and creation. - Registered the new capability in CoreCapabilityBridge. - Enhanced HandlerDispatcher to inject provider request, LLM response, and event result payloads into the event handling process. - Updated tests to validate the new functionality and ensure proper payload handling. * Refactor tool call handling in SdkPluginBridge - Introduced a dictionary to map tool call IDs to tool names for better clarity and efficiency. - Enhanced the extraction of tool call information from raw results, ensuring compatibility with both dictionary and object formats. - Updated the logic to retrieve tool names based on tool call IDs, improving the robustness of the tool calls result processing. * Refactor tool call handling in SdkPluginBridge - Introduced a dictionary to map tool call IDs to tool names for better clarity and efficiency. - Enhanced the extraction of tool call information from raw results, ensuring compatibility with both dictionary and object formats. - Updated the logic to retrieve tool names based on tool call IDs, improving the robustness of the tool calls result processing. * Refactor tool call handling in SdkPluginBridge - Introduced a dictionary to map tool call IDs to tool names for better clarity and efficiency. - Enhanced the extraction of tool call information from raw results, ensuring compatibility with both dictionary and object formats. - Updated the logic to retrieve tool names based on tool call IDs, improving the robustness of the tool calls result processing. * feat: add session and system capabilities for plugin management and event handling - Implemented SessionCapabilityMixin with methods to manage session-level plugin states and handlers. - Added SystemCapabilityMixin to handle system-level functionalities including file management, event handling, and dynamic command registration. - Introduced methods for enabling/disabling plugins, filtering handlers, and managing LLM and TTS service states. - Registered various system capabilities for data directory access, HTML rendering, and event streaming. * feat: add session and system capabilities for plugin management and event handling - Implemented SessionCapabilityMixin with methods to manage session-level plugin states and handlers. - Added SystemCapabilityMixin to handle system-level functionalities including file management, event handling, and dynamic command registration. - Introduced methods for enabling/disabling plugins, filtering handlers, and managing LLM and TTS service states. - Registered various system capabilities for data directory access, HTML rendering, and event streaming. * Squashed 'astrbot-sdk/' changes from 09beabeb..3204c9db3204c9dbMerge sdk-remote dev into feat/sdk-integration3a2d715eRefactor tool call handling in SdkPluginBridgeed1b9665feat: add conversation.get_current capability and related schemase74123bbfeat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器bb361cf9feat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器c6237f52Merge sdk-remote/dev into astrbot-sdk subtreee12029fffeat: enhance SDK plugin configuration handling and logging5e54bbb3feat: enhance SDK plugin configuration handling and loggingf48e2041Merge commit '5ac9401852ddb46f337da6bcc0f9b66eed265da9' into feat/sdk-integration619672e6Merge commit '5ac9401852ddb46f337da6bcc0f9b66eed265da9' into feat/sdk-integrationd5a3796ddocs: remove redundant testing instructions from AGENTS.md323e3f4ddocs: remove redundant testing instructions from AGENTS.mdf8438a7bMerge commit 'e45bade147ff44b43860ecff12067309e59c151a' into feat/sdk-integration96d1df85Merge commit 'e45bade147ff44b43860ecff12067309e59c151a' into feat/sdk-integrationf8a7e253feat(sdk): add merged provider config bridge and client752dc6cffeat(sdk): add merged provider config capability support git-subtree-dir: astrbot-sdk git-subtree-split:3204c9db9f* Implement feature X to enhance user experience and optimize performance * Implement feature X to enhance user experience and optimize performance * chore(sdk): stop tracking uv.lock * feat(sdk): add merged provider config capability support Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> * feat(sdk): add merged provider config bridge and client Ultraworked with [Sisyphus](https://github.com/code-yeongyu/oh-my-openagent) Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> * feat(tests): 添加测试用例以验证 register_task 的行为并更新测试运行说明 * feat(tests): 添加测试用例以验证平台和消息类型过滤器的冲突处理 * docs: remove redundant testing instructions from AGENTS.md * feat: enhance SDK plugin configuration handling and logging * feat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器 * feat: add conversation.get_current capability and related schemas - Introduced CONVERSATION_GET_CURRENT_INPUT_SCHEMA and CONVERSATION_GET_CURRENT_OUTPUT_SCHEMA for handling current conversation requests. - Implemented _conversation_get_current method in BuiltinCapabilityRouterMixin to manage current conversation retrieval and creation. - Registered the new capability in CoreCapabilityBridge. - Enhanced HandlerDispatcher to inject provider request, LLM response, and event result payloads into the event handling process. - Updated tests to validate the new functionality and ensure proper payload handling. * Refactor tool call handling in SdkPluginBridge - Introduced a dictionary to map tool call IDs to tool names for better clarity and efficiency. - Enhanced the extraction of tool call information from raw results, ensuring compatibility with both dictionary and object formats. - Updated the logic to retrieve tool names based on tool call IDs, improving the robustness of the tool calls result processing. * feat: add session and system capabilities for plugin management and event handling - Implemented SessionCapabilityMixin with methods to manage session-level plugin states and handlers. - Added SystemCapabilityMixin to handle system-level functionalities including file management, event handling, and dynamic command registration. - Introduced methods for enabling/disabling plugins, filtering handlers, and managing LLM and TTS service states. - Registered various system capabilities for data directory access, HTML rendering, and event streaming. * fix(runtime): avoid creating Star instance in on_error fallback * fix(runtime): avoid virtual dispatch in Star.on_error fallback * feat: refactor injected parameter handling and introduce is_framework_injected_parameter utility * Squashed 'astrbot-sdk/' changes from 027c15b4..d078e510d078e510feat: refactor injected parameter handling and introduce is_framework_injected_parameter utility461f7276Merge branch 'dev' of https://github.com/united-pooh/astrbot-sdk into dev5ead59c4fix(runtime): avoid virtual dispatch in Star.on_error fallbackd2382858fix(runtime): avoid creating Star instance in on_error fallbacke961e361feat: add session and system capabilities for plugin management and event handling5a46321aRefactor tool call handling in SdkPluginBridge47698448feat: add conversation.get_current capability and related schemas9b35bec8feat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器48a20240feat: enhance SDK plugin configuration handling and loggingcb593a53docs: remove redundant testing instructions from AGENTS.mdf4942076feat(tests): 添加测试用例以验证平台和消息类型过滤器的冲突处理b0f8b2d6feat(tests): 添加测试用例以验证 register_task 的行为并更新测试运行说明6e417c6dfeat(sdk): add merged provider config bridge and client659eabcefeat(sdk): add merged provider config capability support REVERT:027c15b4Implement feature X to enhance user experience and optimize performance REVERT:c272661fchore: pull sdk subtree from dev (resolve delete/modify conflict) REVERT:0a2a3592feat: add session and system capabilities for plugin management and event handling REVERT:3204c9dbMerge sdk-remote dev into feat/sdk-integration REVERT:36443f1dRefactor tool call handling in SdkPluginBridge REVERT:3a2d715eRefactor tool call handling in SdkPluginBridge REVERT:b93c2c2bfeat: add conversation.get_current capability and related schemas REVERT:ed1b9665feat: add conversation.get_current capability and related schemas REVERT:e74123bbfeat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器 REVERT:bb361cf9feat: 增强装饰器功能,添加会话命令支持及相关权限和限流装饰器 REVERT:c6237f52Merge sdk-remote/dev into astrbot-sdk subtree REVERT:e12029fffeat: enhance SDK plugin configuration handling and logging REVERT:5e54bbb3feat: enhance SDK plugin configuration handling and logging REVERT:f48e2041Merge commit '5ac9401852ddb46f337da6bcc0f9b66eed265da9' into feat/sdk-integration REVERT:619672e6Merge commit '5ac9401852ddb46f337da6bcc0f9b66eed265da9' into feat/sdk-integration REVERT:d5a3796ddocs: remove redundant testing instructions from AGENTS.md REVERT:323e3f4ddocs: remove redundant testing instructions from AGENTS.md REVERT:f8438a7bMerge commit 'e45bade147ff44b43860ecff12067309e59c151a' into feat/sdk-integration REVERT:96d1df85Merge commit 'e45bade147ff44b43860ecff12067309e59c151a' into feat/sdk-integration REVERT:f8a7e253feat(sdk): add merged provider config bridge and client REVERT:752dc6cffeat(sdk): add merged provider config capability support git-subtree-dir: astrbot-sdk git-subtree-split:d078e51051* refactor: reorganize imports and enhance type hints in sdk_bridge modules * refactor: update import paths to use Path for better compatibility * refactor(injection): centralize legacy injected parameter filtering * fix(testing): use public session waiter probe in PluginHarness * docs: add TODO for documentation content in _command_model.py * feat: add memory management capabilities to CoreCapabilityBridge and implement unit tests * feat: enhance memory search functionality and improve metadata retrieval in SDK * feat: add memory management attributes and typed provider method to CapabilityMixinHost * Implement feature X to enhance user experience and optimize performance * Refactor memory utility functions and enhance memory capability mixin - Added new utility functions for memory management in _memory_utils.py. - Refactored memory capability mixin methods to utilize the new utility functions for better readability and maintainability. - Updated PROJECT_ARCHITECTURE.md to reflect changes in documentation and structure. * Squashed 'astrbot-sdk/' changes from d078e510..208bc591208bc591Merge pull request #30 from united-pooh/refactor/unify-legacy-injected-paramsd86534a2docs: add TODO for documentation content in _command_model.py090724a7refactor(injection): centralize legacy injected parameter filtering git-subtree-dir: astrbot-sdk git-subtree-split:208bc591dd* Initial plan * docs: fix path, Python version, and client API table in PROJECT_ARCHITECTURE.md Co-authored-by: whatevertogo <149563971+whatevertogo@users.noreply.github.com> * Squashed 'astrbot-sdk/' changes from 208bc591..ad5e8d13ad5e8d13Merge pull request #37 from united-pooh/sdk/whatevertogo5751701fMerge pull request #38 from united-pooh/copilot/sub-pr-37e21acba5docs: fix path, Python version, and client API table in PROJECT_ARCHITECTURE.mdee67cab4Initial plan7d921570Refactor memory utility functions and enhance memory capability mixin git-subtree-dir: astrbot-sdk git-subtree-split:ad5e8d1397* docs: fix TODO comment formatting in _command_model.py * 集成SDK命令候选项,优化Telegram和Discord平台适配器的命令收集逻辑 * 删除AI女友插件的单元测试文件 * 更新文档,添加Telegram和Discord原生命令菜单的注册说明 * Squashed 'astrbot-sdk/' changes from ad5e8d13..5003da585003da58Merge pull request #40 from united-pooh/sdk/whatevertogob5084c44Merge branch 'sdk/whatevertogo' of https://github.com/united-pooh/astrbot-sdk into sdk/whatevertogo7559edf7docs: fix TODO comment formatting in _command_model.py git-subtree-dir: astrbot-sdk git-subtree-split:5003da58f5* fix(testing): route session waiter followups through dispatcher (#33) * fix(testing): route session waiter followups through dispatcher * fix(testing): preserve waiter context and completion state * fix(runtime): preserve session waiter plugin identity * fix(runtime): scope session waiters by plugin * fix(testing): isolate waiter replacement and followup drains * fix(runtime): normalize waiter routing inputs * fix(cli): route protocol stdout at command entry (#41) * 添加内存后端支持,优化插件内存管理逻辑 * feat(memory): enhance memory schemas and add namespace support - Updated MEMORY_SEARCH_INPUT_SCHEMA to include `namespace` and `include_descendants`. - Modified MEMORY_SEARCH_OUTPUT_SCHEMA to allow nullable `namespace`. - Added `namespace` to MEMORY_GET_INPUT_SCHEMA, MEMORY_DELETE_INPUT_SCHEMA, MEMORY_SAVE_WITH_TTL_INPUT_SCHEMA, MEMORY_GET_MANY_INPUT_SCHEMA, and MEMORY_DELETE_MANY_INPUT_SCHEMA. - Enhanced MEMORY_STATS_INPUT_SCHEMA to support `namespace` and `include_descendants`. - Updated MEMORY_GET_OUTPUT_SCHEMA and MEMORY_STATS_OUTPUT_SCHEMA to include `namespace` and `namespace_count`. - Introduced `_memory_backends` in CapabilityRouterHost and CapabilityRouterBridgeBase for better memory management. - Refactored MemoryCapabilityMixin to utilize memory backends for plugin-specific memory operations. - Improved memory search functionality to respect namespaces and include descendants based on input parameters. - Added tests to validate memory operations across different namespaces and ensure persistence across restarts. - Implemented error handling in the handler dispatcher to manage exceptions gracefully. * fix: guard session_waiter blocking usage * fix(runtime): preserve request-scoped system event overlays * test(runtime): lock peer initialization and transport failure semantics * test(loader): cover plugin reload and import isolation regressions * refactor(supervisor): clarify plugin registry sync phases * test(clients): cover provider lifecycle regressions * feat(cli): improve astr init defaults * feat(plugin): add plugin ID validation and data directory resolution - Implemented `validate_plugin_id` to ensure safe plugin identifiers. - Added `resolve_plugin_data_dir` to resolve plugin data directories securely. - Updated memory and system capabilities to utilize new plugin ID validation. - Refactored session waiter management to simplify plugin ID handling. - Enhanced tests for plugin ID validation and data directory resolution. * fix(cli): exit cleanly on init abort * feat(memory): enhance namespace handling and add tests for memory client * feat(agent): add tool status message handling and improve SDK command integration * Refactor SDK structure for backward compatibility - Moved message result and session classes to internal modules while preserving legacy import paths for compatibility. - Updated imports across the SDK to reflect the new internal structure. - Enhanced session waiter management to support multiple plugins and improve error handling. - Added tests to ensure LLM tool registration and session waiter functionality align with dispatcher expectations. - Cleaned up code and improved documentation for clarity and maintainability. * 增强异步下载功能,更新组件导入方式,并添加相关测试用例 * 添加任务重入锁以支持会话等待器的嵌套清理,并更新相关测试用例以验证后续消息的序列化处理 * 添加 .astrbot_sdk_testing 到 .gitignore 文件 * Add unit tests for provider management and tool capabilities - Introduced new test suite for provider platform management in `test_sdk_provider_platform_management.py`, covering scenarios for merged provider configurations, reserved plugin checks, and provider management functionalities. - Added tests for tool capabilities and provider queries in `test_sdk_provider_tool_platform_capabilities.py`, validating interactions with LLM tools and specialized proxies. - Removed obsolete `test_sdk_transport.py` as it contained outdated tests for transport layer functionality. * 添加多个模块和测试用例,增强SDK功能并支持单元测试 * fix(bridge): add missing capability registrations for db/memory/http/metadata Register methods for db, memory, http, and metadata capabilities exist in BasicCapabilityMixin but were never called in CoreCapabilityBridge.__init__. This caused SDK plugins using ctx.memory, ctx.db, ctx.http to fail with "LookupError: capability not found". * feat(kb): enhance knowledge base capabilities with document management and serialization * 添加知识库文档管理功能,包括文档上传、列表、获取、删除和刷新能力,更新相关的能力路由和协议模式 * feat(conversation): add ability to unset conversation persona and update related methods * 添加对话管理和元数据管理功能,包括清空对话人格和保存插件配置的能力 * feat(conversation): add test for unsetting conversation persona and verify state * feat(plugin): add save_plugin_config method and related tests for plugin configuration persistence * 优化插件配置保存方法的代码格式 * feat(sdk): enhance handler metadata with descriptions, priority, kind, and admin requirements * 添加描述、优先级和其他元数据到处理程序元数据和描述符中,优化相关功能 * feat(sdk): enhance SDK integration with local extras handling and message payloads * 添加对 MessageEvent 的额外字段支持,优化事件处理器的参数注入,增强 SDK 本地临时数据的管理能力 * 增强插件日志记录功能,添加控制台输出格式化和路径标签支持,新增单元测试以验证日志格式 * feat: Enhance command and tool management in dashboard - Refactor CommandRoute to utilize AstrBotCoreLifecycle for improved command handling. - Introduce command_key for commands to streamline toggling, renaming, and permission updates. - Implement support for SDK commands in the dashboard, marking them as read-only. - Update ToolTable and CommandTable components to use new command_key and tool_key properties. - Add runtime_kind and plugin_id to tools for better management. - Enhance API tests to cover SDK commands and tools, ensuring proper functionality and error handling. - Update localization files to include new messages related to SDK commands. * 优化插件日志记录和能力代理模块,增强异常处理,确保优先级参数为整数 * feat: 增强LLM能力,添加聊天提供者协议和异常处理,更新单元测试以验证提供者有效性 * feat: Implement SDK skill management capabilities - Added SkillCapabilityMixin to handle skill registration, unregistration, and listing. - Integrated skill management into the CoreCapabilityBridge. - Enhanced SkillManager to support SDK-registered skills, including loading, saving, and syncing skills. - Updated computer_client to utilize SkillManager for skill synchronization with sandboxes. - Refactored skill export functionality in SkillsRoute to accommodate new skill management structure. - Introduced tests for SDK skill registration, unregistration, and syncing to ensure functionality. - Improved skill handling in the dashboard and test suite to reflect changes in skill management. * 添加技能注册功能,包含技能注册、注销和列出能力的实现,增强插件能力管理 * 删除CLAUDE.md文档,移除过时的已知问题描述 * 删除 AGENTS.md 文档,移除过时的架构约束和开发命令说明 * 更新测试用例,修复插件发现失败时的错误信息,确保使用正确的运行时字段 * 修复错误处理和权限检查,新增单元测试以验证功能 * format * 增强命名空间管理,优化数据库操作,添加 HTTP 路由验证,新增并发隔离测试,完善命令模型解析单元测试 * 增强 HTTP 路由功能,添加 HTTP 方法注销逻辑的单元测试 * 格式化日志输出,优化批量插入时无内容提供的调试信息 * fix: add uv dependency for plugin environment groups * 删除代码审查文档 CODE_REVIEW_ISSUES.md * 添加消息历史管理功能,包括消息记录的增删查改,完善相关能力混合类和测试用例 * 实现 SDK 消息历史管理功能,包括记录的增删查改操作 * Add unit tests for MCP contract and capabilities in SDK - Implemented `_mcp_contract.py` to test local MCP server functionalities including listing, enabling, and disabling servers. - Created `test_sdk_mcp_capabilities.py` to cover various aspects of the CoreCapabilityBridge and SdkPluginBridge, including session management and global MCP server operations. - Introduced fake classes to simulate MCP server behavior and manage tool configurations for testing. - Ensured comprehensive coverage of MCP session lifecycle, including opening, listing tools, calling tools, and closing sessions. * feat(mcp): Implement local and global MCP server management capabilities - Added MCP management client to the context for local/global MCP service management. - Introduced decorators to acknowledge global MCP risk for plugins. - Defined schemas for MCP server operations including get, list, enable, disable, and session management. - Created MCP capability mixin to handle local and global MCP server operations. - Enhanced provider capabilities to include active local MCP tool names. - Updated capability router to support MCP functionalities and maintain session state. - Added tests for MCP functionalities, ensuring proper behavior and risk acknowledgment. --------- Co-authored-by: whatevertogo <149563971+whatevertogo@users.noreply.github.com> Co-authored-by: whatevertogo <whatevertogo@users.noreply.github.com> Co-authored-by: letr <letr007@foxmail.com> Co-authored-by: united_pooh <united_pooh@outlook.com> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> Co-authored-by: united_pooh <united_pooh@icloud.com> Co-authored-by: Lishiling <m18384519631@163.com> Co-authored-by: Li-shi-ling <114913764+Li-shi-ling@users.noreply.github.com> Co-authored-by: letr <123731298+letr007@users.noreply.github.com> Co-authored-by: Sisyphus <clio-agent@sisyphuslabs.ai> Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: catDforD <3276453835@qq.com> Co-authored-by: united_pooh <united_pooh@MBP-F6H6T2CYVV-2219.local>
542 lines
19 KiB
Python
542 lines
19 KiB
Python
from __future__ import annotations
|
|
|
|
from collections import defaultdict
|
|
from dataclasses import dataclass, field
|
|
from typing import Any
|
|
|
|
from astrbot.core import db_helper, logger, sp
|
|
from astrbot.core.db.po import CommandConfig
|
|
from astrbot.core.star.filter.command import CommandFilter
|
|
from astrbot.core.star.filter.command_group import CommandGroupFilter
|
|
from astrbot.core.star.filter.permission import PermissionType, PermissionTypeFilter
|
|
from astrbot.core.star.star import star_map
|
|
from astrbot.core.star.star_handler import StarHandlerMetadata, star_handlers_registry
|
|
|
|
|
|
@dataclass
|
|
class CommandDescriptor:
|
|
handler: StarHandlerMetadata = field(repr=False)
|
|
filter_ref: CommandFilter | CommandGroupFilter | None = field(
|
|
default=None,
|
|
repr=False,
|
|
)
|
|
handler_full_name: str = ""
|
|
handler_name: str = ""
|
|
plugin_name: str = ""
|
|
plugin_display_name: str | None = None
|
|
module_path: str = ""
|
|
description: str = ""
|
|
command_type: str = "command" # "command" | "group" | "sub_command"
|
|
raw_command_name: str | None = None
|
|
current_fragment: str | None = None
|
|
parent_signature: str = ""
|
|
parent_group_handler: str = ""
|
|
original_command: str | None = None
|
|
effective_command: str | None = None
|
|
aliases: list[str] = field(default_factory=list)
|
|
permission: str = "everyone"
|
|
enabled: bool = True
|
|
is_group: bool = False
|
|
is_sub_command: bool = False
|
|
reserved: bool = False
|
|
config: CommandConfig | None = None
|
|
has_conflict: bool = False
|
|
sub_commands: list[CommandDescriptor] = field(default_factory=list)
|
|
|
|
|
|
async def sync_command_configs() -> None:
|
|
"""同步指令配置,清理过期配置。"""
|
|
descriptors = _collect_descriptors(include_sub_commands=False)
|
|
config_records = await db_helper.get_command_configs()
|
|
config_map = _bind_configs_to_descriptors(descriptors, config_records)
|
|
live_handlers = {desc.handler_full_name for desc in descriptors}
|
|
|
|
stale_configs = [key for key in config_map if key not in live_handlers]
|
|
if stale_configs:
|
|
await db_helper.delete_command_configs(stale_configs)
|
|
|
|
|
|
async def toggle_command(handler_full_name: str, enabled: bool) -> CommandDescriptor:
|
|
descriptor = _build_descriptor_by_full_name(handler_full_name)
|
|
if not descriptor:
|
|
raise ValueError("指定的处理函数不存在或不是指令。")
|
|
|
|
existing_cfg = await db_helper.get_command_config(handler_full_name)
|
|
config = await db_helper.upsert_command_config(
|
|
handler_full_name=handler_full_name,
|
|
plugin_name=descriptor.plugin_name or "",
|
|
module_path=descriptor.module_path,
|
|
original_command=descriptor.original_command or descriptor.handler_name,
|
|
resolved_command=(
|
|
existing_cfg.resolved_command
|
|
if existing_cfg
|
|
else descriptor.current_fragment
|
|
),
|
|
enabled=enabled,
|
|
keep_original_alias=False,
|
|
conflict_key=existing_cfg.conflict_key
|
|
if existing_cfg and existing_cfg.conflict_key
|
|
else descriptor.original_command,
|
|
resolution_strategy=existing_cfg.resolution_strategy if existing_cfg else None,
|
|
note=existing_cfg.note if existing_cfg else None,
|
|
extra_data=existing_cfg.extra_data if existing_cfg else None,
|
|
auto_managed=False,
|
|
)
|
|
_bind_descriptor_with_config(descriptor, config)
|
|
await sync_command_configs()
|
|
return descriptor
|
|
|
|
|
|
async def rename_command(
|
|
handler_full_name: str,
|
|
new_fragment: str,
|
|
aliases: list[str] | None = None,
|
|
) -> CommandDescriptor:
|
|
descriptor = _build_descriptor_by_full_name(handler_full_name)
|
|
if not descriptor:
|
|
raise ValueError("指定的处理函数不存在或不是指令。")
|
|
|
|
new_fragment = new_fragment.strip()
|
|
if not new_fragment:
|
|
raise ValueError("指令名不能为空。")
|
|
|
|
# 校验主指令名
|
|
candidate_full = _compose_command(descriptor.parent_signature, new_fragment)
|
|
if _is_command_in_use(handler_full_name, candidate_full):
|
|
raise ValueError(f"指令名 '{candidate_full}' 已被其他指令占用。")
|
|
|
|
# 校验别名
|
|
if aliases:
|
|
for alias in aliases:
|
|
alias = alias.strip()
|
|
if not alias:
|
|
continue
|
|
alias_full = _compose_command(descriptor.parent_signature, alias)
|
|
if _is_command_in_use(handler_full_name, alias_full):
|
|
raise ValueError(f"别名 '{alias_full}' 已被其他指令占用。")
|
|
|
|
existing_cfg = await db_helper.get_command_config(handler_full_name)
|
|
merged_extra = dict(existing_cfg.extra_data or {}) if existing_cfg else {}
|
|
merged_extra["resolved_aliases"] = aliases or []
|
|
|
|
config = await db_helper.upsert_command_config(
|
|
handler_full_name=handler_full_name,
|
|
plugin_name=descriptor.plugin_name or "",
|
|
module_path=descriptor.module_path,
|
|
original_command=descriptor.original_command or descriptor.handler_name,
|
|
resolved_command=new_fragment,
|
|
enabled=True if descriptor.enabled else False,
|
|
keep_original_alias=False,
|
|
conflict_key=descriptor.original_command,
|
|
resolution_strategy="manual_rename",
|
|
note=None,
|
|
extra_data=merged_extra,
|
|
auto_managed=False,
|
|
)
|
|
_bind_descriptor_with_config(descriptor, config)
|
|
|
|
await sync_command_configs()
|
|
return descriptor
|
|
|
|
|
|
async def update_command_permission(
|
|
handler_full_name: str,
|
|
permission_type: str,
|
|
) -> CommandDescriptor:
|
|
descriptor = _build_descriptor_by_full_name(handler_full_name)
|
|
if not descriptor:
|
|
raise ValueError("指定的处理函数不存在或不是指令。")
|
|
|
|
if permission_type not in ["admin", "member"]:
|
|
raise ValueError("权限类型必须为 admin 或 member。")
|
|
|
|
handler = descriptor.handler
|
|
found_plugin = star_map.get(handler.handler_module_path)
|
|
if not found_plugin:
|
|
raise ValueError("未找到指令所属插件")
|
|
|
|
# 1. Update Persistent Config (alter_cmd)
|
|
alter_cmd_cfg = await sp.global_get("alter_cmd", {})
|
|
plugin_ = alter_cmd_cfg.get(found_plugin.name, {})
|
|
cfg = plugin_.get(handler.handler_name, {})
|
|
cfg["permission"] = permission_type
|
|
plugin_[handler.handler_name] = cfg
|
|
alter_cmd_cfg[found_plugin.name] = plugin_
|
|
|
|
await sp.global_put("alter_cmd", alter_cmd_cfg)
|
|
|
|
# 2. Update Runtime Filter
|
|
found_permission_filter = False
|
|
target_perm_type = (
|
|
PermissionType.ADMIN if permission_type == "admin" else PermissionType.MEMBER
|
|
)
|
|
|
|
for filter_ in handler.event_filters:
|
|
if isinstance(filter_, PermissionTypeFilter):
|
|
filter_.permission_type = target_perm_type
|
|
found_permission_filter = True
|
|
break
|
|
|
|
if not found_permission_filter:
|
|
handler.event_filters.insert(0, PermissionTypeFilter(target_perm_type))
|
|
|
|
# Re-build descriptor to reflect changes
|
|
return _build_descriptor(handler) or descriptor
|
|
|
|
|
|
async def list_commands() -> list[dict[str, Any]]:
|
|
descriptors = _collect_descriptors(include_sub_commands=True)
|
|
config_records = await db_helper.get_command_configs()
|
|
_bind_configs_to_descriptors(descriptors, config_records)
|
|
|
|
conflict_groups = _group_conflicts(descriptors)
|
|
conflict_handler_names: set[str] = {
|
|
d.handler_full_name for group in conflict_groups.values() for d in group
|
|
}
|
|
|
|
# 分类,设置冲突标志,将子指令挂载到父指令组
|
|
group_map: dict[str, CommandDescriptor] = {}
|
|
sub_commands: list[CommandDescriptor] = []
|
|
root_commands: list[CommandDescriptor] = []
|
|
|
|
for desc in descriptors:
|
|
desc.has_conflict = desc.handler_full_name in conflict_handler_names
|
|
if desc.is_group:
|
|
group_map[desc.handler_full_name] = desc
|
|
elif desc.is_sub_command:
|
|
sub_commands.append(desc)
|
|
else:
|
|
root_commands.append(desc)
|
|
|
|
for sub in sub_commands:
|
|
if sub.parent_group_handler and sub.parent_group_handler in group_map:
|
|
group_map[sub.parent_group_handler].sub_commands.append(sub)
|
|
else:
|
|
root_commands.append(sub)
|
|
|
|
# 指令组 + 普通指令,按 effective_command 字母排序
|
|
all_commands = list(group_map.values()) + root_commands
|
|
all_commands.sort(key=lambda d: (d.effective_command or "").lower())
|
|
|
|
result = [_descriptor_to_dict(desc) for desc in all_commands]
|
|
return result
|
|
|
|
|
|
async def list_command_conflicts() -> list[dict[str, Any]]:
|
|
"""列出所有冲突的指令组。"""
|
|
descriptors = _collect_descriptors(include_sub_commands=False)
|
|
config_records = await db_helper.get_command_configs()
|
|
_bind_configs_to_descriptors(descriptors, config_records)
|
|
|
|
conflict_groups = _group_conflicts(descriptors)
|
|
details = [
|
|
{
|
|
"conflict_key": key,
|
|
"handlers": [
|
|
{
|
|
"handler_full_name": item.handler_full_name,
|
|
"plugin": item.plugin_name,
|
|
"current_name": item.effective_command,
|
|
}
|
|
for item in group
|
|
],
|
|
}
|
|
for key, group in conflict_groups.items()
|
|
]
|
|
return details
|
|
|
|
|
|
# Internal helpers ----------------------------------------------------------
|
|
|
|
|
|
def _collect_descriptors(include_sub_commands: bool) -> list[CommandDescriptor]:
|
|
"""收集指令,按需包含子指令。"""
|
|
descriptors: list[CommandDescriptor] = []
|
|
for handler in star_handlers_registry:
|
|
try:
|
|
desc = _build_descriptor(handler)
|
|
if not desc:
|
|
continue
|
|
if not include_sub_commands and desc.is_sub_command:
|
|
continue
|
|
descriptors.append(desc)
|
|
except Exception as e:
|
|
logger.warning(
|
|
f"解析指令处理函数 {handler.handler_full_name} 失败,跳过该指令。原因: {e!s}"
|
|
)
|
|
continue
|
|
return descriptors
|
|
|
|
|
|
def _build_descriptor(handler: StarHandlerMetadata) -> CommandDescriptor | None:
|
|
filter_ref = _locate_primary_filter(handler)
|
|
if filter_ref is None:
|
|
return None
|
|
|
|
plugin_meta = star_map.get(handler.handler_module_path)
|
|
plugin_name = (
|
|
plugin_meta.name if plugin_meta else None
|
|
) or handler.handler_module_path
|
|
plugin_display = plugin_meta.display_name if plugin_meta else None
|
|
|
|
is_sub_command = bool(handler.extras_configs.get("sub_command"))
|
|
parent_group_handler = ""
|
|
|
|
if isinstance(filter_ref, CommandFilter):
|
|
raw_fragment = getattr(
|
|
filter_ref, "_original_command_name", filter_ref.command_name
|
|
)
|
|
current_fragment = filter_ref.command_name
|
|
parent_signature = (filter_ref.parent_command_names or [""])[0].strip()
|
|
# 如果是子指令,尝试找到父指令组的 handler_full_name
|
|
if is_sub_command and parent_signature:
|
|
parent_group_handler = _find_parent_group_handler(
|
|
handler.handler_module_path, parent_signature
|
|
)
|
|
else:
|
|
raw_fragment = getattr(
|
|
filter_ref, "_original_group_name", filter_ref.group_name
|
|
)
|
|
current_fragment = filter_ref.group_name
|
|
parent_signature = _resolve_group_parent_signature(filter_ref)
|
|
|
|
original_command = _compose_command(parent_signature, raw_fragment)
|
|
effective_command = _compose_command(parent_signature, current_fragment)
|
|
|
|
# 确定 command_type
|
|
if isinstance(filter_ref, CommandGroupFilter):
|
|
command_type = "group"
|
|
elif is_sub_command:
|
|
command_type = "sub_command"
|
|
else:
|
|
command_type = "command"
|
|
|
|
descriptor = CommandDescriptor(
|
|
handler=handler,
|
|
filter_ref=filter_ref,
|
|
handler_full_name=handler.handler_full_name,
|
|
handler_name=handler.handler_name,
|
|
plugin_name=plugin_name,
|
|
plugin_display_name=plugin_display,
|
|
module_path=handler.handler_module_path,
|
|
description=handler.desc or "",
|
|
command_type=command_type,
|
|
raw_command_name=raw_fragment,
|
|
current_fragment=current_fragment,
|
|
parent_signature=parent_signature,
|
|
parent_group_handler=parent_group_handler,
|
|
original_command=original_command,
|
|
effective_command=effective_command,
|
|
aliases=sorted(getattr(filter_ref, "alias", set())),
|
|
permission=_determine_permission(handler),
|
|
enabled=handler.enabled,
|
|
is_group=isinstance(filter_ref, CommandGroupFilter),
|
|
is_sub_command=is_sub_command,
|
|
reserved=plugin_meta.reserved if plugin_meta else False,
|
|
)
|
|
return descriptor
|
|
|
|
|
|
def _build_descriptor_by_full_name(full_name: str) -> CommandDescriptor | None:
|
|
handler = star_handlers_registry.get_handler_by_full_name(full_name)
|
|
if not handler:
|
|
return None
|
|
return _build_descriptor(handler)
|
|
|
|
|
|
def _locate_primary_filter(
|
|
handler: StarHandlerMetadata,
|
|
) -> CommandFilter | CommandGroupFilter | None:
|
|
for filter_ref in handler.event_filters:
|
|
if isinstance(filter_ref, CommandFilter | CommandGroupFilter):
|
|
return filter_ref
|
|
return None
|
|
|
|
|
|
def _determine_permission(handler: StarHandlerMetadata) -> str:
|
|
for filter_ref in handler.event_filters:
|
|
if isinstance(filter_ref, PermissionTypeFilter):
|
|
return (
|
|
"admin"
|
|
if filter_ref.permission_type == PermissionType.ADMIN
|
|
else "member"
|
|
)
|
|
return "everyone"
|
|
|
|
|
|
def _resolve_group_parent_signature(group_filter: CommandGroupFilter) -> str:
|
|
signatures: list[str] = []
|
|
parent = group_filter.parent_group
|
|
while parent:
|
|
signatures.append(getattr(parent, "_original_group_name", parent.group_name))
|
|
parent = parent.parent_group
|
|
return " ".join(reversed(signatures)).strip()
|
|
|
|
|
|
def _find_parent_group_handler(module_path: str, parent_signature: str) -> str:
|
|
"""根据模块路径和父级签名,找到对应的指令组 handler_full_name。"""
|
|
parent_sig_normalized = parent_signature.strip()
|
|
for handler in star_handlers_registry:
|
|
if handler.handler_module_path != module_path:
|
|
continue
|
|
filter_ref = _locate_primary_filter(handler)
|
|
if not isinstance(filter_ref, CommandGroupFilter):
|
|
continue
|
|
# 检查该指令组的完整指令名是否匹配 parent_signature
|
|
group_names = filter_ref.get_complete_command_names()
|
|
if parent_sig_normalized in group_names:
|
|
return handler.handler_full_name
|
|
return ""
|
|
|
|
|
|
def _compose_command(parent_signature: str, fragment: str | None) -> str:
|
|
fragment = (fragment or "").strip()
|
|
parent_signature = parent_signature.strip()
|
|
if not parent_signature:
|
|
return fragment
|
|
if not fragment:
|
|
return parent_signature
|
|
return f"{parent_signature} {fragment}"
|
|
|
|
|
|
def _bind_descriptor_with_config(
|
|
descriptor: CommandDescriptor,
|
|
config: CommandConfig,
|
|
) -> None:
|
|
_apply_config_to_descriptor(descriptor, config)
|
|
_apply_config_to_runtime(descriptor, config)
|
|
|
|
|
|
def _apply_config_to_descriptor(
|
|
descriptor: CommandDescriptor,
|
|
config: CommandConfig,
|
|
) -> None:
|
|
descriptor.config = config
|
|
descriptor.enabled = config.enabled
|
|
|
|
if config.original_command:
|
|
descriptor.original_command = config.original_command
|
|
|
|
new_fragment = config.resolved_command or descriptor.current_fragment
|
|
descriptor.current_fragment = new_fragment
|
|
descriptor.effective_command = _compose_command(
|
|
descriptor.parent_signature,
|
|
new_fragment,
|
|
)
|
|
|
|
extra = config.extra_data or {}
|
|
resolved_aliases = extra.get("resolved_aliases")
|
|
if isinstance(resolved_aliases, list):
|
|
descriptor.aliases = [str(x) for x in resolved_aliases if str(x).strip()]
|
|
|
|
|
|
def _apply_config_to_runtime(
|
|
descriptor: CommandDescriptor,
|
|
config: CommandConfig,
|
|
) -> None:
|
|
descriptor.handler.enabled = config.enabled
|
|
if descriptor.filter_ref:
|
|
if descriptor.current_fragment:
|
|
_set_filter_fragment(descriptor.filter_ref, descriptor.current_fragment)
|
|
extra = config.extra_data or {}
|
|
resolved_aliases = extra.get("resolved_aliases")
|
|
if isinstance(resolved_aliases, list):
|
|
_set_filter_aliases(
|
|
descriptor.filter_ref,
|
|
[str(x) for x in resolved_aliases if str(x).strip()],
|
|
)
|
|
|
|
|
|
def _bind_configs_to_descriptors(
|
|
descriptors: list[CommandDescriptor],
|
|
config_records: list[CommandConfig],
|
|
) -> dict[str, CommandConfig]:
|
|
config_map = {cfg.handler_full_name: cfg for cfg in config_records}
|
|
for desc in descriptors:
|
|
if cfg := config_map.get(desc.handler_full_name):
|
|
_bind_descriptor_with_config(desc, cfg)
|
|
return config_map
|
|
|
|
|
|
def _group_conflicts(
|
|
descriptors: list[CommandDescriptor],
|
|
) -> dict[str, list[CommandDescriptor]]:
|
|
conflicts: dict[str, list[CommandDescriptor]] = defaultdict(list)
|
|
for desc in descriptors:
|
|
if desc.effective_command and desc.enabled:
|
|
conflicts[desc.effective_command].append(desc)
|
|
return {k: v for k, v in conflicts.items() if len(v) > 1}
|
|
|
|
|
|
def _set_filter_fragment(
|
|
filter_ref: CommandFilter | CommandGroupFilter,
|
|
fragment: str,
|
|
) -> None:
|
|
attr = (
|
|
"group_name" if isinstance(filter_ref, CommandGroupFilter) else "command_name"
|
|
)
|
|
current_value = getattr(filter_ref, attr)
|
|
if fragment == current_value:
|
|
return
|
|
setattr(filter_ref, attr, fragment)
|
|
if hasattr(filter_ref, "_cmpl_cmd_names"):
|
|
filter_ref._cmpl_cmd_names = None
|
|
|
|
|
|
def _set_filter_aliases(
|
|
filter_ref: CommandFilter | CommandGroupFilter,
|
|
aliases: list[str],
|
|
) -> None:
|
|
current_aliases = getattr(filter_ref, "alias", set())
|
|
if set(aliases) == current_aliases:
|
|
return
|
|
setattr(filter_ref, "alias", set(aliases))
|
|
if hasattr(filter_ref, "_cmpl_cmd_names"):
|
|
filter_ref._cmpl_cmd_names = None
|
|
|
|
|
|
def _is_command_in_use(
|
|
target_handler_full_name: str,
|
|
candidate_full_command: str,
|
|
) -> bool:
|
|
candidate = candidate_full_command.strip()
|
|
for handler in star_handlers_registry:
|
|
if handler.handler_full_name == target_handler_full_name:
|
|
continue
|
|
filter_ref = _locate_primary_filter(handler)
|
|
if not filter_ref:
|
|
continue
|
|
names = {name.strip() for name in filter_ref.get_complete_command_names()}
|
|
if candidate in names:
|
|
return True
|
|
return False
|
|
|
|
|
|
def _descriptor_to_dict(desc: CommandDescriptor) -> dict[str, Any]:
|
|
result = {
|
|
"handler_full_name": desc.handler_full_name,
|
|
"handler_name": desc.handler_name,
|
|
"plugin": desc.plugin_name,
|
|
"plugin_display_name": desc.plugin_display_name,
|
|
"module_path": desc.module_path,
|
|
"description": desc.description,
|
|
"type": desc.command_type,
|
|
"parent_signature": desc.parent_signature,
|
|
"parent_group_handler": desc.parent_group_handler,
|
|
"original_command": desc.original_command,
|
|
"current_fragment": desc.current_fragment,
|
|
"effective_command": desc.effective_command,
|
|
"aliases": desc.aliases,
|
|
"permission": desc.permission,
|
|
"enabled": desc.enabled,
|
|
"is_group": desc.is_group,
|
|
"has_conflict": desc.has_conflict,
|
|
"reserved": desc.reserved,
|
|
}
|
|
# 如果是指令组,包含子指令列表
|
|
if desc.is_group and desc.sub_commands:
|
|
result["sub_commands"] = [_descriptor_to_dict(sub) for sub in desc.sub_commands]
|
|
else:
|
|
result["sub_commands"] = []
|
|
return result
|