nonebot-plugin-picmenu-next 0.3.0__tar.gz → 0.3.2__tar.gz

{nonebot_plugin_picmenu_next-0.3.0 → nonebot_plugin_picmenu_next-0.3.2}/LICENSE

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2023 LgCookie
+Copyright (c) 2023 LgCuwukii
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

{nonebot_plugin_picmenu_next-0.3.0 → nonebot_plugin_picmenu_next-0.3.2}/PKG-INFO

@@ -1,9 +1,9 @@
 Metadata-Version: 2.4
 Name: nonebot-plugin-picmenu-next
-Version: 0.3.0
+Version: 0.3.2
 Summary: Next-gen PicMenu plugin for NoneBot2
 Project-URL: homepage, https://github.com/lgc-NB2Dev/nonebot-plugin-picmenu-next
-Author-email: LgCookie <lgc2333@126.com>
+Author-email: LgCuwukii <lgc2333@126.com>
 License: MIT
 License-File: LICENSE
 Requires-Python: <4.0,>=3.10
@@ -77,6 +77,20 @@ _✨ 新一代的图片帮助插件 ✨_
 
 </div>
 
+## ℹ️ Tip
+
+htmlrender 插件 v0.7 版本目前可能存在未配置渲染后端导致启动报错的问题，可以添加以下配置项解决：
+
+```properties
+RENDER_BACKEND=playwright
+```
+
+可选添加以下项，使浏览器在 Bot 启动时预加载并启动：
+
+```properties
+RENDER_STARTUP_MODE=probe
+```
+
 ## 📖 介绍
 
 - ✨ **美观的图片界面**：直观友好的图片界面
