nonebot-plugin-styledstr 1.0.2

A styled string management plugin for NoneBot 2

nonebot-plugin-styledstr

NoneBot 2 风格化字符串管理插件。

介绍

风格化字符串管理，或称字符串资源管理，即通过字符串标签来标识和获取一个字符串内容。设计初衷是用于灵活控制机器人的输出内容。

字符串标签

字符串标签用以在风格预设文件中唯一标识一个字符串内容。字符串标签使用点记法表示层级结构。举个例子，如果一个字符串在预设文件中的层级结构是这样的：

{
    "one": {
        "sample": {
            "structure": "something"
        }
    }
}

那么这个字符串 something 的标签即为 one.sample.structure。

风格预设

该插件可以通过不同的风格预设来切换相同字符串标签的内容，通过这种方式，你可以为你的 GLADoS 机器人加装各种“人格核心”，或者让它变成一个“语言通”（即国际化）。使用方法可以参考 使用用例。

这也是为何我将这个插件命名为“风格化字符串管理”而非诸如“字符串资源管理”一类的名称（虽然这名称依旧很烂）。

安装

安装此插件需要 Python 3.8 及以上版本。

使用 nb-cli 安装

注意： 请确认已安装 nb-cli。

nb plugin install nonebot-plugin-styledstr

使用 Poetry 安装

注意： 需要另外安装 Poetry。

poetry add nonebot-plugin-styledstr

使用 pip 安装

pip install nonebot-plugin-styledstr

使用准备

配置

注意： 使用该插件前，请务必在项目中创建存放字符串资源的目录，并通过下面的配置项指定其为资源目录。关于如何设置插件配置项，参考 NoneBot 2 官方文档的 基本配置 章节。

该插件可通过在配置文件中添加如下配置项对部分功能进行配置。

• STYLEDSTR_RESPATH：字符串资源目录，默认为当前工作目录（建议在 bot.py 文件中使用 pathlib 进行配置或使用绝对路径，若使用相对路径请确保工作目录为项目根目录。建议手动配置。）；
• STYLEDSTR_PRESET：风格预设，默认为 default。

为项目添加风格预设文件

在字符串资源目录下根据需要创建风格预设文件。风格预设文件以 YAML 或 JSON 文件存储，并需确保文件名与风格预设配置一致，文件名对大小写不敏感。例如若风格预设配置为 default，则需要保证字符串资源目录下存在文件名为 default 的 YAML 或 JSON 文件。

如果在资源目录下同时存在多个满足同一预设的文件（例如同时存在 default.yaml 与 default.json），则会按 .json > .yaml > .yml 的优先级读取文件。

加载插件并获取解析器对象

参考 NoneBot 2 官方文档的 加载插件 章节，在项目中加载该插件：

>>> from nonebot import require
# 以默认配置获取解析器对象（.env.* 文件或 nonebot 初始化时的配置）
>>> parser = require('nonebot_plugin_styledstr').init()
# 使用 nonebot.config 配置获取解析器对象
>>> import nonebot
>>> config = nonebot.get_driver().config
>>> config.styledstr_preset = 'custom'
>>> parser = require('nonebot_plugin_styledstr').init(config)
# 使用字典配置获取解析器对象
>>> from pathlib import Path
>>> config = {
...     'styledstr_respath': Path('path/to/respath'),
...     'styledstr_preset': 'custom'
... }
>>> parser = require('nonebot_plugin_styledstr').init(config)

使用

参见 使用用例 了解该插件的用法。

部署

如果你想要协助维护本项目，你可以按照以下方式将项目部署至本地：

警告： 直接从本存储库部署的项目可能包含未经测试的代码，这可能会导致不可预测的行为，请 不要运行在生产环境中。

git clone https://github.com/jks15satoshi/nonebot_plugin_styledstr.git
cd nonebot_plugin_styledstr
# 推荐以下述方式安装依赖（需要另外安装 Poetry）
poetry install
# 或者使用 pip 安装依赖，建议参照 Python 文档创建并激活虚拟环境后安装
# https://docs.python.org/zh-cn/3/tutorial/venv.html#creating-virtual-environments
pip install .

许可协议

该项目以 MIT 协议开放源代码，详阅 LICENSE 文件。