pymud 0.20.4__tar.gz → 0.21.0__tar.gz

{pymud-0.20.4 → pymud-0.21.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pymud
-Version: 0.20.4
+Version: 0.21.0
 Summary: a MUD Client written in Python
 Author-email: "newstart@pkuxkx" <crapex@hotmail.com>
 Maintainer-email: "newstart@pkuxkx" <crapex@hotmail.com>
@@ -10,16 +10,16 @@ Project-URL: Bug Reports, https://github.com/crapex/pymud/issues
 Project-URL: Source, https://github.com/crapex/pymud/
 Project-URL: document, https://pymud.readthedocs.io/
 Keywords: MUD,multi-user dungeon,client
-Classifier: Development Status :: 5 - Production/Stable
+Classifier: Development Status :: 3 - Alpha
 Classifier: Intended Audience :: End Users/Desktop
 Classifier: Topic :: Games/Entertainment :: Multi-User Dungeons (MUD)
 Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.7
 Classifier: Programming Language :: Python :: 3.8
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
 Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.7
 Description-Content-Type: text/markdown
@@ -27,7 +27,7 @@ License-File: LICENSE.txt
 Requires-Dist: wcwidth
 Requires-Dist: pyperclip
 Requires-Dist: pygments
-Requires-Dist: prompt-toolkit
+Requires-Dist: prompt-toolkit>=3.0.51
 Dynamic: license-file
 
 # PyMUD - Python原生MUD客户端
@@ -37,12 +37,15 @@ Dynamic: license-file
 ### 源代码地址: https://github.com/crapex/pymud
 ### 帮助文档地址： https://pymud.readthedocs.org
 ### PyPi项目地址： https://pypi.org/project/pymud
-### 使用交流QQ群：554672580
+### 由deepwiki自动生成的项目理解文档地址： https://deepwiki.com/crapex/pymud
+### PyMUD用户shanghua写的入门教程文档：https://www.pkuxkx.net/forum/forum.php?mod=viewthread&tid=49999&forumuid=12067
+### 交流QQ群：554672580
 
 
 ### 北大侠客行Mud (www.pkuxkx.net)，最好的中文Mud游戏！
 ### PyMUD是我为了更好的玩北大侠客行，特意自行开发的MUD客户端。PyMUD具有以下特点：
 + 原生Python开发，除prompt-toolkit及其依赖库（wcwidth, pygment, pyperclip)外，不需要其他第三方库支持
++ 原生Python的asyncio实现的通信协议处理，支持async/await语法在脚本中直接应用，脚本实现的同步异步两种模式由你自己选择
 + 基于控制台的全屏UI界面设计，支持鼠标操作（Android上支持触摸屏操作）
 + 支持分屏显示，在数据快速滚动的时候，上半屏保持不动，以确保不错过信息
 + 解决了99%情况下，北大侠客行中文对不齐，也就是看不清字符画的问题（因为我没有走遍所有地方，不敢保证100%）
@@ -63,6 +66,116 @@ Dynamic: license-file
 
 ## 版本更新信息
 