@@ -245,6 +259,16 @@ Telegram：[@lgc2333](https://t.me/lgc2333)
 
 ## 📝 更新日志
 
+### 0.3.2
+
+- 优化 Alconna 帮助接管逻辑：更好地支持隐藏插件与隐藏命令，并在缺少功能菜单项时基于当前命令临时生成详情页
+- 调整模板上下文，补充功能索引与隐藏内容权限语义，便于模板区分普通帮助与 Alconna 帮助接管场景
+
+### 0.3.1
+
+- 调整 Alconna Markdown 帮助格式
+- 现在启用接管 Alconna 帮助输出时，会按当前子命令节点生成帮助内容，而不是始终使用根命令的帮助内容
+
 ### 0.3.0
 
 - 新增 Alconna 集成：
@@ -256,8 +280,6 @@ Telegram：[@lgc2333](https://t.me/lgc2333)
 - 优化 Alconna 命令帮助的 Markdown 生成格式，并在插件启用 Markdown 且命令未自定义 formatter 时自动使用
 - 修复普通帮助菜单中，插件详情页仍会展示隐藏功能项的问题
 - 修复默认模板 Markdown 渲染中触发方式、触发条件等字段的换行排版问题
-- 完善开发文档，新增 Alconna 自动探测、禁用探测、强制附加探测结果与 mixin 注意事项说明
-- 补充 Alconna 自动探测与适配器过滤相关测试
 
 ### 0.2.0
 

{nonebot_plugin_picmenu_next-0.3.0 → nonebot_plugin_picmenu_next-0.3.2}/README.md

@@ -48,6 +48,20 @@ _✨ 新一代的图片帮助插件 ✨_
 
 </div>
 
+## ℹ️ Tip
+
+htmlrender 插件 v0.7 版本目前可能存在未配置渲染后端导致启动报错的问题，可以添加以下配置项解决：
+
+```properties
+RENDER_BACKEND=playwright
+```
+
+可选添加以下项，使浏览器在 Bot 启动时预加载并启动：
+
+```properties
+RENDER_STARTUP_MODE=probe
+```
+
 ## 📖 介绍
 
 - ✨ **美观的图片界面**：直观友好的图片界面
@@ -216,6 +230,16 @@ Telegram：[@lgc2333](https://t.me/lgc2333)
 
 ## 📝 更新日志
 
+### 0.3.2
+
+- 优化 Alconna 帮助接管逻辑：更好地支持隐藏插件与隐藏命令，并在缺少功能菜单项时基于当前命令临时生成详情页
+- 调整模板上下文，补充功能索引与隐藏内容权限语义，便于模板区分普通帮助与 Alconna 帮助接管场景
+
+### 0.3.1
+
+- 调整 Alconna Markdown 帮助格式
+- 现在启用接管 Alconna 帮助输出时，会按当前子命令节点生成帮助内容，而不是始终使用根命令的帮助内容
+
 ### 0.3.0
 
 - 新增 Alconna 集成：
@@ -227,8 +251,6 @@ Telegram：[@lgc2333](https://t.me/lgc2333)
 - 优化 Alconna 命令帮助的 Markdown 生成格式，并在插件启用 Markdown 且命令未自定义 formatter 时自动使用
 - 修复普通帮助菜单中，插件详情页仍会展示隐藏功能项的问题
 - 修复默认模板 Markdown 渲染中触发方式、触发条件等字段的换行排版问题
-- 完善开发文档，新增 Alconna 自动探测、禁用探测、强制附加探测结果与 mixin 注意事项说明
-- 补充 Alconna 自动探测与适配器过滤相关测试
 
 ### 0.2.0
 

{nonebot_plugin_picmenu_next-0.3.0 → nonebot_plugin_picmenu_next-0.3.2}/docs/development.md

@@ -90,7 +90,7 @@ __plugin_meta__ = PluginMetadata(
     usage="插件用法说明",
     type="application",
     extra={
-        "author": "LgCookie",
+        "author": "LgCuwukii",
         "version": "1.0.0",
         "pmn": {
             "hidden": False,
@@ -281,6 +281,7 @@ from nonebot_plugin_picmenu_next.templates import (
 async def render_index(
     infos: list[PMNPluginInfo],
     showing_hidden: bool,
+    user_can_see_hidden: bool | None,
 ) -> UniMessage:
     text = "\n".join(f"{i}. {info.name}" for i, info in enumerate(infos, 1))
     return UniMessage.text(text)
@@ -291,6 +292,7 @@ async def render_detail(
     info: PMNPluginInfo,
     info_index: int,
     showing_hidden: bool,
+    user_can_see_hidden: bool | None,
 ) -> UniMessage:
     return UniMessage.text(f"{info.name}\n\n{info.description or ''}")
 
@@ -300,8 +302,9 @@ async def render_func_detail(
     info: PMNPluginInfo,
     info_index: int,
     func: PMDataItem,
-    func_index: int,
+    func_index: int | None,
     showing_hidden: bool,
+    user_can_see_hidden: bool | None,
 ) -> UniMessage:
     return UniMessage.text(f"{info.name} > {func.func}\n\n{func.detail_des}")
 ```
@@ -310,4 +313,8 @@ async def render_func_detail(
 
 单个插件也可以通过 `extra["pmn"]["template"]` 指定详情页模板，单个功能可以通过 `pmn_template` 指定功能详情页模板。
 
+`func_index` 表示当前功能在插件功能列表中的 0 基序号；当功能详情来自 Alconna `-h/--help` 接管时，如果当前命令没有对应的已注册菜单项，PicMenu Next 会临时生成一个功能项，此时 `func_index` 为 `None`。
+
+`user_can_see_hidden` 表示当前用户是否有权限查看隐藏内容；仅当 `showing_hidden` 为 `True` 时会计算该值，否则为 `None`。如果它为 `False`，在当前版本下可以确定这个渲染请求的来源是 Alconna 扩展。模板可以用它决定是否展示继续使用 `-H/--show-hidden` 的提示文本。
+
 模板实现本身是黑盒接口：可以输出图片，也可以输出文字；可以使用 htmlrender，也可以使用其它渲染方式。若模板依赖特定渲染后端，应在模板实现内部自行检查并抛出清晰错误。

{nonebot_plugin_picmenu_next-0.3.0 → nonebot_plugin_picmenu_next-0.3.2}/nonebot_plugin_picmenu_next/__init__.py

@@ -12,7 +12,7 @@ from .config import ConfigModel
 from .data_source import refresh_infos
 from .templates import load_builtin_templates
 
-__version__ = "0.3.0"
+__version__ = "0.3.2"
 __plugin_meta__ = PluginMetadata(
     name="PicMenu Next",
     description="新一代的图片帮助插件",
@@ -21,7 +21,7 @@ __plugin_meta__ = PluginMetadata(
     homepage="https://github.com/lgc-NB2Dev/nonebot-plugin-picmenu-next",
     config=ConfigModel,
     supported_adapters=inherit_supported_adapters("nonebot_plugin_alconna"),
-    extra={"License": "MIT", "Author": "LgCookie"},
+    extra={"License": "MIT", "Author": "LgCuwukii"},
 )
 
 load_builtin_templates()

{nonebot_plugin_picmenu_next-0.3.0 → nonebot_plugin_picmenu_next-0.3.2}/nonebot_plugin_picmenu_next/__main__.py

@@ -1,10 +1,18 @@
 from collections.abc import Sequence
 from contextlib import suppress
 from pathlib import Path
-from typing import TypeVar, cast, overload
+from typing import TypeVar, overload
 from typing_extensions import override
 
-from arclet.alconna import Alconna, Arg, Args, CommandMeta, Option, store_true
+from arclet.alconna import (
+    Alconna,
+    Arg,
+    Args,
+    CommandMeta,
+    Option,
+    TextFormatter,
+    store_true,
+)
 from cookit.pyd import model_copy
 from loguru import logger
 from nonebot.adapters import Adapter as BaseAdapter, Bot as BaseBot, Event as BaseEvent
@@ -17,7 +25,11 @@ from thefuzz import process
 
 from .config import config
 from .data_source import get_infos
-from .data_source.alconna import get_alconna_plugin_id
+from .data_source.alconna import (
+    PMNMarkdownTextFormatter,
+    generate_alconna_menu_item,
+    get_alconna_plugin_id,
+)
 from .data_source.mixin import resolve_detail_mixin, resolve_main_mixin
 from .data_source.models import PinyinChunkSequence, PMDataItem, PMNPluginInfo
 from .templates import detail_templates, func_detail_templates, index_templates
@@ -41,7 +53,7 @@ alc = Alconna(
     ),
     meta=CommandMeta(
         description="新一代的图片帮助插件",
-        author="LgCookie",
+        author="LgCuwukii",
     ),
 )
 m_cls = on_alconna(
@@ -197,9 +209,18 @@ def filter_unsupported_adapters(
     ]
 
 
+async def can_user_see_hidden(bot: BaseBot, ev: BaseEvent) -> bool:
+    if not config.only_superuser_see_hidden:
+        return True
+    with suppress(Exception):
+        return await SUPERUSER(bot, ev)
+    return False
+
+
 @overload
 async def render_menu(
     bot: BaseBot,
+    ev: BaseEvent,
     *,
     q_plugin: str | None = None,
     q_function: str | None = None,
@@ -210,19 +231,25 @@ async def render_menu(
 @overload
 async def render_menu(
     bot: BaseBot,
+    ev: BaseEvent,
     *,
     plugin_id: str | None = None,
     alc_cmd_id: str | None = None,
+    alc_command: Alconna | None = None,
+    alc_detail_des: str | None = None,
     show_hidden: bool = False,
 ) -> tuple[UniMessage | None, PMNPluginInfo | None, PMDataItem | None]: ...
 
 
 async def render_menu(
     bot: BaseBot,
+    ev: BaseEvent,
     q_plugin: str | None = None,
     q_function: str | None = None,
     plugin_id: str | None = None,
     alc_cmd_id: str | None = None,
+    alc_command: Alconna | None = None,
+    alc_detail_des: str | None = None,
     show_hidden: bool = False,
 ) -> tuple[UniMessage | None, PMNPluginInfo | None, PMDataItem | None]:
     infos = filter_unsupported_adapters(get_infos(), bot.adapter)
@@ -232,6 +259,8 @@ async def render_menu(
     if not infos:
         return None, None, None
 
+    user_can_see_hidden = await can_user_see_hidden(bot, ev) if show_hidden else None
+
     if plugin_id:
         r = next(
             ((i, x) for i, x in enumerate(infos) if x.plugin_id == plugin_id), None
@@ -239,7 +268,11 @@ async def render_menu(
     elif q_plugin:
         r = await query_plugin(infos, q_plugin)
     else:
-        return await index_templates.get()(infos, show_hidden), None, None
+        return (
+            await index_templates.get()(infos, show_hidden, user_can_see_hidden),
+            None,
+            None,
+        )
 
     if not r:
         return None, None, None
@@ -253,31 +286,35 @@ async def render_menu(
         return (
             await detail_templates.get(
                 info.pmn.template,
-            )(info, info_index, show_hidden),
+            )(info, info_index, show_hidden, user_can_see_hidden),
             info,
             None,
         )
 
-    pm_data = info.pm_data
-    if not pm_data:
-        return None, info, None
-
     if alc_cmd_id:
+        pm_data = info.pm_data or []
         r = next(
             ((i, x) for i, x in enumerate(pm_data) if x.alc_cmd_id == alc_cmd_id), None
         )
+        if (not r) and alc_command and show_hidden:
+            r = (None, generate_alconna_menu_item(alc_command, info.pmn.markdown))
     else:
         assert q_function is not None
+        pm_data = info.pm_data
+        if not pm_data:
+            return None, info, None
         r = await query_func_detail(pm_data, q_function)
 
     if not r:
         return None, info, None
 
     func_index, func = r
+    if alc_detail_des is not None:
+        func = model_copy(func, update={"detail_des": alc_detail_des})
     return (
         await func_detail_templates.get(
             func.template,
-        )(info, info_index, func, func_index, show_hidden),
+        )(info, info_index, func, func_index, show_hidden, user_can_see_hidden),
         info,
         func,
     )
@@ -305,6 +342,7 @@ async def _(
 
     msg, info, func = await render_menu(
         bot,
+        ev,
         q_plugin=(qp := q_plugin.result),
         q_function=(qf := q_function.result),
         show_hidden=show_hidden,
@@ -330,8 +368,14 @@ async def _(
     ).finish(reply_to=True)
 
 
+# Alconna formats `-h/--help` before `output_converter`, and that converter does
+# not receive the current Arparma. To avoid reparsing help text, replace the
+# command formatter with PicMenu's markdown formatter before parsing. `post_init`
+# is the earliest chance; if plugin ownership/registry data is not ready there,
+# retry in `validate`, which runs before help parsing.
 class PMNHelpExtension(Extension):
     command: "Alconna | None" = None
+    _formatter_checked: bool = False
 
     @property
     def priority(self) -> int:
@@ -341,6 +385,32 @@ class PMNHelpExtension(Extension):
     def id(self) -> str:
         return "picmenu-next-help"
 
+    def _ensure_markdown_formatter(self) -> None:
+        if self._formatter_checked or not self.command:
+            return
+        plugin_id = get_alconna_plugin_id(self.command)
+        if not plugin_id:
+            return
+        info = next((x for x in get_infos() if x.plugin_id == plugin_id), None)
+        if info is None:
+            return
+        self._formatter_checked = True
+        if (nm := (not info.pmn.markdown)) or (
+            type(self.command.formatter) is not TextFormatter
+        ):
+            logger.debug(
+                f"Markdown formatter set skipped for command {self.command.path}"
+                f" ({'Does not support markdown' if nm else 'Already has custom formatter'})",
+            )
+            return
+        self.command.formatter = PMNMarkdownTextFormatter().add(self.command)
+        logger.debug(f"Markdown formatter applied to command {self.command.path}")
+
+    @override
+    def validate(self, bot: BaseBot, event: BaseEvent) -> bool:
+        self._ensure_markdown_formatter()
+        return super().validate(bot, event)
+
     @override
     async def output_converter(
         self,
@@ -352,19 +422,37 @@ class PMNHelpExtension(Extension):
             and self.command
             and (plugin_id := get_alconna_plugin_id(self.command))
         ):
-            bot = cast("BaseBot", await self.inject(("bot", BaseBot)))
-            msg, _, _ = await render_menu(
+            bot = await self.inject(("bot", BaseBot))
+            ev = await self.inject(("event", BaseEvent))
+
+            msg, p, _ = await render_menu(
                 bot,
+                ev,
                 plugin_id=plugin_id,
                 alc_cmd_id=self.command.path,
+                alc_command=self.command,
+                alc_detail_des=content,
             )
+            if (not msg) and (not p):
+                msg, _, _ = await render_menu(
+                    bot,
+                    ev,
+                    plugin_id=plugin_id,
+                    alc_cmd_id=self.command.path,
+                    alc_command=self.command,
+                    alc_detail_des=content,
+                    show_hidden=True,
+                )
+
             if msg:
                 return msg
+
         return await super().output_converter(output_type, content)
 
     @override
     def post_init(self, alc: "Alconna") -> None:
         self.command = alc
+        self._ensure_markdown_formatter()
 
 
 if config.alconna_global_ext: