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

pymud/__init__.py

@@ -1,5 +1,6 @@
 from .settings import Settings
 from .pymud import PyMudApp
+from .modules import IConfig
 from .objects import CodeBlock, Alias, SimpleAlias, Trigger, SimpleTrigger, Command, SimpleCommand, Timer, SimpleTimer, GMCPTrigger
 from .extras import DotDict
 from .session import Session
@@ -7,5 +8,5 @@ from .logger import Logger
 from .main import main
 
 __all__ = [
-    "PyMudApp", "Settings", "CodeBlock", "Alias", "SimpleAlias", "Trigger", "SimpleTrigger", "Command", "SimpleCommand", "Timer", "SimpleTimer", "GMCPTrigger", "Session", "PyMudApp", "DotDict", "Logger", "main"
+    "IConfig", "PyMudApp", "Settings", "CodeBlock", "Alias", "SimpleAlias", "Trigger", "SimpleTrigger", "Command", "SimpleCommand", "Timer", "SimpleTimer", "GMCPTrigger", "Session", "PyMudApp", "DotDict", "Logger", "main"
 ]

pymud/modules.py

@@ -0,0 +1,80 @@
+
+import importlib
+from abc import ABC, ABCMeta
+
+class ModuleInfo:
+    def __init__(self, module_name: str, session):
+        self.session = session
+        self._name = module_name 
+        self.load()
+       
+    def _load(self, reload = False):
+        result = True
+        if reload:
+            self._module = importlib.reload(self._module)
+        else:
+            self._module = importlib.import_module(self.name)
+        self._config = {}
+        for attr_name in dir(self._module):
+            attr = getattr(self._module, attr_name)
+            if isinstance(attr, type) and attr.__module__ == self._module.__name__:
+                if (attr_name == "Configuration") or issubclass(attr, IConfig):
+                    try:
+                        self._config[f"{self.name}.{attr_name}"] = attr(self.session)
+                        self.session.info(f"配置对象 {self.name}.{attr_name} 创建成功.")
+                    except Exception as e:
+                        result = False
+                        self.session.error(f"配置对象 {self.name}.{attr_name} 创建失败. 错误信息为: {e}")
+
+        return result
+    
+    def _unload(self):
+        for key, config in self._config.items():
+            if hasattr(config, "__unload__"):
+                unload = getattr(config, "__unload__", None)
+                if callable(unload): unload()
+                
+            if hasattr(config, "unload"):
+                unload = getattr(config, "unload", None)
+                if callable(unload): unload()
+
+            del config
+        self._config.clear()
+
+    def load(self):
+        if self._load():
+            self.session.info(f"{'主' if self.ismainmodule else '从'}配置模块 {self.name} 加载完成.")
+        else:
+            self.session.error(f"{'主' if self.ismainmodule else '从'}配置模块 {self.name} 加载失败.")
+
+    def unload(self):
+        self._unload()
+        self.session.info(f"{'主' if self.ismainmodule else '从'}配置模块 {self.name} 卸载完成.")
+
+    def reload(self):
+        self._unload()
+        self._load(reload = True)
+        self.session.info(f"{'主' if self.ismainmodule else '从'}配置模块 {self.name} 重新加载完成.")
+
+    @property
+    def name(self):
+        return self._name
+
+    @property
+    def module(self):
+        return self._module
+    
+    @property
+    def config(self):
+        return self._config
+    
+    @property
+    def ismainmodule(self):
+        return self._config != {}
+
+class IConfig(metaclass = ABCMeta):
+    def __init__(self, session, *args, **kwargs):
+        self.session = session
+
+    def __unload__(self):
+        self.session.delObject(self)

pymud/objects.py

