pymud 0.19.4__py3-none-any.whl → 0.20.0__py3-none-any.whl

pymud/modules.py

@@ -0,0 +1,188 @@
+
+import importlib, importlib.util
+from abc import ABC, ABCMeta
+from typing import Any
+from .objects import BaseObject, Command
+
+class ModuleInfo:
+    """
+    模块管理类。对加载的模块文件进行管理。该类型由Session类进行管理，无需人工创建和干预。
+
+    有关模块的分类和使用的详细信息，请参见 `脚本 <scripts.html>`_
+
+    :param module_name: 模块的名称, 应与 import xxx 语法中的 xxx 保持一致
+    :param session: 加载/创建本模块的会话
+
+    """
+    def __init__(self, module_name: str, session):
+        self.session = session
+        self._name = module_name 
+        self._ismainmodule = False
+        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, reload = reload)
+                        self.session.info(f"配置对象 {self.name}.{attr_name} {'重新' if reload else ''}创建成功.")
+                    except Exception as e:
+                        result = False
+                        self.session.error(f"配置对象 {self.name}.{attr_name} 创建失败. 错误信息为: {e}")
+        self._ismainmodule = (self._config != {})
+        return result
+    
+    def _unload(self):
+        for key, config in self._config.items():
+            if isinstance(config, Command):
+                # Command 对象在从会话中移除时，自动调用其 unload 系列方法，因此不能产生递归
+                self.session.delObject(config)
+            
+            else:
+
+                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()
+
+                if isinstance(config, BaseObject):
+                    self.session.delObject(config)
+
+            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._loaded = False
+        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):
+        "只读属性，模块文件的 ModuleType 对象"
+        return self._module
+    
+    @property
+    def config(self):
+        "只读字典属性，根据模块文件 ModuleType 对象创建的其中名为 Configuration 的类型或继承自 IConfig 的子类型实例（若有）"
+        return self._config
+    
+    @property
+    def ismainmodule(self):
+        "只读属性，区分是否主模块（即包含具体config的模块）"
+        return self._ismainmodule
+
+class IConfig(metaclass = ABCMeta):
+    """
+    用于提示PyMUD应用是否自动创建该配置类型的基础类（模拟接口）。
+    
+    继承 IConfig 类型让应用自动管理该类型，唯一需要的是，构造函数中，仅存在一个必须指定的参数 Session。
+
+    在应用自动创建 IConfig 实例时，除 session 参数外，还会传递一个 reload 参数 （bool类型），表示是首次加载还是重新加载特性。
+    可以从kwargs 中获取该参数，并针对性的设计相应代码。例如，重新加载相关联的其他模块等。
+    """
+    def __init__(self, session, *args, **kwargs):
+        self.session = session
+
+    def __unload__(self):
+        if self.session:
+            self.session.delObject(self)
+
+class Plugin:
+    """
+    插件管理类。对加载的插件文件进行管理。该类型由PyMudApp进行管理，无需人工创建。
+
+    有关插件的详细信息，请参见 `插件 <plugins.html>`_
+
+    :param name: 插件的文件名, 如'myplugin.py'
+    :param location: 插件所在的目录。自动加载的插件包括PyMUD包目录下的plugins目录以及当前目录下的plugins目录
+
+    """
+    def __init__(self, name, location):
+        self._plugin_file = name
+        self._plugin_loc  = location
+
+        self.reload()
+
+    def reload(self):
+        "加载/重新加载插件对象"
+        #del self.modspec, self.mod
+        self.modspec = importlib.util.spec_from_file_location(self._plugin_file[:-3], self._plugin_loc)
+        self.mod     = importlib.util.module_from_spec(self.modspec)
+        self.modspec.loader.exec_module(self.mod)
+
+        self._app_init = self.mod.__dict__["PLUGIN_PYMUD_START"]
+        self._session_create = self.mod.__dict__["PLUGIN_SESSION_CREATE"]
+        self._session_destroy = self.mod.__dict__["PLUGIN_SESSION_DESTROY"]
+        
+    @property
+    def name(self):
+        "插件名称，由插件文件中的 PLUGIN_NAME 常量定义"
+        return self.mod.__dict__["PLUGIN_NAME"]
+    
+    @property
+    def desc(self):
+        "插件描述，由插件文件中的 PLUGIN_DESC 常量定义"
+        return self.mod.__dict__["PLUGIN_DESC"]
+    
+    @property
+    def help(self):
+        "插件帮助，由插件文件中的文档字符串定义"
+        return self.mod.__doc__
+    
+    def onAppInit(self, app):
+        """
+        PyMUD应用启动时对插件执行的操作，由插件文件中的 PLUGIN_PYMUD_START 函数定义
+
+        :param app: 启动的 PyMudApp 对象实例
+        """
+        self._app_init(app)
+
+    def onSessionCreate(self, session):
+        """
+        新会话创建时对插件执行的操作，由插件文件中的 PLUGIN_SESSION_CREATE 函数定义
+
+        :param session: 新创建的会话对象实例
+        """
+        self._session_create(session)
+
+    def onSessionDestroy(self, session):
+        """
+        会话关闭时（注意不是断开）对插件执行的操作，由插件文件中的 PLUGIN_SESSION_DESTROY 函数定义
+
+        :param session: 所关闭的会话对象实例
+        """
+        self._session_destroy(session)
+
+    def __getattr__(self, __name: str) -> Any:
+        if hasattr(self.mod, __name):
+            return self.mod.__getattribute__(__name)

