mirror of
https://github.com/LiteyukiStudio/nonebot-plugin-marshoai.git
synced 2025-01-26 18:12:47 +08:00
✨ 支持开发热重载插件,支持独立测试函数
This commit is contained in:
parent
87b18c424b
commit
99c113833e
@ -112,7 +112,7 @@ async def _preload_tools():
|
||||
|
||||
|
||||
@driver.on_startup
|
||||
async def _preload_plugins():
|
||||
async def _():
|
||||
"""启动钩子加载插件"""
|
||||
if config.marshoai_enable_plugins:
|
||||
marshoai_plugin_dirs = config.marshoai_plugin_dirs # 外部插件目录列表
|
||||
|
@ -1,9 +1,16 @@
|
||||
from nonebot import require
|
||||
import os
|
||||
from pathlib import Path
|
||||
|
||||
from nonebot import get_driver, logger, require
|
||||
from nonebot.adapters import Bot, Event
|
||||
from nonebot.matcher import Matcher
|
||||
from nonebot.typing import T_State
|
||||
|
||||
from nonebot_plugin_marshoai.plugin.func_call.models import SessionContext
|
||||
from nonebot_plugin_marshoai.plugin.load import reload_plugin
|
||||
|
||||
from .azure import context
|
||||
from .config import config
|
||||
from .plugin.func_call.models import SessionContext
|
||||
|
||||
require("nonebot_plugin_alconna")
|
||||
|
||||
@ -17,8 +24,12 @@ from nonebot_plugin_alconna import (
|
||||
on_alconna,
|
||||
)
|
||||
|
||||
from .observer import *
|
||||
from .plugin import get_plugin, get_plugins
|
||||
from .plugin.func_call.caller import get_function_calls
|
||||
|
||||
driver = get_driver()
|
||||
|
||||
function_call = on_alconna(
|
||||
command=Alconna(
|
||||
"marsho-function-call",
|
||||
@ -66,6 +77,11 @@ async def call_function(
|
||||
):
|
||||
function = get_function_calls().get(function_name)
|
||||
if function is None:
|
||||
for f in get_function_calls().values():
|
||||
if f.short_name == function_name:
|
||||
function = f
|
||||
break
|
||||
else:
|
||||
await UniMessage(f"未找到函数 {function_name}").send()
|
||||
return
|
||||
await UniMessage(
|
||||
@ -75,3 +91,37 @@ async def call_function(
|
||||
).call(**{i.split("=", 1)[0]: i.split("=", 1)[1] for i in kwargs})
|
||||
)
|
||||
).send()
|
||||
|
||||
|
||||
@on_file_system_event(
|
||||
(str(Path(__file__).parent / "plugins"), *config.marshoai_plugin_dirs),
|
||||
recursive=True,
|
||||
)
|
||||
def on_plugin_file_change(event):
|
||||
if event.src_path.endswith(".py"):
|
||||
logger.info(f"文件变动: {event.src_path}")
|
||||
# 层层向上查找到插件目录
|
||||
dir_list: list[str] = event.src_path.split("/") # type: ignore
|
||||
dir_list[-1] = dir_list[-1].split(".", 1)[0]
|
||||
dir_list.reverse()
|
||||
for plugin_name in dir_list:
|
||||
if plugin := get_plugin(plugin_name):
|
||||
if plugin.module_path.endswith("__init__.py"):
|
||||
# 包插件
|
||||
if os.path.dirname(plugin.module_path).replace(
|
||||
"\\", "/"
|
||||
) in event.src_path.replace("\\", "/"):
|
||||
logger.debug(f"找到变动插件: {plugin.name},正在重新加载")
|
||||
reload_plugin(plugin)
|
||||
context.reset_all()
|
||||
break
|
||||
else:
|
||||
# 单文件插件
|
||||
if plugin.module_path == event.src_path:
|
||||
logger.debug(f"找到变动插件: {plugin.name},正在重新加载")
|
||||
reload_plugin(plugin)
|
||||
context.reset_all()
|
||||
break
|
||||
else:
|
||||
logger.debug("未找到变动插件")
|
||||
return
|
||||
|
@ -47,6 +47,13 @@ class MarshoContext:
|
||||
if target_id in target_dict:
|
||||
target_dict[target_id].clear()
|
||||
|
||||
def reset_all(self):
|
||||
"""
|
||||
重置所有上下文
|
||||
"""
|
||||
self.contents["private"].clear()
|
||||
self.contents["non-private"].clear()
|
||||
|
||||
def build(self, target_id: str, is_private: bool) -> list:
|
||||
"""
|
||||
构建返回的上下文,不包括系统消息
|
||||
|
99
nonebot_plugin_marshoai/observer.py
Executable file
99
nonebot_plugin_marshoai/observer.py
Executable file
@ -0,0 +1,99 @@
|
||||
"""
|
||||
此模块用于注册观察者函数,使用watchdog监控文件变化并重启bot
|
||||
启用该模块需要在配置文件中设置`dev_mode`为True
|
||||
"""
|
||||
|
||||
import time
|
||||
from typing import Callable, TypeAlias
|
||||
|
||||
from nonebot import get_driver, logger
|
||||
from watchdog.events import FileSystemEvent, FileSystemEventHandler
|
||||
from watchdog.observers import Observer
|
||||
|
||||
from .config import config
|
||||
|
||||
CALLBACK_FUNC: TypeAlias = Callable[[FileSystemEvent], None] # 位置1为FileSystemEvent
|
||||
FILTER_FUNC: TypeAlias = Callable[[FileSystemEvent], bool] # 位置1为FileSystemEvent
|
||||
|
||||
observer = Observer()
|
||||
|
||||
driver = get_driver()
|
||||
|
||||
|
||||
def debounce(wait):
|
||||
"""
|
||||
防抖函数
|
||||
"""
|
||||
|
||||
def decorator(func):
|
||||
def wrapper(*args, **kwargs):
|
||||
nonlocal last_call_time
|
||||
current_time = time.time()
|
||||
if (current_time - last_call_time) > wait:
|
||||
last_call_time = current_time
|
||||
return func(*args, **kwargs)
|
||||
|
||||
last_call_time = None
|
||||
return wrapper
|
||||
|
||||
return decorator
|
||||
|
||||
|
||||
@driver.on_startup
|
||||
async def check_for_reloader():
|
||||
if config.marshoai_devmode:
|
||||
logger.debug("Marsho Reload enabled, watching for file changes...")
|
||||
observer.start()
|
||||
|
||||
|
||||
class CodeModifiedHandler(FileSystemEventHandler):
|
||||
"""
|
||||
Handler for code file changes
|
||||
"""
|
||||
|
||||
@debounce(1)
|
||||
def on_modified(self, event):
|
||||
raise NotImplementedError("on_modified must be implemented")
|
||||
|
||||
def on_created(self, event):
|
||||
self.on_modified(event)
|
||||
|
||||
def on_deleted(self, event):
|
||||
self.on_modified(event)
|
||||
|
||||
def on_moved(self, event):
|
||||
self.on_modified(event)
|
||||
|
||||
def on_any_event(self, event):
|
||||
self.on_modified(event)
|
||||
|
||||
|
||||
def on_file_system_event(
|
||||
directories: tuple[str, ...],
|
||||
recursive: bool = True,
|
||||
event_filter: FILTER_FUNC | None = None,
|
||||
) -> Callable[[CALLBACK_FUNC], CALLBACK_FUNC]:
|
||||
"""
|
||||
注册文件系统变化监听器
|
||||
Args:
|
||||
directories: 监听目录们
|
||||
recursive: 是否递归监听子目录
|
||||
event_filter: 事件过滤器, 返回True则执行回调函数
|
||||
Returns:
|
||||
装饰器,装饰一个函数在接收到数据后执行
|
||||
"""
|
||||
|
||||
def decorator(func: CALLBACK_FUNC) -> CALLBACK_FUNC:
|
||||
def wrapper(event: FileSystemEvent):
|
||||
|
||||
if event_filter is not None and not event_filter(event):
|
||||
return
|
||||
func(event)
|
||||
|
||||
code_modified_handler = CodeModifiedHandler()
|
||||
code_modified_handler.on_modified = wrapper
|
||||
for directory in directories:
|
||||
observer.schedule(code_modified_handler, directory, recursive=recursive)
|
||||
return func
|
||||
|
||||
return decorator
|
@ -27,7 +27,7 @@ class Caller:
|
||||
self.func: ASYNC_FUNCTION_CALL_FUNC | None = None
|
||||
"""函数对象"""
|
||||
self.module_name: str = ""
|
||||
"""模块名"""
|
||||
"""模块名,仅为父级模块名,不一定是插件顶级模块名"""
|
||||
self._parameters: dict[str, Any] = {}
|
||||
"""声明参数"""
|
||||
|
||||
@ -137,14 +137,14 @@ class Caller:
|
||||
self.func = async_wrap(func) # type: ignore
|
||||
|
||||
if module := inspect.getmodule(func):
|
||||
module_name = module.__name__.split(".")[-1] + "."
|
||||
module_name = module.__name__.split(".")[-1]
|
||||
else:
|
||||
module_name = ""
|
||||
|
||||
self.module_name = module_name
|
||||
_caller_data[self.full_name] = self
|
||||
logger.opt(colors=True).debug(
|
||||
f"<y>加载函数 {module_name}{func.__name__}: {self._description}</y>"
|
||||
f"<y>加载函数 {self.full_name}: {self._description}</y>"
|
||||
)
|
||||
|
||||
return func
|
||||
@ -238,7 +238,7 @@ class Caller:
|
||||
@property
|
||||
def full_name(self) -> str:
|
||||
"""完整名"""
|
||||
return self.module_name + self._name
|
||||
return self.module_name + "." + self._name
|
||||
|
||||
@property
|
||||
def short_info(self) -> str:
|
||||
|
@ -45,7 +45,9 @@ def get_plugins() -> dict[str, Plugin]:
|
||||
return _plugins
|
||||
|
||||
|
||||
def load_plugin(module_path: str | Path) -> Optional[Plugin]:
|
||||
def load_plugin(
|
||||
module_path: str | Path, allow_reload: bool = False
|
||||
) -> Optional[Plugin]:
|
||||
"""加载单个插件,可以是本地插件或是通过 `pip` 安装的插件。
|
||||
该函数产生的副作用在于将插件加载到 `_plugins` 中。
|
||||
|
||||
@ -63,11 +65,14 @@ def load_plugin(module_path: str | Path) -> Optional[Plugin]:
|
||||
try:
|
||||
module = import_module(module_path) # 导入模块对象
|
||||
plugin = Plugin(
|
||||
name=module.__name__,
|
||||
name=module.__name__.split(".")[-1],
|
||||
module=module,
|
||||
module_name=module_path,
|
||||
module_path=module.__file__,
|
||||
)
|
||||
if plugin.name in _plugins and not allow_reload:
|
||||
raise ValueError(f"插件名称重复: {plugin.name}")
|
||||
else:
|
||||
_plugins[plugin.name] = plugin
|
||||
|
||||
plugin.metadata = getattr(module, "__marsho_meta__", None)
|
||||
@ -118,3 +123,33 @@ def load_plugins(*plugin_dirs: str) -> set[Plugin]:
|
||||
if module_name and (plugin := load_plugin(module_name)):
|
||||
plugins.add(plugin)
|
||||
return plugins
|
||||
|
||||
|
||||
def reload_plugin(plugin: Plugin) -> Optional[Plugin]:
|
||||
"""开发模式下的重新加载插件
|
||||
该方法无法保证没有副作用,因为插件可能会有自己的初始化方法
|
||||
如果出现异常请重启即可
|
||||
Args:
|
||||
plugin: 插件对象
|
||||
Returns:
|
||||
Optional[Plugin]: 插件对象
|
||||
"""
|
||||
try:
|
||||
if plugin.module_path:
|
||||
if new_plugin := load_plugin(plugin.module_name, True):
|
||||
logger.opt(colors=True).debug(
|
||||
f'重新加载插件 "<y>{new_plugin.name}</y>" 成功, 若出现异常或副作用请重启'
|
||||
)
|
||||
return new_plugin
|
||||
else:
|
||||
logger.opt(colors=True).error(
|
||||
f'重新加载插件失败 "<r>{plugin.name}</r>"'
|
||||
)
|
||||
return None
|
||||
else:
|
||||
logger.opt(colors=True).error(f'插件不支持重载 "<r>{plugin.name}</r>"')
|
||||
return None
|
||||
except Exception as e:
|
||||
logger.opt(colors=True).error(f'重新加载插件失败 "<r>{plugin.name}</r>"')
|
||||
traceback.print_exc()
|
||||
return None
|
||||
|
@ -57,7 +57,7 @@ class Plugin(BaseModel):
|
||||
module: ModuleType
|
||||
"""插件模块对象"""
|
||||
module_name: str
|
||||
"""点分割模块路径 例如a.b.c"""
|
||||
"""点分或/割模块路径 例如a.b.c"""
|
||||
module_path: str | None
|
||||
"""实际路径,单文件为.py的路径,包为__init__.py路径"""
|
||||
metadata: PluginMetadata | None = None
|
||||
|
@ -16,3 +16,8 @@ async def generate_random_numbers(count: int) -> str:
|
||||
|
||||
|
||||
# 该插件由MarshoAI自举编写
|
||||
|
||||
|
||||
@on_function_call(description="重载测试")
|
||||
def test_reload():
|
||||
return 1
|
||||
|
@ -25,7 +25,8 @@ dependencies = [
|
||||
"lxml[html_clean]>=5.3.0",
|
||||
"aiofiles>=24.1.0",
|
||||
"sumy>=0.11.0",
|
||||
"azure-ai-inference>=1.0.0b6"
|
||||
"azure-ai-inference>=1.0.0b6",
|
||||
"watchdog>=6.0.0"
|
||||
|
||||
]
|
||||
license = { text = "MIT, Mulan PSL v2" }
|
||||
|
Loading…
x
Reference in New Issue
Block a user