@@ -2,7 +2,8 @@
 MUD会话(session)中, 支持的对象列表
 """
 
-import asyncio, logging, re
+import asyncio, logging, re, importlib
+from abc import ABC, ABCMeta, abstractmethod
 from collections.abc import Iterable
 from collections import namedtuple
 from typing import Any
@@ -342,6 +343,8 @@ class BaseObject:
 
         self.log.debug(f"对象实例 {self} 创建成功.")
 
+        self.session.addObject(self)
+
     @property
     def enabled(self):
         "可读写属性，使能或取消使能本对象"
@@ -477,7 +480,7 @@ class MatchObject(BaseObject):
         super().__init__(session, patterns = patterns, *args, **kwargs)
 
     def __del__(self):
-        self.reset()
+        pass
 
     @property
     def patterns(self):

pymud/session.py

@@ -8,6 +8,7 @@ from logging.handlers import QueueHandler, QueueListener
 from .logger import Logger
 from .extras import SessionBuffer, DotDict, Plugin
 from .protocol import MudClientProtocol
+from .modules import ModuleInfo
 from .objects import BaseObject, Trigger, Alias, Command, Timer, SimpleAlias, SimpleTrigger, SimpleTimer, GMCPTrigger, CodeBlock, CodeLine
 from .settings import Settings
 
@@ -256,11 +257,6 @@ class Session:
         if self.connected:
             self.write_eof()
 
-            # 两次保存，删掉一次
-            # # 断开时自动保存变量数据
-            # if Settings.client["var_autosave"]:
-            #     self.handle_save()
-
     def onDisconnected(self, protocol):
         "当从服务器连接断开时执行的操作。包括保存变量(若设置)、打印断开时间、执行自定义事件(若设置)等。"
         # 断开时自动保存变量数据
@@ -808,7 +804,7 @@ class Session:
         return await awaitable
 
     def exec(self, cmd: str, name = None, *args, **kwargs):
-        """
+        r"""
         在名称为name的会话中使用exec_command执行MUD命令。当不指定name时，在当前会话中执行。
 
         - exec 与 writeline 都会向服务器写入数据。其差异在于，exec执行的内容，会先经过Alias处理和Command处理，实际向远程发送内容与cmd可以不一致。
@@ -2151,7 +2147,7 @@ class Session:
                             self.info("创建Timer {} 成功: {}".format(ti.id, ti.__repr__()))
 
     def handle_alias(self, code: CodeLine = None, *args, **kwargs):
-        """
+        r"""
         嵌入命令 #alias / #ali 的执行函数，操作别名。该命令可以不带参数、带一个参数或者两个参数。
         该函数不应该在代码中直接调用。
 
@@ -2541,6 +2537,7 @@ class Session:
         self._variables.clear()
         self._tasks.clear()
 
+
     def load_module(self, module_names):
         """
         模块加载函数。
@@ -2564,33 +2561,12 @@ class Session:
         "加载指定名称模块"
         try:
             if module_name not in self._modules.keys():
-                mod = importlib.import_module(module_name)
-                if hasattr(mod, 'Configuration'):
-                    config = mod.Configuration(self)
-                    self._modules[module_name] = {"module": mod, "config": config}
-                    self.info(f"主配置模块 {module_name} 加载完成.")
-                else:
-                    self._modules[module_name] = {"module": mod, "config": None}
-                    self.info(f"子配置模块 {module_name} 加载完成.")
+                self._modules[module_name] = ModuleInfo(module_name, self)
 
             else:
-                mod = self._modules[module_name]["module"]
-                config = self._modules[module_name]["config"]
-                if config: 
-                    if hasattr(config, "__unload__") or hasattr(config, "unload"):
-                        unload = getattr(config, "__unload__", None) or getattr(config, "unload", None)
-                        if callable(unload):
-                            unload()
-
-                    del config
-                mod = importlib.reload(mod)
-                if hasattr(mod, 'Configuration'):
-                    config = mod.Configuration(self)
-                    self._modules[module_name] = {"module": mod, "config": config}
-                    self.info(f"主配置模块 {module_name} 重新加载完成.")
-                else:
-                    self._modules[module_name] = {"module": mod, "config": None}
-                    self.info(f"子配置模块 {module_name} 重新加载完成.")
+                mod = self._modules[module_name]
+                if isinstance(mod, ModuleInfo):
+                    mod.reload()
 
         except Exception as e:
             import traceback
@@ -2618,18 +2594,9 @@ class Session:
     def _unload_module(self, module_name):
         "卸载指定名称模块。卸载支持需要模块的Configuration实现 __unload__ 或 unload 方法"
         if module_name in self._modules.keys():
