pymud 0.21.0a4__py3-none-any.whl → 0.21.0a5__py3-none-any.whl

pymud/__init__.py

@@ -1,17 +1,17 @@
 from .settings import Settings
 from .pymud import PyMudApp
-from .modules import IConfig, PymudDecorator, PymudMeta, alias, trigger, timer, gmcp
+from .modules import IConfigBase, IConfig, PymudMeta
 from .objects import CodeBlock, Alias, SimpleAlias, Trigger, SimpleTrigger, Command, SimpleCommand, Timer, SimpleTimer, GMCPTrigger
 from .extras import DotDict
-from .session import Session, exception, async_exception
+from .session import Session
 from .logger import Logger
 from .main import main
+from .decorators import exception, async_exception, PymudDecorator, alias, trigger, timer, gmcp
 
 __all__ = [
-    "PymudDecorator", "PymudMeta", "alias", "trigger", "timer", "gmcp",
-    "IConfig", "PyMudApp", "Settings", "CodeBlock", 
+    "PymudMeta", "IConfigBase", "IConfig", "PyMudApp", "Settings", "CodeBlock", 
     "Alias", "SimpleAlias", "Trigger", "SimpleTrigger", 
     "Command", "SimpleCommand", "Timer", "SimpleTimer", 
     "GMCPTrigger", "Session", "DotDict", "Logger", "main",
-    "exception", "async_exception"
+    "exception", "async_exception", "PymudDecorator", "alias", "trigger", "timer", "gmcp",
 ]

pymud/decorators.py

