upd: zhihu plugin

Author: jerrita

anon/plugin/plugin.py

@@ -80,7 +80,10 @@ def prevent_after(self, event: Event) -> bool:
         return (isinstance(event, MessageEvent)
                 and self.match_cmd(event.msg.text_only))
 
-    async def on_cmd(self, event: MessageEvent, args: list):
+    async def on_cmd(self, event: MessageEvent, args: list) -> bool:
+        """
+        若出现异常，应返回 True，此时会自动回复插件用法
+        """
         pass
 
     async def on_event(self, event: Event):
@@ -114,11 +117,16 @@ def __init__(self, *args):
                 self.register_plugin(plugin)
             logger.info('PluginManager initialized.')
 
+    @staticmethod
+    async def cmd_wrapper(plugin: Plugin, event: MessageEvent):
+        if await plugin.on_cmd(event, event.msg.text_only.split()):
+            await event.reply(plugin.usage, quote=False)
+
     def broad_cast(self, event: Event):
         for plugin in self.plugins:
             if not plugin.default_filter(event) and not plugin.event_filter(event):
                 if isinstance(event, MessageEvent) and plugin.match_cmd(event.msg.text_only):
-                    task = asyncio.create_task(plugin.on_cmd(event, event.msg.text_only.split()))
+                    task = asyncio.create_task(self.cmd_wrapper(plugin, event))
                 else:
                     task = asyncio.create_task(plugin.on_event(event))
                 self.tasks.add(task)

docs/cmd_manager.md

@@ -23,7 +23,8 @@ async def date(event: MessageEvent, args):
 
 1. 在匹配到对应命令后，`PluginManager` 会阻止消息向后优先级的插件传递，意味着每条匹配的消息最多只会有一个处理函数被调用。
 2. 这意味着重名命令，总会用最先注册的插件处理。
-3. 如果你仍想让消息继续向下传递，则你应手动创建插件，例如:
+3. on_cmd 若返回 True 值，则会自动回复此插件的 Usage，这在错误处理中应该有用。
+4. 如果你仍想让消息继续向下传递，则你应手动创建插件，例如:
 
 ```python
 from anon.event import MessageEvent, Event

plugins/example/zhihu.py

@@ -48,9 +48,12 @@ async def get_zhihu_hot_list(date_str):
 
 class ZhihuPlugin(Plugin):
     bot: Bot
-    cron = '10 8-22/2 * * *'
+    cron = '10 8-20/4 * * *'
     group: int
     storage: Storage
+    brif = '定时知乎热榜'
+    usage = 'Usage: zhihu set/get <num>\n设置知乎热榜 topn'
+    keywords = ['zhihu']
 
     async def on_load(self):
         self.bot = Bot()
@@ -71,7 +74,7 @@ async def on_cron(self):
         hot_list = await get_zhihu_hot_list(date_str)
         top_n = self.storage['topn']
         if hot_list:
-            # 将热榜切分为每10个一组，应对手机QQ一条消息超过10个就无法渲染超链接的bug
+            # 将热榜切分为每 10 个一组，应对手机 QQ 一条消息超过 10 个就无法渲染超链接的 bug
             chunk_size = 10
             for i in range(0, len(hot_list[:top_n]), chunk_size):
                 logger.info(f'第{i + 1}组, chunk_size={chunk_size}, len(hot_list[:top_n])={len(hot_list[:top_n])}')
@@ -84,10 +87,19 @@ async def on_cron(self):
                 except Exception as e:
                     logger.error(f"发送消息时出错: {e}")
 
-    async def on_event(self, event: MessageEvent):
-        if event.raw.startswith('s/zhihu'):
-            self.storage['topn'] = int(event.raw[7:].strip())
-            await event.reply(f'Zhihu topn set to: {self.storage["topn"]}')
+    async def on_cmd(self, event: MessageEvent, args) -> bool:
+        if len(args) < 2:
+            return True
+
+        if args[1] == 'get':
+            await event.reply(f'当前 topn 设置为: {self.storage["topn"]}')
+        else:
+            try:
+                n = int(args[2])
+                self.storage['topn'] = n
+                await event.reply(f'知乎 topn 设置为: {n}')
+            except:
+                return True
 
 
 # 注册插件