-            mod = self._modules[module_name]["module"]
-            config = self._modules[module_name]["config"]
-            if config: 
-                if hasattr(config, "__unload__") or hasattr(config, "unload"):
-                    unload = getattr(config, "__unload__", None) or getattr(config, "unload", None)
-                    if callable(unload):
-                        unload()
-
-                del config
-            del mod
-            self._modules.pop(module_name)
-            self.info(f"配置模块 {module_name} 已成功卸载.")
+            mod = self._modules.pop(module_name)
+            if isinstance(mod, ModuleInfo):
+                mod.unload()
 
         else:
             self.warning(f"指定模块名称 {module_name} 并未加载.")
@@ -2643,9 +2610,9 @@ class Session:
         :param module_names: 要重新加载的模块清单。为元组/列表时，卸载指定名称的系列模块，当名称为字符串时，卸载单个模块。当不指定时，重新加载所有已加载模块。
         """
         if module_names is None:
-            self.clean()
-            mods = list(self._modules.keys())
-            self.load_module(mods)
+            for name, module in self._modules.items():
+                if isinstance(module, ModuleInfo):
+                    module.reload()
 
             self.info(f"所有配置模块全部重新加载完成.")
 
@@ -2653,14 +2620,17 @@ class Session:
             for mod in module_names:
                 mod = mod.strip()
                 if mod in self._modules.keys():
-                    self.load_module(mod)
+                    module = self._modules[mod]
+                    if isinstance(module, ModuleInfo):
+                        module.reload()
                 else:
                     self.warning(f"指定模块名称 {mod} 并未加载，无法重新加载.")
 
         elif isinstance(module_names, str):
             if module_names in self._modules.keys():
-                mod = module_names.strip()
-                self.load_module(mod)
+                module = self._modules[module_names]
+                if isinstance(module, ModuleInfo):
+                    module.reload()
             else:
                 self.warning(f"指定模块名称 {module_names} 并未加载，无法重新加载.")
         
@@ -2798,12 +2768,29 @@ class Session:
             - #reload
         '''
 
-        count = len(self._modules.keys())
-        if count == 0:
-            self.info("当前会话并未加载任何模块。", "MODULES")
-        else:
-            self.info(f"当前会话已加载 {count} 个模块，包括（按加载顺序排列）：{list(self._modules.keys())}", "MODULES")
+        args = code.code[2:]
+        
+        if len(args) == 0:
+            count = len(self._modules.keys())
+            if count == 0:
+                self.info("当前会话并未加载任何模块。", "MODULES")
+            else:
+                self.info(f"当前会话已加载 {count} 个模块，包括（按加载顺序排列）：{list(self._modules.keys())}", "MODULES")
     
+        elif len(args) >= 1:
+            modules = ",".join(args).split(",")
+            for mod in modules:
+                if mod in self._modules.keys():
+                    module = self._modules[mod]
+                    if isinstance(module, ModuleInfo):
+                        if module.ismainmodule:
+                            self.info(f"模块 {module.name} 中包含的配置包括: {', '.join(module.config.keys())}")
+                        else:
+                            self.info(f"模块 {module.name} 为子模块，不包含配置。")
+
+                else:
+                    self.info(f"本会话中不存在指定名称 {mod} 的模块，可能是尚未加载到本会话中")
+
     def handle_reset(self, code: CodeLine = None, *args, **kwargs):
         '''
         嵌入命令 #reset 的执行函数，复位全部脚本。该命令不带参数。
@@ -2823,7 +2810,8 @@ class Session:
 
     def handle_save(self, code: CodeLine = None, *args, **kwargs):
         '''
-        嵌入命令 #save 的执行函数，保存当前会话变量（系统变量除外）至文件。该命令不带参数。
+        嵌入命令 #save 的执行函数，保存当前会话变量（系统变量和临时变量除外）至文件。该命令不带参数。
+        系统变量包括 %line, %copy 和 %raw 三个，临时变量是指变量名已下划线开头的变量
         该函数不应该在代码中直接调用。
 
         使用:
@@ -2844,10 +2832,10 @@ class Session:
         with open(file, "wb") as fp:
             saved = dict()
             saved.update(self._variables)
-            # keys = list(saved.keys())
-            # for key in keys:
-            #     if key.startswith("%"):
-            #         saved.pop(key)
+            keys = list(saved.keys())
+            for key in keys:
+                if key.startswith("_"):
+                    saved.pop(key)
             saved.pop("%line", None)
             saved.pop("%raw", None)
             saved.pop("%copy", None)

{pymud-0.20.0a4.dist-info → pymud-0.20.0a5.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymud
-Version: 0.20.0a4
+Version: 0.20.0a5
 Summary: a MUD Client written in Python
 Author-email: "newstart@pkuxkx" <crapex@crapex.cc>
 Maintainer-email: "newstart@pkuxkx" <crapex@crapex.cc>
@@ -743,10 +743,12 @@ Requires-Dist: prompt-toolkit
 + 功能调整: 在没有session的时候，也可以执行#exit命令
 + 功能新增: #session 命令增加快捷创建会话功能，假如已有快捷菜单 世界->pkuxkx->newstart , 则可以通过 #session pkuxkx.newstart 直接创建该会话，效果等同于点击该菜单
 + 功能调整: 点击菜单创建会话时，若会话已存在，则将该会话切换为当前会话
-+ 问题修复: 修复原unload方法不能正确卸载的问题
-+ 功能新增: 主模块卸载现在既可以定义在__unload__方法中，也可以定义在unload方法中。可以根据自己喜好选择一个即可。
-+ 功能调整: 模块加载和重新加载前，会自动调用模块的__unload__方法或unload方法（若有）
++ 重大更新: 完全重写了模块的加载、卸载、重新加载方法，修复模块使用中的问题
++ 功能调整: 现在只要将一个类型继承 IConfig 接口，即被识别为配置类型。这种类型在模块加载时会自动创建其实例。当然，名称为Configuration的类型也同样被认为是配置类型，保持向前兼容性。唯一要求是，该类型的构造函数允许仅传递一个session对象。
++ 功能新增: 各类配置类型的卸载现在既可以定义在__unload__方法中，也可以定义在unload方法中。可以根据自己喜好选择一个即可。
++ 功能调整: 各配置类型加载和重新加载前，会自动调用模块的__unload__方法或unload方法（若有）
 + 功能新增: Command基类增加__unload__方法和unload方法，二者在从会话中移除该 Command 时均会自动调用。自定义的Command子类应覆盖这两种方法中的一种方法，并在其中增加清除类型自行创建的 Trigger, Alias 等会话对象。这样，模块卸载时只要移除命令本身，在命令中新建的其他关联对象将被一同移除。
++ 功能新增: 所有PyMUD基础对象类型及其子类型，包括 Alias, Trigger, Timer, Command, GMCPTrigger 及它们的子类型，在创建的时候会自动添加到会话中，无需再进行 addObject 等操作了
 + 问题修复: 修复部分正则表达式书写错误问题
 + 功能新增: Session类新增waitfor函数，用于执行一段代码后立即等待某个触发器的情况，简化原三行代码写法
 
@@ -792,6 +794,8 @@ Requires-Dist: prompt-toolkit
 + 功能新增: Session的所有异步命令调用函数增加返回值，现在调用 session.exec_async, exec_command_async 等方法执行的内容若匹配为命令时，会返回最后最后一个 Command 对象的 execute 函数的返回值
     - 例如， result = await self.session.cmds.cmd_runto.execute('rt yz') 与 result = await self.session.exec_async('rt yz') 等价，返回值相同
     - 但     result = await self.session.exec_async('rt yz;dzt')，该返回的result 仅是 dzt 命令的 execute 的返回值。 rt yz 命令返回值被丢弃。
++ 功能新增: 增加临时变量概念，变量名以下划线开头的为临时变量，此类变量不会被保存到 .mud 文件中。
+
 
 ## 0.19.4 (2024-04-20)
 + 功能调整: info 现在 msg 恢复为可接受任何类型参数，不一定是 str

{pymud-0.20.0a4.dist-info → pymud-0.20.0a5.dist-info}/RECORD

@@ -1,18 +1,19 @@
-pymud/__init__.py,sha256=hvX7Ga2xPG9J3ZpxBLrC6BvrzUo-Dj26HsRKf41Brhw,533
+pymud/__init__.py,sha256=AP4Edhx90gMKrNfD1O_KVciA3SOnyX5Qt9fZY_JhsTY,574
 pymud/__main__.py,sha256=hFzZjadLlcOuoLM7D8wFiFVO8mqF7vMuo9y-9xfIhRc,64
 pymud/dialogs.py,sha256=D0ZtCeoBchF5eYzXumkOi3p-maCQZu4v9-wJgxQ790o,6500
 pymud/extras.py,sha256=QwWwLavVtuXfg0Qb0f_040va1_kej27P-ZB_19HB6Qk,42422
 pymud/logger.py,sha256=elYfbpvmKYJfB-rnPYZWY5r8ROu9yja9t-dBi1faRGc,5358
 pymud/main.py,sha256=b_Ui_cN4W8IfhYNyc1duwr3Bp7pYYZQusKTSafCWZIA,6534
-pymud/objects.py,sha256=aV3RzhZZ7y3qK_kwaYbtnpmaqfBxVwQ8fMwvEs9Dh-A,38534
+pymud/modules.py,sha256=GoNmGnMfi2BEsonJA4iq-unkgHkZRR-XBr1Wix_3-a4,2756
+pymud/objects.py,sha256=5lx9Z9ijrwpqy2KNJu0OyUxXVh_VVYP2PTE82inAW9c,38623
 pymud/pkuxkx.py,sha256=jRQRUs2xtw7GzYHtLYZXOASnqMumKh0iCoOeKZs8NnU,11467
 pymud/protocol.py,sha256=QfDXjlg2OcJXmVoXf_3mAemnYotRXDUlEZNQjhkfXdA,49106
 pymud/pymud.py,sha256=N9WxaHDqqsTWIBG8UJ38gdMC_pQ30wphcN2LtT66eA4,49584
-pymud/session.py,sha256=BCmQljeEjWS6n35WTwmxMZBZenNTAoixaqcAjhTROGs,130095
+pymud/session.py,sha256=3u_ctb3ev5MPYfB7-vrLDd9ag9yw1z-K24hQ40hSrME,129365
 pymud/settings.py,sha256=CRNpHl4RjOuQYzAIWyUEvOo7q-f4lo01X1v_CriHWO4,7145
-pymud-0.20.0a4.dist-info/LICENSE.txt,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-pymud-0.20.0a4.dist-info/METADATA,sha256=tDJ-Og3BTghz3zG6YwEKRnI6EwT083VHG5aeBeW_XCA,72291
-pymud-0.20.0a4.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
-pymud-0.20.0a4.dist-info/entry_points.txt,sha256=diPUOtTkhgC1hVny7Cdg4aRhaHSynMQoraE7ZhJxUcw,37
-pymud-0.20.0a4.dist-info/top_level.txt,sha256=8Gp1eXjxixXjqhhti6tLCspV_8s9sNV3z5Em2_KRhD4,6
-pymud-0.20.0a4.dist-info/RECORD,,
+pymud-0.20.0a5.dist-info/LICENSE.txt,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+pymud-0.20.0a5.dist-info/METADATA,sha256=kaZCuQ8_FyybVKP0c7ksj_jk_qksVwda-YEgSCsmqT4,73061
+pymud-0.20.0a5.dist-info/WHEEL,sha256=Mdi9PDNwEZptOjTlUcAth7XJDFtKrHYaQMPulZeBCiQ,91
+pymud-0.20.0a5.dist-info/entry_points.txt,sha256=diPUOtTkhgC1hVny7Cdg4aRhaHSynMQoraE7ZhJxUcw,37
+pymud-0.20.0a5.dist-info/top_level.txt,sha256=8Gp1eXjxixXjqhhti6tLCspV_8s9sNV3z5Em2_KRhD4,6
+pymud-0.20.0a5.dist-info/RECORD,,