插件开发详解

注意

NamePicker正在向RinUI搬迁，以下内容可能不完全适用/完全不适用于NamePicker的较新版本

提示

您可以直接使用logger库记录日志

插件类

在 main.py定义一个名为Plugin，继承了NamePickerPluginBase.PluginBase的类即可声明插件

就像这样：

from .NamePickerPluginBase impoer PluginBase
class Plugin(PluginBase):
    def __init__(self):
        super().__init__()
        self.filters = [self.customFilter]# 在这里填入筛选函数
        self.filtersName = ["自定义筛选器"]# 在这里填入筛选器名字
        self.customKey = ["test"]# 在这里填入要求用户添加的字段
        self.customKeyTitle = ["测试用额外字段"]# 在这里填入字段标题

    def customFilter(self,name):
        return name["test"] != "9191"

    def beforePick(self):
        # 在这编写抽选按钮按下后，抽选结果产生前执行的操作
        logger.info("Before Pick")

    def afterPick(self,name):
        # 在这编写抽选按钮按下后，抽选结果产生后执行的操作
        logger.info("After Pick")
        logger.info(name)

    def onStartup(self):
        # 在这编写插件被加载时执行的操作
        logger.info("Startup")

注

插件类方法的讲解都将基于上方的代码

传入名单

您可能会注意到，customFilter和afterPick都会传入叫name的参数

该参数提供了一个名单中的名字，格式如下：

{
    "name":"example,
    "sex":"0",
    "no":"1",
    ...以及其他字段
}

而在afterPick中，name参数则会传入一个列表，包含一个或若干个这样的名字

筛选器

在self.filters中添加作为筛选器的函数，并在self.filtersName中添加与其一一对应的筛选器名字

筛选器函数接收如上文所提到的名字，返回一个布尔值，若符合筛选要求则为True，否则为False

事件函数

在触发某些事件时，会执行该函数

函数名	触发时机	是否传递参数？
onStartup	插件被加载时	否
beforePick	抽选按钮按下后，抽选结果产生前	否
afterPick	抽选按钮按下后，抽选结果产生后	是（见上文“传入名单”）

要求用户添加字段

在self.customKey中添加要求用户添加的字段名（不推荐中文），并在self.customKeyTitle中添加与其一一对应的字段可读名字（在名单编辑中显示）

添加的字段将在上文“传入名单”中的字典中一起传递给插件

设置类

过时内容

这段内容已经过时，仅适用于RinUI重构前的NamePicker插件

在 main.py定义一个名为Settings，继承了NamePickerPluginBase.SettingBase的类即可声明插件设置页，插件设置页将在NamePicker的设置中展示

就像这样：

class Settings(SettingBase):
    def __init__(self):
        super().__init__()
        # 在这编写设置界面
        self.testCard = SettingCard(
            icon=FluentIcon.INFO,
            title="测试配置项",
            content="这是一个配置项"
        )
        self.vbox = VBoxLayout(self)
        self.vbox.addWidget(self.testCard)

具体如何编写请参照QFluentWidgets文档

不要使用QFluentWidgets提供的配置类存储配置，会把软件的配置顶掉的

TODO