+### 0.21.0 开发中，最新更新2025-05-18
+
++ 功能新增: 各类对象的group属性，新增组、子组概念，用于快速成组操作对象。组可以包括子组，子组可以再包括子组。
+  组名以点号.分隔，例如：group1.subgroup1.subsubgroup1。组的层级没有限制。
+  组的概念可以用于快速处理多个对象，例如启用/禁用一组对象、删除一组对象等。例如，以下几个组的关系：
+  - mygroup1
+  - mygroup1.subgroup1                # 属于 mygroup1的子组
+  - mygroup1.subgroup2                # 属于 mygroup1的子组
+  - mygroup1.subgroup2.subsubgroup1   # 属于 mygroup1.subgroup2的子组，也同样属于更高层级mygroup1的子组
+  - mygroup2
+  - mygroup2.subgroup1                # 属于 mygroup2的子组
+
++ 功能新增: 新增了deleteGroup函数，用于删除指定的对象组。可同时指定组名、是否包含子组名、有效类型范围。函数定义和示例代码如下：
+
+``` Python
+    def deleteGroup(self, group: str, subgroup = True, types: Union[Type, Union[Tuple, List]] = (Alias, Trigger, Command, Timer, GMCPTrigger)):
+        pass
+    # 各参数含义:
+    # group: 要删除的组名，可以是完整的组名，也可以是部分组名。例如："group1" 或 "group1.subgroup1" 等。
+    # subgroup: 是否包含子组。如果为True，则删除指定组及其所有子组的对象。如果为False，则仅删除指定组的对象，不包括子组。
+    # types: 要删除的对象类型范围。可以是单个类型，也可以是类型的元组或列表。例如：Trigger, Alias, Command, Timer, GMCPTrigger 等。
+    # 示例代码：
+    # 删除所有属于group1的Trigger和Alias对象，包括子组如 group1.subgroup1 和 group1.subgroup2 等
+    self.session.deleteGroup("group1", True, [Trigger, Alias])
+    # 删除所有属于group1的Trigger对象，但不包括子组
+    self.session.deleteGroup("group1", False, [Trigger])
+```
+
++ 功能新增: 对 #trigger, #alias, #timer, #gmcp, #command, #t+, #t- 等命令新增了组处理选项，用于对整组对象进行处理。各命令的语法格式类似。
+  处理组时，组名应以大于号>或者等于号=开头，紧跟组名（无空格）。当使用>时，表示操作针对当前组及所有所属子组，当使用=时，表示操作仅针对当前组。
+  例如下面代码：
+
+    ```
+        #t+ >group1 表示启用所有属于group1以及其子组的所有可管理对象，包括Trigger、Alias、Command、Timer、GMCPTrigger
+        #t- =group1.subgroup1 表示禁用所有仅属于group1.subgroup1的Trigger、Alias、Command、Timer、GMCPTrigger等对象
+        #tri >group1 off 表示禁用所有属于group1以及其子组的Trigger对象
+        #ali =group1.subgroup1 on 表示启用所有仅属于group1.subgroup1的Alias对象
+    ```
+
++ 功能新增: 调整了enableGroup处理，可以通过组名支持子组操作，也可以指定有效类型范围。例如下面代码：
+    ``` Python
+        class MyTestConfig(IConfig):
+            def __init__(self, session, *args, **kwargs):
+                self._objs = [
+                    Trigger(session, "tri1", group = "group1"),
+                    Trigger(session, "tri2", group = "group1.subgroup1"),
+                    Trigger(session, "tri3", group = "group1.subgroup2"),
+                    Alias(session, "alias1", group = "group1"),
+                    Alias(session, "alias2", group = "group1.subgroup1"),
+                    Timer(session, 5, group = "group1.subgroup1")
+                ]
+        
+                #以下调用可以同时禁用上述6个对象，因为 group1.subgroup1 和 group1.subgroup2 都属于 group1 的子组
+                session.enableGroup("group1", False)
+                #以下调用可以同时仅启用触发器tri1和别名alias1，因为通过subgroup参数限定了不传递到子组
+                session.enableGroup("group1", True, subgroup = False)
+                # 以下调用可以同时禁用对应发器和别名，但不禁用定时器，因为通过types参数指定了有效范围：
+                session.enableGroup("group1.subgroup1", False, types = [Trigger, Alias])
+
+    ```
+
++ 功能新增: 增加了多处异常追踪提示。在模块或插件的脚本中发生错误时，均会打印错误追踪信息，方便定位错误。
++ 功能新增: 新增 #echo 命令，类似于 #test 命令，但该命令只会模拟收到服务器数据，直接激发各匹配触发器，但不显示触发测试结果。
++ 功能新增: #load / #unload 现在支持当前会话对插件的临时启用和禁用，实现方式为调用插件里的PLUGIN_SESSION_CREATE和PLUGIN_SESSION_DESTROYE函数。群文件的moving.py插件写法可以支持。
++ 功能调整: 各会话变量保存的.mud文件，统一移到save子目录下。原来当前目录下的.mud文件，在对应会话重新加载时会自动移动，无需人工处理。
++ 功能新增: 增加了国际化(i18n)支持，原生开发语言为中文简体，目前使用AI翻译生成了英文。应用语言通过Settings中新增的language配置来控制，默认为"chs"，可以在pymud.cfg中覆盖该配置。其值目前可以为"chs"、"eng"。自行翻译的语言可以在pymud/lang目录下下新增语言文件，文件名为i18n_加语言代码，例如"i18n_chs.py"表示可以使用"chs"语言，其中使用Python字典方式定义了所有需动态显示的文本内容。
++ 功能新增: 新增了使用元类型及装饰器来管理Pymud对象，包括Alias, Trigger, Timer, GMCPTrigger四种可以使用对应的装饰器，@alias, @trigger, @timer, @gmcp来直接在标记函数上创建。可以参考本版本中的pkuxkx.py文件写法和注意事项。
++ 功能新增: 新增了两个装饰器，@exception和@async_exception，用于捕获异常并调用session.error进行显示。@exception用于捕获同步异常，@async_exception用于捕获异步异常。参考如下：
+``` Python
+    from pymud import Command, Trigger, IConfig, exception, async_exception
+
+    class MyCustomCommand(Command, IConfig):
+        @exception
+        def a_sync_routine(self, args: list[str]):
+            # 这里的代码抛出的异常会被self.session.error捕获并显示
+            something_that_may_raise_an_exception()
+
+        @async_exception
+        async def execute(self, args: list[str]):
+            # 这里的代码抛出的异常会被self.session.error捕获并显示
+            await something_that_may_raise_another_exception()
+
+    # 上述代码相当于以下代码
+    class MyCustomCommand(Command, IConfig):
+        def a_sync_routine(self, args: list[str]):
+            try:
+                something_that_may_raise_an_exception()
+            except Exception as e:
+                self.session.error(error_msg_of_e)
+
+        async def execute(self, args: list[str]):
+            try:
+                await something_that_may_raise_another_exception()
+            except Exception as e:
+                self.session.error(error_msg_of_e)
+```
++ 问题修复: 修复了Alias和Command执行时的优先级判断。之前未进行优先级判断，因此遇到能同时匹配的多个时，不一定优先级高的被触发。现在对Alias和Command进行了优先级判断，优先级高的先触发。
++ 问题修复: 修复Alias中的keepEval参数和oneShot参数。keepEval参数支持多个匹配成功的别名同时生效，oneShot参数支持一个匹配成功的别名生效后，后续的匹配不再生效。
++ 问题修复: 修复Command中的keepEval参数。以往同时匹配生效的Command会覆盖后续Command和Alias，当前会持续匹配。
++ 功能增强: 对几乎所有函数的参数进行了类型标注，增加了类型检查，提高了代码的可读性和可维护性，也便于自行编写脚本时的提示。
++ 功能增强: 为Session类型增加了commandHistory属性，用于查询发送到服务器的命令历史。保存的命令历史的数量由pymud.cfg中的client["history_records"]控制，默认为500。当该值为0时，不会保存命令历史。为-1时，会保存所有命令历史。
++ 功能调整: #help命令时，增加了上下两行分隔符显示，以便明显区分帮助输出和游戏输出。
++ 功能增强: 当前pymud界面中显示的版本号会自动从pyproject.toml中读取，以确保版本号的准确性和唯一性。
++ 问题修复: 修复了代码中的部分编码错误。新版Python中能容忍一些错误，但老版本不行。经修复，当前代码支持的Python版本已测试3.8确保可用，3.7版理论可用，但未经测试。建议使用3.10或更高版本的Python。
++ 问题修复: 删除了extras.py中多余的MenuItem类型定义，该定义与prompt_toolkit中的MenuItem定义冲突。
++ 问题修复: 调整了众多代码中未检查对象是否为None即调用、使用的局部变量可能未经过初始化和赋值路径等的情况，保证程序运行的健壮性。
++ 问题修复: 修复了#test命令的帮助内容错误。实际#show命令不触发脚本，仅测试；而#test会触发脚本。
++ 问题修复: 修复了协议处理中MSDP编码解码处理错误的问题；修复了协议处理中默认encoding不传递导致某些情况下报解码错误的问题。
++ 示例更新: 更新了包中自带的pkuxkx.py，增加了@alias, @trigger, @timer, @gmcp的示例以及状态窗口的示例。
+
 ### 0.20.4 (2025-03-30)
 + 功能调整: 为插件功能新增了 PLUGIN_PYMUD_DESTROY 方法，用于在插件被卸载时，进行一些清理工作。
 + 功能调整: 将插件的 PLUGIN_PYMUD_START 方法的调用，从插件加载时刻移动到事件循环启动之后，这样在加载时，可以使用 asyncio.create_task或 asyncio.ensure_future 来执行一些异步操作