@@ -0,0 +1,234 @@
+import sys, functools, traceback
+from typing import Union, Optional, List
+
+def print_exception(session, e: Exception):
+    """打印异常信息"""
+    from .settings import Settings
+    from .session import Session
+    if isinstance(session, Session):
+        # tb = sys.exc_info()[2]
+        # frames = traceback.extract_tb(tb)
+        # frame = frames[-1]
+        # session.error(Settings.gettext("exception_traceback", frame.filename, frame.lineno, frame.name), Settings.gettext("script_error"))
+        # if frame.line:
+        #     session.error(f"    {frame.line}", Settings.gettext("script_error"))
+
+        # session.error(Settings.gettext("exception_message", type(e).__name__, e), Settings.gettext("script_error"))
+        # session.error("===========================", Settings.gettext("script_error"))
+        session.error(traceback.format_exc(), Settings.gettext("script_error"))
+
+def exception(func):
+    """方法异常处理装饰器，捕获异常后通过会话的session.error打印相关信息"""
+    @functools.wraps(func)
+    def wrapper(self, *args, **kwargs):
+        from .objects import BaseObject
+        from .modules import ModuleInfo, IConfig
+        from .session import Session
+        from .settings import Settings
+        try:
+            return func(self, *args, **kwargs)
+        except Exception as e:
+            # 调用类的错误处理方法
+            if isinstance(self, Session):
+                session = self
+            elif isinstance(self, (BaseObject, IConfig, ModuleInfo)):
+                session = self.session
+            else:
+                session = None
+                
+            if isinstance(session, Session):
+                print_exception(session, e)
+                #session.error(Settings.gettext("exception_message", e, type(e)))
+                #session.error(Settings.gettext("exception_traceback", traceback.format_exc()))
+            else:
+                raise  # 当没有会话时，选择重新抛出异常
+    return wrapper
+
+def async_exception(func):
+    """异步方法异常处理装饰器，捕获异常后通过会话的session.error打印相关信息"""
+    @functools.wraps(func)
+    async def wrapper(self, *args, **kwargs):
+        from .objects import BaseObject
+        from .modules import ModuleInfo, IConfig
+        from .session import Session
+        from .settings import Settings
+        try:
+            return await func(self, *args, **kwargs)
+        except Exception as e:
+            if isinstance(self, Session):
+                session = self
+            elif isinstance(self, (BaseObject, IConfig, ModuleInfo)):
+                session = self.session
+            else:
+                session = None
+
+            if isinstance(session, Session):
+                print_exception(session, e)
+
+            else:
+                raise  # 当没有会话时，选择重新抛出异常
+    return wrapper
+
+
+class PymudDecorator:
+    """
+    装饰器基类。使用装饰器可以快捷创建各类Pymud基础对象。
+    
+        :param type: 装饰器的类型，用于区分不同的装饰器，为字符串类型。
+        :param args: 可变位置参数，用于传递额外的参数。
+        :param kwargs: 可变关键字参数，用于传递额外的键值对参数。
+    """
+    def __init__(self, type: str, *args, **kwargs):
+        self.type = type
+        self.args = args
+        self.kwargs = kwargs
+
+    def __call__(self, func):
+        decos = getattr(func, "__pymud_decorators__", [])
+        decos.append(self)
+        func.__pymud_decorators__ = decos
+
+        return func
+
+    def __repr__(self):
+        return f"<{self.__class__.__name__} type = {self.type} args = {self.args} kwargs = {self.kwargs}>"
+
+
+def alias(
+        patterns: Union[List[str], str], 
+        id: Optional[str] = None, 
+        group: str = "", 
+        enabled: bool = True, 
+        ignoreCase: bool = False, 
+        isRegExp: bool = True, 
+        keepEval: bool = False, 
+        expandVar: bool = True, 
+        priority: int = 100, 
+        oneShot: bool = False,  
+        *args, **kwargs):
+    """
+    使用装饰器创建一个别名（Alias）对象。被装饰的函数将在别名成功匹配时调用。
+    被装饰的函数，除第一个参数为类实例本身self之外，另外包括id, line, wildcards三个参数。
+    其中id为别名对象的唯一标识符，line为匹配的文本行，wildcards为匹配的通配符列表。
+
+    :param patterns: 别名匹配的模式。
+    :param id: 别名对象的唯一标识符，不指定时将自动生成唯一标识符。
+    :param group: 别名所属的组名，默认为空字符串。
+    :param enabled: 别名是否启用，默认为 True。
+    :param ignoreCase: 匹配时是否忽略大小写，默认为 False。
+    :param isRegExp: 模式是否为正则表达式，默认为 True。
+    :param keepEval: 若存在多个可匹配的别名时，是否持续匹配，默认为 False。
+    :param expandVar: 是否展开变量，默认为 True。
+    :param priority: 别名的优先级，值越小优先级越高，默认为 100。
+    :param oneShot: 别名是否只触发一次后自动失效，默认为 False。
+    :param args: 可变位置参数，用于传递额外的参数。
+    :param kwargs: 可变关键字参数，用于传递额外的键值对参数。
+    :return: PymudDecorator 实例，类型为 "alias"。
+    """
+    # 将传入的参数更新到 kwargs 字典中
+    kwargs.update({
+        "patterns": patterns,
+        "id": id, 
+        "group": group, 
+        "enabled": enabled, 
+        "ignoreCase": ignoreCase, 
+        "isRegExp": isRegExp, 
+        "keepEval": keepEval, 
+        "expandVar": expandVar, 
+        "priority": priority, 
+        "oneShot": oneShot})
+    
+    # 如果 id 为 None，则从 kwargs 中移除 "id" 键
+    if not id:
+        kwargs.pop("id")
+
+    return PymudDecorator("alias", *args, **kwargs)
+
+def trigger(
+        patterns: Union[List[str], str], 
+        id: Optional[str] = None, 
+        group: str = "", 
+        enabled: bool = True, 
+        ignoreCase: bool = False, 
+        isRegExp: bool = True, 
+        keepEval: bool = False, 
+        expandVar: bool = True, 
+        raw: bool = False, 
+        priority: int = 100, 
+        oneShot: bool = False,  
+        *args, **kwargs):
+    """
+    使用装饰器创建一个触发器（Trigger）对象。
+
+    :param patterns: 触发器匹配的模式。单行模式可以是字符串或正则表达式，多行模式必须是元组或列表，其中每个元素都是字符串或正则表达式。
+    :param id: 触发器对象的唯一标识符，不指定时将自动生成唯一标识符。
+    :param group: 触发器所属的组名，默认为空字符串。
+    :param enabled: 触发器是否启用，默认为 True。
+    :param ignoreCase: 匹配时是否忽略大小写，默认为 False。
+    :param isRegExp: 模式是否为正则表达式，默认为 True。
+    :param keepEval: 若存在多个可匹配的触发器时，是否持续匹配，默认为 False。
+    :param expandVar: 是否展开变量，默认为 True。
+    :param raw: 是否使用原始匹配方式，默认为 False。原始匹配方式下，不对 VT100 下的 ANSI 颜色进行解码，因此可以匹配颜色；正常匹配仅匹配文本。
+    :param priority: 触发器的优先级，值越小优先级越高，默认为 100。
+    :param oneShot: 触发器是否只触发一次后自动失效，默认为 False。
+    :param args: 可变位置参数，用于传递额外的参数。
+    :param kwargs: 可变关键字参数，用于传递额外的键值对参数。
+    :return: PymudDecorator 实例，类型为 "trigger"。
+    """
+    # 将传入的参数更新到 kwargs 字典中
+    kwargs.update({
+        "patterns": patterns,
+        "id": id, 
+        "group": group, 
+        "enabled": enabled, 
+        "ignoreCase": ignoreCase, 
+        "isRegExp": isRegExp, 
+        "keepEval": keepEval, 
+        "expandVar": expandVar, 
+        "raw": raw,
+        "priority": priority, 
+        "oneShot": oneShot})
+    if not id:
+        kwargs.pop("id")
+    return PymudDecorator("trigger", *args, **kwargs)
+
+def timer(timeout: float, id: Optional[str] = None, group: str = "", enabled: bool = True, *args, **kwargs):
+    """
+    使用装饰器创建一个定时器（Timer）对象。
+
+    :param timeout: 定时器超时时间，单位为秒。
+    :param id: 定时器对象的唯一标识符，不指定时将自动生成唯一标识符。
+    :param group: 定时器所属的组名，默认为空字符串。
+    :param enabled: 定时器是否启用，默认为 True。
+    :param args: 可变位置参数，用于传递额外的参数。
+    :param kwargs: 可变关键字参数，用于传递额外的键值对参数。
+    :return: PymudDecorator 实例，类型为 "timer"。
+    """
+    kwargs.update({
+        "timeout": timeout,
+        "id": id,
+        "group": group,
+        "enabled": enabled
+        })
+    if not id:
+        kwargs.pop("id")
+    return PymudDecorator("timer", *args, **kwargs)
+
+def gmcp(name: str, group: str = "", enabled: bool = True, *args, **kwargs):
+    """
+    使用装饰器创建一个GMCP触发器（GMCPTrigger）对象。
+
+    :param name: GMCP触发器的名称。
+    :param group: GMCP触发器所属的组名，默认为空字符串。
+    :param enabled: GMCP触发器是否启用，默认为 True。
+    :param args: 可变位置参数，用于传递额外的参数。
+    :param kwargs: 可变关键字参数，用于传递额外的键值对参数。
+    :return: PymudDecorator 实例，类型为 "gmcp"。
+    """
+    kwargs.update({
+        "id": name,
+        "group": group,
+        "enabled": enabled
+        })
+    
+    return PymudDecorator("gmcp", *args, **kwargs)

