cmd: add default prefix %

Author: jerrita

anon/common.py

@@ -1,5 +1,5 @@
 # 通用数据结构
-VERSION = '0.3.4'
+VERSION = '0.3.5'
 
 
 class AnonError(Exception):
@@ -54,3 +54,4 @@ class AnonExtraConfig(StructClass):
     log_file: str = '/dev/null'
     def_user: int = 114514191  # 默认用户，某些示例插件会使用
     def_group: int = 114514191  # 默认群组，某些示例插件会使用
+    cmd_prefix: str = '%'  # CommandManager 默认触发前缀

anon/plugin/builtins/cmd_helper.py

@@ -11,6 +11,7 @@ def __init__(self):
         self.brif = '获取可用帮助列表'
         self.usage = usage
         self.keywords = ['help', '帮助列表', '指令列表']
+        self.prefix = self.extras.cmd_prefix
 
     async def on_cmd(self, event: MessageEvent, args: list):
         pm = PluginManager()

anon/plugin/plugin.py

@@ -3,7 +3,7 @@
 
 import aiocron
 
-from ..common import SingletonObject, AnonError, StructClass
+from ..common import SingletonObject, AnonError, StructClass, AnonExtraConfig
 from ..event import Event, MessageEvent
 from ..logger import logger
 
@@ -38,12 +38,13 @@ def __init__(self, interested: List[Type[Event]] = None, **kwargs):
         super().__init__(**kwargs)
         if interested is not None:
             self.interested = interested
+        self.extras = AnonExtraConfig()
 
     def match_cmd(self, txt: str) -> bool:
         """
         是否需要响应 CMD
         """
-        return any(map(lambda x: txt.startswith(x), self.keywords))
+        return any(map(lambda x: txt.startswith(self.extras.cmd_prefix + x), self.keywords))
 
     def nop(self):
         pass

docs/cmd_manager.md

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

docs/extra_config.md

@@ -8,7 +8,8 @@ from anon import Bot
 anon = Bot('127.0.0.1:5800', '1114514',
            storage_dir='/var/run/anon',
            log_file='/dev/null',
-           def_user=114514191)
+           def_user=114514191,
+           cmd_prefix='%')
 ```
 
 可选项顾名思义，所有可配置项参见 `anon.common.AnonExtraConfig`