{pymud-0.20.4 → pymud-0.21.0}/README.md

@@ -5,12 +5,15 @@
 ### 源代码地址: https://github.com/crapex/pymud
 ### 帮助文档地址： https://pymud.readthedocs.org
 ### PyPi项目地址： https://pypi.org/project/pymud
-### 使用交流QQ群：554672580
+### 由deepwiki自动生成的项目理解文档地址： https://deepwiki.com/crapex/pymud
+### PyMUD用户shanghua写的入门教程文档：https://www.pkuxkx.net/forum/forum.php?mod=viewthread&tid=49999&forumuid=12067
+### 交流QQ群：554672580
 
 
 ### 北大侠客行Mud (www.pkuxkx.net)，最好的中文Mud游戏！
 ### PyMUD是我为了更好的玩北大侠客行，特意自行开发的MUD客户端。PyMUD具有以下特点：
 + 原生Python开发，除prompt-toolkit及其依赖库（wcwidth, pygment, pyperclip)外，不需要其他第三方库支持
++ 原生Python的asyncio实现的通信协议处理，支持async/await语法在脚本中直接应用，脚本实现的同步异步两种模式由你自己选择
 + 基于控制台的全屏UI界面设计，支持鼠标操作（Android上支持触摸屏操作）
 + 支持分屏显示，在数据快速滚动的时候，上半屏保持不动，以确保不错过信息
 + 解决了99%情况下，北大侠客行中文对不齐，也就是看不清字符画的问题（因为我没有走遍所有地方，不敢保证100%）
