AyakaConfig

所有ayaka衍生插件均可申请读写data/ayaka/ayaka_setting.json中的配置

定义

将配置数据打包到一个类中，该类继承自AyakaConfig，编写方法参考pydantic.BaseModel

注意，继承时必须编写__app_name__属性的值

from ayaka import AyakaConfig
from typing import List

class Config(AyakaConfig):
    __app_name__ = "一个名字"
    name:str = ""
    age:int = 0
    numbers:List[int] = [1,2]

注意，一定要编写类型提示和默认值

代码	备注
name:str = ""	正确
name = ""	错误
name:str	错误
name	错误

如果配置文件不存在，或存在但并没有该插件的配置数据，那么此时默认值便会写入配置文件中，因此，一定要编写默认值

读取

直接实例化即可

# 加载配置
config = Config()

# 使用配置
@app.on_cmd("f1")
async def func_1():
    print(config.name, config.age, config.numbers)

对应配置文件data/ayaka/ayaka_setting.json

{
    "一个名字": {
        "name": "",
        "age": 0,
        "numbers": [ 1, 2 ]
    },
    ...
}

修改

如果是修改不可变对象，那么ayaka会自动将新配置写入文件；

如果是修改数组、字典等可变对象的值，则需要调用AyakaConfig().save()方法来提醒ayaka将数据写入文件

# 修改不可变对象
@app.on_cmd("f1")
async def func_1():
    config.name = "测试1"

# 修改可变对象
@app.on_cmd("f2")
async def func_2():
    config.numbers.append(-1)
    config.save()

注意，即使调用了AyakaConfig().save()方法，也不意味着数据马上更新到配置文件中，ayaka可能会等待0~60s后才执行写入操作

进阶：可以嵌套

可以嵌套其他BaseModel模型

from pydantic import BaseModel
from ayaka import AyakaConfig, AyakaApp

app = AyakaApp("test")


class User(BaseModel):
    name: str
    age: int


class Config(AyakaConfig):
    __app_name__ = app.name
    user: User = User(name="默认", age=0)
    id:int = 1000


config = Config()


@app.on_cmd("f1")
async def func_1():
    print(config.user.name)


@app.on_cmd("f2")
async def func_1():
    config.user.name = "改名了"
    # 需要调用save
    config.save()

@app.on_cmd("f3")
async def func_1():
    config.id = 123
    # 不需要调用save
    # config.save()

对应配置文件

    "test": {
        "user": {
            "name": "默认",
            "age": 0
        },
        "id": 1000
    }

AyakaLargeConfig

当配置型较多时，建议使用AyakaLargeConfig，它读写的是独立配置文件，data/ayaka/separate/<__app_name__>.json

使用方法与AyakaConfig一致，仅存储位置不同而已

下一步

在这里~ ↘