NeteaseMusicLyricDownloader/modules/functions/settings/save_load_settings.py

"""加载 or 保存设置文件"""

import json
import os


class Settings(object):  # 设定一个基础的存储设置信息的 class ,并设置形参用于 json 导入设置
    def __init__(self, l_p="./out/", l_f="%(name)s - %(artists)s", lang="en", a_s=True, s_l_t = True):
        self.lyric_path = l_p
        self.lyric_format = l_f
        self.language = lang
        self.auto_save = a_s
        self.save_lyrics_time = s_l_t


def class2dict(aclass: Settings):  # 让 json.dumps 将 class 转化为一个 dict ,用于保存
    return {
        "lyric_path": aclass.lyric_path,
        "lyric_format": aclass.lyric_format,
        "language": aclass.language,
        "auto_save": aclass.auto_save,
        "save_lyrics_time": aclass.save_lyrics_time
    }


def dict2class(adict):  # 让 json.load 将读取到的 dict 转化为我们所需要的 class
    if len(adict) != 4:  # 若检测到多余的设定将抛出异常
        raise json.decoder.JSONDecodeError("Too many keys", "none", 0)
    else:
        return Settings(
            l_p=adict["lyric_path"],
            l_f=adict["lyric_format"],
            lang=adict["language"],
            a_s=adict["auto_save"],
            s_l_t=adict["save_lyrics_time"]
        )


def load_settings() -> Settings:  # 加载 的函数
    """加载设置
    调用即可，无需参数
    返回: 设置 class"""
    if os.path.exists("settings.json"):  # 判断目录下是否存在 settings.json ,若没有则创建,若有则读取
        with open("settings.json", 'r', encoding="utf-8") as f:
            try:
                settings = json.load(f, object_hook=dict2class)  # 尝试转换 json 为 dict
                path = ""
                if not os.path.exists(settings.lyric_path):  # 检测输出文件夹,若文件夹不存在则在启动时创建
                    os.makedirs(settings.lyric_path, exist_ok=True)
                return settings
            except json.decoder.JSONDecodeError or KeyError:  # 如果检测到文件无法读取,将会删除设置文件并重新创建
                print("设置文件损坏,重新创建...")
                os.remove("settings.json")
                return load_settings()
    else:
        with open("settings.json", 'w', encoding="utf-8") as f:  # 当 settings.json 不存在时新建一个 settings.json 并写入默认配置
            f.write(json.dumps(Settings(), default=class2dict))
            settings = Settings()
            os.makedirs(settings.lyric_path, exist_ok=True)
            return settings


def save_settings(settings):  # 保存 的函数
    """保存设置
    ``settings`` 传入一个 设置 class 将其序列化为json
    返回 done 即为完成，理论上不存在报错所以暂时没有做其他处理"""
    with open("settings.json", 'w', encoding="utf-8") as f:
        f.write(json.dumps(settings, default=class2dict))
    return "done"