@@ -31,6 +34,116 @@
 
 ## 版本更新信息
 
+### 0.21.0 开发中，最新更新2025-05-18
+
++ 功能新增: 各类对象的group属性，新增组、子组概念，用于快速成组操作对象。组可以包括子组，子组可以再包括子组。
+  组名以点号.分隔，例如：group1.subgroup1.subsubgroup1。组的层级没有限制。
+  组的概念可以用于快速处理多个对象，例如启用/禁用一组对象、删除一组对象等。例如，以下几个组的关系：
+  - mygroup1
+  - mygroup1.subgroup1                # 属于 mygroup1的子组
+  - mygroup1.subgroup2                # 属于 mygroup1的子组
+  - mygroup1.subgroup2.subsubgroup1   # 属于 mygroup1.subgroup2的子组，也同样属于更高层级mygroup1的子组
+  - mygroup2
+  - mygroup2.subgroup1                # 属于 mygroup2的子组
+
++ 功能新增: 新增了deleteGroup函数，用于删除指定的对象组。可同时指定组名、是否包含子组名、有效类型范围。函数定义和示例代码如下：
+
+``` Python
+    def deleteGroup(self, group: str, subgroup = True, types: Union[Type, Union[Tuple, List]] = (Alias, Trigger, Command, Timer, GMCPTrigger)):
+        pass
+    # 各参数含义:
+    # group: 要删除的组名，可以是完整的组名，也可以是部分组名。例如："group1" 或 "group1.subgroup1" 等。
+    # subgroup: 是否包含子组。如果为True，则删除指定组及其所有子组的对象。如果为False，则仅删除指定组的对象，不包括子组。
+    # types: 要删除的对象类型范围。可以是单个类型，也可以是类型的元组或列表。例如：Trigger, Alias, Command, Timer, GMCPTrigger 等。
+    # 示例代码：
+    # 删除所有属于group1的Trigger和Alias对象，包括子组如 group1.subgroup1 和 group1.subgroup2 等
+    self.session.deleteGroup("group1", True, [Trigger, Alias])
+    # 删除所有属于group1的Trigger对象，但不包括子组
+    self.session.deleteGroup("group1", False, [Trigger])
+```
+
++ 功能新增: 对 #trigger, #alias, #timer, #gmcp, #command, #t+, #t- 等命令新增了组处理选项，用于对整组对象进行处理。各命令的语法格式类似。
+  处理组时，组名应以大于号>或者等于号=开头，紧跟组名（无空格）。当使用>时，表示操作针对当前组及所有所属子组，当使用=时，表示操作仅针对当前组。
+  例如下面代码：
+
+    ```
+        #t+ >group1 表示启用所有属于group1以及其子组的所有可管理对象，包括Trigger、Alias、Command、Timer、GMCPTrigger
+        #t- =group1.subgroup1 表示禁用所有仅属于group1.subgroup1的Trigger、Alias、Command、Timer、GMCPTrigger等对象
+        #tri >group1 off 表示禁用所有属于group1以及其子组的Trigger对象
+        #ali =group1.subgroup1 on 表示启用所有仅属于group1.subgroup1的Alias对象
+    ```
+
++ 功能新增: 调整了enableGroup处理，可以通过组名支持子组操作，也可以指定有效类型范围。例如下面代码：
+    ``` Python
+        class MyTestConfig(IConfig):
+            def __init__(self, session, *args, **kwargs):
+                self._objs = [
+                    Trigger(session, "tri1", group = "group1"),
+                    Trigger(session, "tri2", group = "group1.subgroup1"),
+                    Trigger(session, "tri3", group = "group1.subgroup2"),
+                    Alias(session, "alias1", group = "group1"),
+                    Alias(session, "alias2", group = "group1.subgroup1"),
+                    Timer(session, 5, group = "group1.subgroup1")
+                ]
+        
+                #以下调用可以同时禁用上述6个对象，因为 group1.subgroup1 和 group1.subgroup2 都属于 group1 的子组
+                session.enableGroup("group1", False)
+                #以下调用可以同时仅启用触发器tri1和别名alias1，因为通过subgroup参数限定了不传递到子组
+                session.enableGroup("group1", True, subgroup = False)
+                # 以下调用可以同时禁用对应发器和别名，但不禁用定时器，因为通过types参数指定了有效范围：
+                session.enableGroup("group1.subgroup1", False, types = [Trigger, Alias])
+
+    ```
+
++ 功能新增: 增加了多处异常追踪提示。在模块或插件的脚本中发生错误时，均会打印错误追踪信息，方便定位错误。
++ 功能新增: 新增 #echo 命令，类似于 #test 命令，但该命令只会模拟收到服务器数据，直接激发各匹配触发器，但不显示触发测试结果。
++ 功能新增: #load / #unload 现在支持当前会话对插件的临时启用和禁用，实现方式为调用插件里的PLUGIN_SESSION_CREATE和PLUGIN_SESSION_DESTROYE函数。群文件的moving.py插件写法可以支持。
++ 功能调整: 各会话变量保存的.mud文件，统一移到save子目录下。原来当前目录下的.mud文件，在对应会话重新加载时会自动移动，无需人工处理。
++ 功能新增: 增加了国际化(i18n)支持，原生开发语言为中文简体，目前使用AI翻译生成了英文。应用语言通过Settings中新增的language配置来控制，默认为"chs"，可以在pymud.cfg中覆盖该配置。其值目前可以为"chs"、"eng"。自行翻译的语言可以在pymud/lang目录下下新增语言文件，文件名为i18n_加语言代码，例如"i18n_chs.py"表示可以使用"chs"语言，其中使用Python字典方式定义了所有需动态显示的文本内容。
++ 功能新增: 新增了使用元类型及装饰器来管理Pymud对象，包括Alias, Trigger, Timer, GMCPTrigger四种可以使用对应的装饰器，@alias, @trigger, @timer, @gmcp来直接在标记函数上创建。可以参考本版本中的pkuxkx.py文件写法和注意事项。
++ 功能新增: 新增了两个装饰器，@exception和@async_exception，用于捕获异常并调用session.error进行显示。@exception用于捕获同步异常，@async_exception用于捕获异步异常。参考如下：
+``` Python
+    from pymud import Command, Trigger, IConfig, exception, async_exception
+
+    class MyCustomCommand(Command, IConfig):
+        @exception
+        def a_sync_routine(self, args: list[str]):
+            # 这里的代码抛出的异常会被self.session.error捕获并显示
+            something_that_may_raise_an_exception()
+
+        @async_exception
+        async def execute(self, args: list[str]):
+            # 这里的代码抛出的异常会被self.session.error捕获并显示
+            await something_that_may_raise_another_exception()
+
+    # 上述代码相当于以下代码
+    class MyCustomCommand(Command, IConfig):
+        def a_sync_routine(self, args: list[str]):
+            try:
+                something_that_may_raise_an_exception()
+            except Exception as e:
+                self.session.error(error_msg_of_e)
+
+        async def execute(self, args: list[str]):
+            try:
+                await something_that_may_raise_another_exception()
+            except Exception as e:
+                self.session.error(error_msg_of_e)
+```
++ 问题修复: 修复了Alias和Command执行时的优先级判断。之前未进行优先级判断，因此遇到能同时匹配的多个时，不一定优先级高的被触发。现在对Alias和Command进行了优先级判断，优先级高的先触发。
++ 问题修复: 修复Alias中的keepEval参数和oneShot参数。keepEval参数支持多个匹配成功的别名同时生效，oneShot参数支持一个匹配成功的别名生效后，后续的匹配不再生效。
++ 问题修复: 修复Command中的keepEval参数。以往同时匹配生效的Command会覆盖后续Command和Alias，当前会持续匹配。
++ 功能增强: 对几乎所有函数的参数进行了类型标注，增加了类型检查，提高了代码的可读性和可维护性，也便于自行编写脚本时的提示。
++ 功能增强: 为Session类型增加了commandHistory属性，用于查询发送到服务器的命令历史。保存的命令历史的数量由pymud.cfg中的client["history_records"]控制，默认为500。当该值为0时，不会保存命令历史。为-1时，会保存所有命令历史。
++ 功能调整: #help命令时，增加了上下两行分隔符显示，以便明显区分帮助输出和游戏输出。
++ 功能增强: 当前pymud界面中显示的版本号会自动从pyproject.toml中读取，以确保版本号的准确性和唯一性。
++ 问题修复: 修复了代码中的部分编码错误。新版Python中能容忍一些错误，但老版本不行。经修复，当前代码支持的Python版本已测试3.8确保可用，3.7版理论可用，但未经测试。建议使用3.10或更高版本的Python。
++ 问题修复: 删除了extras.py中多余的MenuItem类型定义，该定义与prompt_toolkit中的MenuItem定义冲突。
++ 问题修复: 调整了众多代码中未检查对象是否为None即调用、使用的局部变量可能未经过初始化和赋值路径等的情况，保证程序运行的健壮性。
++ 问题修复: 修复了#test命令的帮助内容错误。实际#show命令不触发脚本，仅测试；而#test会触发脚本。
++ 问题修复: 修复了协议处理中MSDP编码解码处理错误的问题；修复了协议处理中默认encoding不传递导致某些情况下报解码错误的问题。
++ 示例更新: 更新了包中自带的pkuxkx.py，增加了@alias, @trigger, @timer, @gmcp的示例以及状态窗口的示例。
+
 ### 0.20.4 (2025-03-30)
 + 功能调整: 为插件功能新增了 PLUGIN_PYMUD_DESTROY 方法，用于在插件被卸载时，进行一些清理工作。
 + 功能调整: 将插件的 PLUGIN_PYMUD_START 方法的调用，从插件加载时刻移动到事件循环启动之后，这样在加载时，可以使用 asyncio.create_task或 asyncio.ensure_future 来执行一些异步操作

