from Models.Plugins import *
from plugins.__config.Events import *

@register(
    description="输出hello world",  # 插件描述
    version="1.0.0",                # 插件版本
    author="For_Lin0601",           # 作者
    priority=500  # 负数应预留给程序运行必须项, 请尽量不要出现重复的优先级, 否则函数触发顺序不易确定
)
class Config(Plugin):  # 注意类名会作为一些 不安全 函数的标识, 尽管在书写这些不安全函数时做了声明, 但还希望类名不重复

    def __init__(self):
        if self.is_first_init():  # 判断程序是否为第一次启动
            self.config = None
        else:
            self.config = Plugin.get_reload_config("config")
            # `get_reload_config()`不传参则返回热重载前设定的整个字典
            # 此函数背后字典将于热重载结束后清空, 推荐在热重载`on_reload`中通过`set_reload_config(key, value)`存入

    # 事件应写在`Events.py`中
    # GetConfig__ = "get_config__"
    # """获取配置

    #     kwargs:
    #         None

    #     return:
    #         config: ModuleType  # 配置模块(以 value = config.key 读取)
    # """

    @on(GetConfig__)  # 双下划线结尾表示必阻塞事件, 即只应当有此事件开发者自己注册此事件, 供外部`self.emit(GetConfig__)`使用
    def get_config(self, event: EventContext,  **kwargs):  # 函数名实际上没关系, 但建议规范命名, 以及不和`Plugin`中的函数名冲突
        """获取配置列表"""
        event.prevent_postorder()
        event.return_value = self.config  # 插件不显式`return`
        # 返回值请自行保存到`event.return_value`中, 主线程不做任何合法性判断

    # 若希望程序启动和重载完后都触发, 可以使用如下连续两个`@on()`装饰同一个函数
    @on(PluginsLoadingFinished)  # 插件首次加载时触发(程序启动时)
    @on(PluginsReloadFinished)  # 插件重载完成时触发
    def get_Config(self, event: EventContext,  **kwargs):
        from Event import GetConfig__
        # 此处除了主线程必须项必然出现, 其余项可能在程序第一次运行后才创建
        # 故此处强烈建议动态导入所需变量。否则可能需要多次`关闭-启动`项目才可导入所有变量
        # 另外的, 如果有两个或更多插件之间的变量相互引用, 相互触发, 会导致完全无法读取变量
        # 目前如果删去Events.py中除主线程必须项以外所有变量, 程序大约会在`关闭-启动`四次左右完全读取所有变量
        # `关闭-启动`是指主线程进入到while True: time.sleep(0xFF)后关闭程序, 启动程序等待主线程进入while True: time.sleep(0xFF)
        config = self.emit(GetConfig__)  # `emit`返回值请看`Events.py`中对应的注解
        # `emit`后续参数只接受`**kwargs`, 且在响应插件内打包为`kawrgs`参数
        # 优点是响应插件内必解包`kwargs`, 可做类型声明

    def on_reload(self):
        self.set_reload_config("config", self.config)
        # 此处会将配置写入`Plugin.__reload_config__`字典, 此字典将在热重载完成后才清空
        # 故如果有配置不需要热重载, 可在此暂存
        # 同时在`def __init__`中判断`self.is_first_init()`来决定设置配置或读取配置

    def on_stop(self):
        # 程序异常停止时调用, 比如数据库存储, 日志记录等
        # 无意外不调用
        pass