pymud/objects.py

@@ -2,10 +2,10 @@
 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
-import functools
 from typing import Any
 from .settings import Settings
 
@@ -148,7 +148,7 @@ class CodeLine:
         return new_code_str, new_code
 
     async def async_execute(self, session, *args, **kwargs):           
-        await session.exec_code_async(self, *args, **kwargs)
+        return await session.exec_code_async(self, *args, **kwargs)
 
 class CodeBlock:
     """
@@ -278,14 +278,16 @@ class CodeBlock:
         """
         以异步方式执行该 CodeBlock。参数与 execute 相同。
         """
+        result = None
         for code in self.codes:
             if isinstance(code, CodeLine):
-                await code.async_execute(session, *args, **kwargs)
+                result = await code.async_execute(session, *args, **kwargs)
 
             if Settings.client["interval"] > 0:
                 await asyncio.sleep(Settings.client["interval"] / 1000.0)
 
         session.clean_finished_tasks()
+        return result
 
 class BaseObject:
     """
@@ -320,7 +322,12 @@ class BaseObject:
     "内部缩写代码前缀"
 
     def __init__(self, session, *args, **kwargs):
-        self.session    = session
+        from .session import Session
+        if isinstance(session, Session):
+            self.session    = session
+        else:
+            assert("session must be an instance of class Session!")
+            
         self._enabled   = True              # give a default value
         self.log        = logging.getLogger(f"pymud.{self.__class__.__name__}")
         self.id         = kwargs.get("id", session.getUniqueID(self.__class__.__abbr__))
@@ -341,6 +348,8 @@ class BaseObject:
 
         self.log.debug(f"对象实例 {self} 创建成功.")
 
+        self.session.addObject(self)
+
     @property
     def enabled(self):
         "可读写属性，使能或取消使能本对象"
@@ -391,7 +400,8 @@ class BaseObject:
         return self.__detailed__()
     
     def __detailed__(self) -> str:
-        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled}'
+        group = f'group = "{self.group}" ' if self.group else ''
+        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled}'
 
 class GMCPTrigger(BaseObject):
     """
@@ -441,7 +451,8 @@ class GMCPTrigger(BaseObject):
             self._onSuccess(self.id, value, value_exp)
 
     def __detailed__(self) -> str:
-        return f'<{self.__class__.__name__}> name = "{self.id}" value = "{self.value}" group = "{self.group}" enabled = {self.enabled} '
+        group = f'group = "{self.group}" ' if self.group else ''
+        return f'<{self.__class__.__name__}> name = "{self.id}" value = "{self.value}" {group}enabled = {self.enabled} '
             
 class MatchObject(BaseObject):
     """
@@ -476,7 +487,7 @@ class MatchObject(BaseObject):
         super().__init__(session, patterns = patterns, *args, **kwargs)
 
     def __del__(self):
-        self.reset()
+        pass
 
     @property
     def patterns(self):
@@ -515,11 +526,11 @@ class MatchObject(BaseObject):
                 self._mline = 0
 
     def reset(self):
-        "复位事件，用于async执行未等待结果时，对事件的复位"
+        "复位事件，用于async执行未等待结果时，对事件的复位。仅异步有效。"
         self.event.clear()
 
     def set(self):
-        "设置事件标记，用于人工强制触发"
+        "设置事件标记，用于人工强制触发，仅异步有效。"
         self.event.set()
 
     def match(self, line: str, docallback = True) -> BaseObject.State:
@@ -615,7 +626,8 @@ class MatchObject(BaseObject):
         return self.state
     
     def __detailed__(self) -> str:
