275 lines
10 KiB
Python
275 lines
10 KiB
Python
import io
|
|
import os
|
|
import logging
|
|
import pkgutil
|
|
import importlib
|
|
import threading
|
|
from typing_extensions import Self
|
|
from dataclasses import dataclass, field
|
|
from typing import Any, Literal, Callable, Generic, TypeVar, ParamSpec
|
|
|
|
from kotonebot.client import Device
|
|
from kotonebot.client.host.protocol import Instance
|
|
from kotonebot.backend.context import init_context, vars
|
|
from kotonebot.backend.context import task_registry, action_registry, Task, Action
|
|
from kotonebot.errors import StopCurrentTask, UserFriendlyError
|
|
from kotonebot.interop.win.task_dialog import TaskDialog
|
|
|
|
log_stream = io.StringIO()
|
|
stream_handler = logging.StreamHandler(log_stream)
|
|
stream_handler.setFormatter(logging.Formatter('[%(asctime)s] [%(levelname)s] [%(name)s] [%(filename)s:%(lineno)d] - %(message)s'))
|
|
logging.getLogger('kotonebot').addHandler(stream_handler)
|
|
logger = logging.getLogger(__name__)
|
|
|
|
TaskStatusValue = Literal['pending', 'running', 'finished', 'error', 'cancelled', 'stopped']
|
|
@dataclass
|
|
class TaskStatus:
|
|
task: Task
|
|
status: TaskStatusValue
|
|
|
|
@dataclass
|
|
class RunStatus:
|
|
running: bool = False
|
|
tasks: list[TaskStatus] = field(default_factory=list)
|
|
current_task: Task | None = None
|
|
callstack: list[Task | Action] = field(default_factory=list)
|
|
|
|
def interrupt(self):
|
|
vars.flow.request_interrupt()
|
|
|
|
# Modified from https://stackoverflow.com/questions/70982565/how-do-i-make-an-event-listener-with-decorators-in-python
|
|
Params = ParamSpec('Params')
|
|
Return = TypeVar('Return')
|
|
class Event(Generic[Params, Return]):
|
|
def __init__(self):
|
|
self.__listeners = []
|
|
|
|
@property
|
|
def on(self):
|
|
def wrapper(func: Callable[Params, Return]):
|
|
self.add_listener(func)
|
|
return func
|
|
return wrapper
|
|
|
|
def add_listener(self, func: Callable[Params, Return]) -> None:
|
|
if func in self.__listeners:
|
|
return
|
|
self.__listeners.append(func)
|
|
|
|
def remove_listener(self, func: Callable[Params, Return]) -> None:
|
|
if func not in self.__listeners:
|
|
return
|
|
self.__listeners.remove(func)
|
|
|
|
def __iadd__(self, func: Callable[Params, Return]) -> Self:
|
|
self.add_listener(func)
|
|
return self
|
|
|
|
def __isub__(self, func: Callable[Params, Return]) -> Self:
|
|
self.remove_listener(func)
|
|
return self
|
|
|
|
def trigger(self, *args: Params.args, **kwargs: Params.kwargs) -> None:
|
|
for func in self.__listeners:
|
|
func(*args, **kwargs)
|
|
|
|
class KotoneBotEvents:
|
|
def __init__(self):
|
|
self.task_status_changed = Event[
|
|
[Task, TaskStatusValue], None
|
|
]()
|
|
self.task_error = Event[
|
|
[Task, Exception], None
|
|
]()
|
|
self.finished = Event[[], None]()
|
|
|
|
|
|
class KotoneBot:
|
|
def __init__(
|
|
self,
|
|
module: str,
|
|
config_path: str,
|
|
config_type: type = dict[str, Any],
|
|
*,
|
|
debug: bool = False,
|
|
resume_on_error: bool = False,
|
|
auto_save_error_report: bool = False,
|
|
):
|
|
"""
|
|
初始化 KotoneBot。
|
|
|
|
:param module: 主模块名。此模块及其所有子模块都会被载入。
|
|
:param config_type: 配置类型。
|
|
:param debug: 调试模式。
|
|
:param resume_on_error: 在错误时是否恢复。
|
|
:param auto_save_error_report: 是否自动保存错误报告。
|
|
"""
|
|
self.module = module
|
|
self.config_path = config_path
|
|
self.config_type = config_type
|
|
# HACK: 硬编码
|
|
self.current_config: int | str = 0
|
|
self.debug = debug
|
|
self.resume_on_error = resume_on_error
|
|
self.auto_save_error_report = auto_save_error_report
|
|
self.events = KotoneBotEvents()
|
|
self.backend_instance: Instance | None = None
|
|
|
|
if self.auto_save_error_report:
|
|
raise NotImplementedError('auto_save_error_report not implemented yet.')
|
|
|
|
def initialize(self):
|
|
"""
|
|
初始化并载入所有任务和动作。
|
|
"""
|
|
logger.info('Initializing tasks and actions...')
|
|
logger.debug(f'Loading module: {self.module}')
|
|
# 加载主模块
|
|
importlib.import_module(self.module)
|
|
|
|
# 加载所有子模块
|
|
pkg = importlib.import_module(self.module)
|
|
for loader, name, is_pkg in pkgutil.walk_packages(pkg.__path__, pkg.__name__ + '.'):
|
|
logger.debug(f'Loading sub-module: {name}')
|
|
try:
|
|
importlib.import_module(name)
|
|
except Exception:
|
|
logger.error(f'Failed to load sub-module: {name}')
|
|
logger.exception('Error: ')
|
|
|
|
logger.info('Tasks and actions initialized.')
|
|
logger.info(f'{len(task_registry)} task(s) and {len(action_registry)} action(s) loaded.')
|
|
|
|
def _on_create_device(self) -> Device:
|
|
"""
|
|
抽象方法，用于创建 Device 类，在 `run()` 方法执行前会被调用。
|
|
|
|
所有子类都需要重写该方法。
|
|
"""
|
|
raise NotImplementedError('Implement `_create_device` before using Kotonebot.')
|
|
|
|
def _on_init_context(self) -> None:
|
|
"""
|
|
初始化 Context 的钩子方法。子类可以重写此方法来自定义初始化逻辑。
|
|
默认实现调用 init_context 而不传入 target_screenshot_interval。
|
|
"""
|
|
d = self._on_create_device()
|
|
init_context(
|
|
config_path=self.config_path,
|
|
config_type=self.config_type,
|
|
target_device=d
|
|
)
|
|
|
|
def _on_after_init_context(self):
|
|
"""
|
|
抽象方法，在 init_context() 被调用后立即执行。
|
|
"""
|
|
pass
|
|
|
|
def run(self, tasks: list[Task], *, by_priority: bool = True):
|
|
"""
|
|
按优先级顺序运行所有任务。
|
|
"""
|
|
self._on_init_context()
|
|
self._on_after_init_context()
|
|
vars.flow.clear_interrupt()
|
|
|
|
if by_priority:
|
|
tasks = sorted(tasks, key=lambda x: x.priority, reverse=True)
|
|
for task in tasks:
|
|
self.events.task_status_changed.trigger(task, 'pending')
|
|
|
|
for task in tasks:
|
|
logger.info(f'Task started: {task.name}')
|
|
self.events.task_status_changed.trigger(task, 'running')
|
|
|
|
if self.debug:
|
|
task.func()
|
|
else:
|
|
try:
|
|
task.func()
|
|
self.events.task_status_changed.trigger(task, 'finished')
|
|
except StopCurrentTask:
|
|
logger.info(f'Task skipped/stopped: {task.name}')
|
|
self.events.task_status_changed.trigger(task, 'stopped')
|
|
# 用户中止
|
|
except KeyboardInterrupt as e:
|
|
logger.exception('Keyboard interrupt detected.')
|
|
for task1 in tasks[tasks.index(task):]:
|
|
self.events.task_status_changed.trigger(task1, 'cancelled')
|
|
vars.flow.clear_interrupt()
|
|
break
|
|
# 用户可以自行处理的错误
|
|
except UserFriendlyError as e:
|
|
logger.error(f'Task failed: {task.name}')
|
|
logger.exception(f'Error: ')
|
|
dialog = TaskDialog(
|
|
title='琴音小助手',
|
|
common_buttons=0,
|
|
main_instruction='任务执行失败',
|
|
content=e.message,
|
|
custom_buttons=e.action_buttons,
|
|
main_icon='error'
|
|
)
|
|
result_custom, _, _ = dialog.show()
|
|
e.invoke(result_custom)
|
|
# 其他错误
|
|
except Exception as e:
|
|
logger.error(f'Task failed: {task.name}')
|
|
logger.exception(f'Error: ')
|
|
report_path = None
|
|
if self.auto_save_error_report:
|
|
raise NotImplementedError
|
|
self.events.task_status_changed.trigger(task, 'error')
|
|
if not self.resume_on_error:
|
|
for task1 in tasks[tasks.index(task)+1:]:
|
|
self.events.task_status_changed.trigger(task1, 'cancelled')
|
|
break
|
|
logger.info(f'Task ended: {task.name}')
|
|
logger.info('All tasks ended.')
|
|
self.events.finished.trigger()
|
|
|
|
def run_all(self) -> None:
|
|
return self.run(list(task_registry.values()), by_priority=True)
|
|
|
|
def start(self, tasks: list[Task], *, by_priority: bool = True) -> RunStatus:
|
|
"""
|
|
在单独的线程中按优先级顺序运行指定的任务。
|
|
|
|
:param tasks: 要运行的任务列表
|
|
:param by_priority: 是否按优先级排序
|
|
:return: 运行状态对象
|
|
"""
|
|
run_status = RunStatus(running=True)
|
|
def _on_finished():
|
|
run_status.running = False
|
|
run_status.current_task = None
|
|
run_status.callstack = []
|
|
self.events.finished -= _on_finished
|
|
self.events.task_status_changed -= _on_task_status_changed
|
|
|
|
def _on_task_status_changed(task: Task, status: TaskStatusValue):
|
|
def _find(task: Task) -> TaskStatus:
|
|
for task_status in run_status.tasks:
|
|
if task_status.task == task:
|
|
return task_status
|
|
raise ValueError(f'Task {task.name} not found in run_status.tasks')
|
|
if status == 'pending':
|
|
run_status.tasks.append(TaskStatus(task=task, status='pending'))
|
|
else:
|
|
_find(task).status = status
|
|
|
|
self.events.task_status_changed += _on_task_status_changed
|
|
self.events.finished += _on_finished
|
|
thread = threading.Thread(target=lambda: self.run(tasks, by_priority=by_priority))
|
|
thread.start()
|
|
return run_status
|
|
|
|
def start_all(self) -> RunStatus:
|
|
"""
|
|
在单独的线程中运行所有任务。
|
|
|
|
:return: 运行状态对象
|
|
"""
|
|
return self.start(list(task_registry.values()), by_priority=True)
|