pymud/extras.py

@@ -310,7 +310,7 @@ class SessionBufferControl(BufferControl):
         # Focus buffer when clicked.
         cur_control = get_app().layout.current_control
         cur_buffer = get_app().layout.current_buffer
-        # 这里时修改的内容
+        # 这里是修改的内容
         if (cur_control == self) or (cur_buffer and cur_buffer.name == "input"):
             if self._last_get_processed_line:
                 processed_line = self._last_get_processed_line(position.y)

pymud/lang/i18n_chs.py

@@ -86,13 +86,17 @@ TRANSLATION = {
         "load_fail"                : "加载失败",
         "unload_ok"                : "卸载完成",
         "reload_ok"                : "重新加载完成",
+        "msg_plugin_unloaded"      : "本会话中插件 {0} 已停用。",
+        "msg_plugin_loaded"        : "本会话中插件 {0} 已启用。",
 
         # text in objects.py
         "excpetion_brace_not_matched"   : "错误的代码块，大括号数量不匹配",
         "exception_quote_not_matched"   : "引号的数量不匹配",
         "exception_forced_async"        : "该命令中同时存在强制同步命令和强制异步命令，将使用异步执行，同步命令将失效。",
         "exception_session_type_fail"   : "session 必须是 Session 类型对象的实例!",
-        "exception_in_async"            : "异步执行中遇到异常, {}",
+        "exception_message"             : "异常信息: <{}> {}",
+        "exception_traceback"           : '脚本执行异常, 异常位于文件"{}"中的第{}行的"{}"函数中。',
+        "script_error"                  : "脚本错误",
 
 
         # text display in session.py
@@ -173,7 +177,7 @@ TRANSLATION = {
 
         "msg_no_plugins"                : "PYMUD当前并未加载任何插件。",
         "msg_plugins_list"              : "PYMUD当前已加载 {0} 个插件，分别为：",
-        "msg_plugins_info"              : "{0}, 版本 {1} 作者 {2} 发布日期 {3}",
+        "msg_plugins_info"              : "作者 {2} 版本 {1} 发布日期 {3}\n  简介: {0}",
 
         "msg_py_exception"              : "Python执行错误：{0}",
 

pymud/lang/i18n_eng.py

@@ -86,13 +86,17 @@ TRANSLATION = {
         "load_fail"                : "Load failed",
         "unload_ok"                : "Unload completed",
         "reload_ok"                : "Reload completed",
+        "msg_plugin_unloaded"      : "Plugin {0} has been disabled for this session.",
+        "msg_plugin_loaded"        : "Plugin {0} has been enabled for this session.",
 
         # text in objects.py
         "excpetion_brace_not_matched"   : "Invalid code block, number of braces does not match",
         "exception_quote_not_matched"   : "Number of quotes does not match",
         "exception_forced_async"        : "This command contains both forced synchronous and asynchronous commands, will use asynchronous execution, synchronous commands will be invalid.",
         "exception_session_type_fail"   : "session must be an instance of Session type object!",
-        "exception_in_async"            : "Exception occurred during asynchronous execution, {}",
+        "exception_message"             : "Exception information: <{}> {}",
+        "exception_traceback"           : "Exception occurred at line number {1} in file '{0}', and function name is '{2}'",
+        "script_error"                  : "Script Error",
 
         # text display in session.py
         "msg_var_autoload_success"      : "Variables automatically loaded from {0} successfully.",
@@ -172,7 +176,7 @@ TRANSLATION = {
 
         "msg_no_plugins"                : "PYMUD currently has no plugins loaded.",
         "msg_plugins_list"              : "PYMUD currently has {0} plugins loaded, respectively:",
-        "msg_plugins_info"              : "{0}, version {1} author {2} release date {3}",
+        "msg_plugins_info"              : "Author {2} Version {1}  Release Date {3}\n  Description: {0}",
 
         "msg_py_exception"              : "Python execution error: {0}",
 
@@ -363,21 +367,24 @@ TRANSLATION = {
 
             "handle_test" :
         '''
-        The execution function of the embedded command #test/#show, trigger testing command. Similar to zmud's #show command.
+        The execution function of the embedded command #test/#show/#echo, trigger testing command. Similar to zmud's #show command.
         This function should not be called directly in the code.
 
         Usage:
-            - #show {some_text}: Test trigger response when server receives {some_text}. Triggers won't actually execute.
-            - #test {some_test}: Difference from #show is that matched triggers will execute regardless of enabled status.
+            - #show {some_text}: Test trigger response when receives {some_text}. Triggers won't actually execute.
+            - #test {some_text}: Difference from #show is that matched triggers will execute regardless of enabled status.
+            - #echo {some_text}: Simulate receiving {some_text} from server, triggers will execute normally but won't display test results.
 
         Examples:
             - ``#show You take a deep breath and stand up.``: Simulate trigger testing when server receives "You take a deep breath and stand up." (display test results only)
             - ``#test %copy``: Copy a sentence and simulate trigger testing when server receives the copied content again
             - ``#test You take a deep breath and stand up.``: Actual trigger execution will occur even if disabled
+            - ``#echo You take a deep breath and stand up.``: Simulate trigger testing when server receives "You take a deep breath and stand up." (won't display test results)
 
         Notes:
             - #show command only displays test results without actual trigger execution
-            - #ttest command forces actual trigger execution regardless of enabled status
+            - #test command forces actual trigger execution regardless of enabled status
+            - #echo command can be used to manually trigger triggers
         ''',
 
             "handle_timer" :

pymud/main.py

@@ -5,23 +5,28 @@ from .settings import Settings
 
 CFG_TEMPLATE = {
     "language" : "chs",                             # 语言设置，默认为简体中文
+
     "client": {
         "buffer_lines"      : 5000,                 # 保留缓冲行数
 
         "interval"          : 10,                   # 在自动执行中，两次命令输入中的间隔时间（ms）
         "auto_connect"      : True,                 # 创建会话后，是否自动连接
         "auto_reconnect"    : False,                # 在会话异常断开之后，是否自动重连
+        "reconnect_wait"    : 15,                   # 自动重连等待的时间（秒数）
         "var_autosave"      : True,                 # 断开时自动保存会话变量
         "var_autoload"      : True,                 # 初始化时自动加载会话变量
 
-        "echo_input"        : False,
         "beautify"          : True,                 # 专门为解决控制台下PKUXKX字符画对不齐的问题
+        "history_records"   : 500, 
 
+        "status_divider"    : False,                 # 是否显示状态栏的分隔线
         "status_display"    : 1,                    # 状态窗口显示情况设置，0-不显示，1-显示在下方，2-显示在右侧
         "status_height"     : 4,                    # 下侧状态栏的高度
         "status_width"      : 30,                   # 右侧状态栏的宽度
+        
 
     },
+
     "sessions" : {
         "pkuxkx" : {
             "host" : "mud.pkuxkx.net",
@@ -68,7 +73,11 @@ def init_pymud_env(args):
         
         dir = args.dir
         if dir:
-            print(f"你已经指定了创建脚本的目录为 {args.dir}")
+            if dir == ".":
+                dir_msg = "当前目录"
+            else:
+                dir_msg = f": {dir}"
+            print(f"你已经指定了创建脚本的目录为{dir_msg}")
             dir = Path(dir)
         else:
             dir = Path.home().joinpath('pkuxkx')
@@ -112,7 +121,11 @@ def init_pymud_env(args):
         print("Starting to initialize the environment for the first time...")
         dir = args.dir
         if dir:
-            print(f"You have specified the directory to create the script as {args.dir}")
+            if dir == ".":
+                dir_msg = "current directory"
+            else:
+                dir_msg = f": {dir}"
+            print(f"You have specified the directory to create the script as {dir_msg}")
             dir = Path(dir)
         else:
             dir = Path.home().joinpath('pkuxkx')
@@ -189,7 +202,7 @@ def main():
     subparsers = parser.add_subparsers(help = 'init用于初始化运行环境')
 
     par_init = subparsers.add_parser('init', description = '初始化pymud运行环境, 包括建立脚本目录, 创建默认配置文件, 创建样例脚本等.')
-    par_init.add_argument('-d', '--dir', dest = 'dir', metavar = 'dir', type = str, default = '', help = '指定构建脚本目录的名称, 不指定时会根据操作系统选择不同默认值')
+    par_init.add_argument('-d', '--dir', dest = 'dir', metavar = 'dir', type = str, default = '.', help = '指定构建脚本目录的名称, 不指定时会根据操作系统选择不同默认值')
     par_init.set_defaults(func = init_pymud_env)
 
     parser.add_argument('-d', '--debug', dest = 'debug', action = 'store_true', default = False, help = '指定以调试模式进入PyMUD。此时，系统log等级将设置为logging.NOTSET, 所有log数据均会被记录。默认不启用。')