调用全局配置

June 8, 2025 · View on GitHub

Coral 全局配置是通过 config 类提供的。 它的调用格式和 json 格式类似,可以通过 config.get('section.key') 的方式获取配置项的值。

调用 config变动配置时,config.config自动更新并保存到文件中,不需要手动保存。

这里以插件注册函数为例,展示如何调用全局配置。

示例

  1. 引入 config

    在编写好函数后,我们得到了示例函数 get_self_id

    from Coral import config, on_function
    
    @on_function("get_self_id")
    async def get_self_id(*args):
        # 获取 self_id 配置项的值
    
    

    这里我们导入了 config 类,代表全局配置。

  2. 调用配置项

    你可以通过 config.get('section.key', default=None) 的方式获取配置项的值。

    async def get_self_id(*args):
        self_id = config.get('self_id', '123456789')
        return self_id
    

    这里,我们通过 config.get('self_id', '123456789') 的方式获取 self_id 配置项的值,如果没有配置项,则设置并返回默认值 '123456789'

    同样地,你可以使用 config.set('section.key', value) 的方式设置配置项的值。

    async def set_self_id(self_id, *args):
        config.set('self_id', self_id)
        return None
    

    这里,我们通过 config.set('self_id', self_id) 的方式设置 self_id 配置项的值。