{pymud-0.20.4 → pymud-0.21.0}/pyproject.toml

@@ -1,7 +1,7 @@
 [project]
 
 name = "pymud"  # Required
-version = "0.20.4"  # Required
+version = "0.21.0"  # Required
 description = "a MUD Client written in Python"  # Optional
 readme = "README.md" # Optional
 requires-python = ">=3.7"
@@ -22,23 +22,26 @@ classifiers = [  # Optional
   #   3 - Alpha
   #   4 - Beta
   #   5 - Production/Stable
-  "Development Status :: 5 - Production/Stable",
-  # "Development Status :: 3 - Alpha",
+  #"Development Status :: 5 - Production/Stable",
+  "Development Status :: 3 - Alpha",
   "Intended Audience :: End Users/Desktop",
   "Topic :: Games/Entertainment :: Multi-User Dungeons (MUD)",
   # "License :: OSI Approved :: GNU General Public License v3 (GPLv3)",
   "Programming Language :: Python :: 3",
-  "Programming Language :: Python :: 3.7",
   "Programming Language :: Python :: 3.8",
   "Programming Language :: Python :: 3.9",
   "Programming Language :: Python :: 3.10",
   "Programming Language :: Python :: 3.11",
   "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
   "Programming Language :: Python :: 3 :: Only",
 ]
 
-dependencies = [ 
-  "wcwidth", "pyperclip", "pygments", "prompt-toolkit"
+dependencies = [
+  "wcwidth",
+  "pyperclip",
+  "pygments",
+  "prompt-toolkit>=3.0.51",
 ]
 
 [project.urls]  # Optional

pymud-0.21.0/src/pymud/__init__.py

@@ -0,0 +1,17 @@
+from .settings import Settings
+from .pymud import PyMudApp
+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
+from .logger import Logger
+from .main import main
+from .decorators import exception, async_exception, PymudDecorator, alias, trigger, timer, gmcp
+
+__all__ = [
+    "PymudMeta", "IConfigBase", "IConfig", "PyMudApp", "Settings", "CodeBlock", 
+    "Alias", "SimpleAlias", "Trigger", "SimpleTrigger", 
+    "Command", "SimpleCommand", "Timer", "SimpleTimer", 
+    "GMCPTrigger", "Session", "DotDict", "Logger", "main",
+    "exception", "async_exception", "PymudDecorator", "alias", "trigger", "timer", "gmcp",
+]

pymud-0.21.0/src/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)