-        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} patterns = "{self.patterns}"'
+        group = f'group = "{self.group}" ' if self.group else ''
+        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled} patterns = "{self.patterns}"'
 
 class Alias(MatchObject):
     """
@@ -645,7 +657,8 @@ class SimpleAlias(Alias):
         self._codeblock.execute(self.session, id = id, line = line, wildcards = wildcards)
 
     def __detailed__(self) -> str:
-        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} patterns = "{self.patterns}" code = "{self._code}"'
+        group = f'group = "{self.group}" ' if self.group else ''
+        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled} patterns = "{self.patterns}" code = "{self._code}"'
     
     def __repr__(self) -> str:
         return self.__detailed__()
@@ -696,7 +709,8 @@ class SimpleTrigger(Trigger):
         self._codeblock.execute(self.session, id = id, line = line, raw = raw, wildcards = wildcards)
 
     def __detailed__(self) -> str:
-        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} patterns = "{self.patterns}" code = "{self._code}"'
+        group = f'group = "{self.group}" ' if self.group else ''
+        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled} patterns = "{self.patterns}" code = "{self._code}"'
     
     def __repr__(self) -> str:
         return self.__detailed__()
@@ -717,6 +731,20 @@ class Command(MatchObject):
         super().__init__(session, patterns, sync = False, *args, **kwargs)
         self._tasks = set()
 
+    def __unload__(self):
+        """
+        当从会话中移除任务时，会自动调用该函数。
+        可以将命令管理的各子类对象在此处清除。
+        该函数需要在子类中覆盖重写。
+        """
+        pass
+
+    def unload(self):
+        """
+        与__unload__方法相同，子类仅需覆盖一种方法就可以
+        """
+        pass
+
     def create_task(self, coro, *args, name = None):
         """
         创建并管理任务。由 Command 创建的任务，同时也被 Session 所管理。
@@ -968,7 +996,8 @@ class Timer(BaseObject):
             self.startTimer()
 
     def __detailed__(self) -> str:
-        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} timeout = {self.timeout}'
+        group = f'group = "{self.group}" ' if self.group else ''
+        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled} timeout = {self.timeout}'
     
     def __repr__(self) -> str:
         return self.__detailed__()
@@ -990,4 +1019,6 @@ class SimpleTimer(Timer):
         self._codeblock.execute(self.session, id = id)
 
     def __detailed__(self) -> str:
-        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} timeout = {self.timeout} code = "{self._code}"'
+        group = f'group = "{self.group}" ' if self.group else ''
+        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled} timeout = {self.timeout} code = "{self._code}"'
+

pymud/pkuxkx.py

@@ -17,9 +17,9 @@ class Configuration:
 
     # hpbrief long情况下的含义
     HP_KEYS = (
-        "exp", "pot", "maxneili", "neili", "maxjingli", "jingli", 
-        "maxqi", "effqi", "qi", "maxjing", "effjing", "jing", 
-        "zhenqi", "zhenyuan", "food", "water", "fighting", "busy"
+        "combat_exp", "potential", "max_neili", "neili", "max_jingli", "jingli", 
+        "max_qi", "eff_qi", "qi", "max_jing", "eff_jing", "jing", 
+        "vigour/qi", "vigour/yuan", "food", "water", "fighting", "busy"
         )
 
     # 类的构造函数，传递参数session，是会话本身
@@ -54,7 +54,7 @@ class Configuration:
         
         # 1. fullme的链接对应的触发器，匹配URL
         # 当匹配成功后，调用ontri_webpage
-        self._triggers["tri_webpage"] = self.tri_webpage = Trigger(self.session, id = 'tri_webpage', patterns = r'^http://fullme.pkuxkx.net/robot.php.+$', group = "sys", onSuccess = self.ontri_webpage)
+        self._triggers["tri_webpage"] = self.tri_webpage = Trigger(self.session, id = 'tri_webpage', patterns = r'^http://fullme.pkuxkx.net/robot.php.+$', group = "sys", onSuccess =  lambda id, line, wildcards: webbrowser.open(line))
         # 2. fullme的链接对应的触发器，因为要进行多行匹配（3行），因此匹配模式pattern为3个正则表达式模式构成的元组（所有列表类型均可识别），无需像MushClient一样要指定multiline标识和linesToMatch数量
         # 当匹配成功后，调用ontri_hpbrief
         # 特别说明：此处的hpbrief触发匹配，需要set hpbrief long后才可以支持
@@ -130,9 +130,6 @@ class Configuration:
     def onTimer(self, name, *args, **kwargs):
         self.session.info("每2秒都会打印本信息", "定时器测试")
 
-    def ontri_webpage(self, name, line, wildcards):
-        webbrowser.open(line)
-
     def ontri_hpbrief(self, name, line, wildcards):
         self.session.setVariables(self.HP_KEYS, wildcards)