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

pymud/__init__.py

@@ -1,12 +1,10 @@
 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
 from .logger import Logger
-from .main import main
 
 __all__ = [
-    "IConfig", "PyMudApp", "Settings", "CodeBlock", "Alias", "SimpleAlias", "Trigger", "SimpleTrigger", "Command", "SimpleCommand", "Timer", "SimpleTimer", "GMCPTrigger", "Session", "PyMudApp", "DotDict", "Logger", "main"
+    "PyMudApp", "Settings", "CodeBlock", "Alias", "SimpleAlias", "Trigger", "SimpleTrigger", "Command", "SimpleCommand", "Timer", "SimpleTimer", "GMCPTrigger", "Session", "PyMudApp", "DotDict", "Logger"
 ]

pymud/__main__.py

@@ -1,4 +1,140 @@
-from .main import main
+import sys, os, json, platform, shutil, logging, argparse
+from .pymud import main
+from .settings import Settings
+
+CFG_TEMPLATE = {
+    "client": {
+        "buffer_lines"      : 5000,                 # 保留缓冲行数
+
+        "interval"          : 10,                   # 在自动执行中，两次命令输入中的间隔时间（ms）
+        "auto_connect"      : True,                 # 创建会话后，是否自动连接
+        "auto_reconnect"    : False,                # 在会话异常断开之后，是否自动重连
+        "var_autosave"      : True,                 # 断开时自动保存会话变量
+        "var_autoload"      : True,                 # 初始化时自动加载会话变量
+
+        "echo_input"        : False,
+        "beautify"          : True,                 # 专门为解决控制台下PKUXKX字符画对不齐的问题
+
+        "status_display"    : 1,                    # 状态窗口显示情况设置，0-不显示，1-显示在下方，2-显示在右侧
+        "status_height"     : 4,                    # 下侧状态栏的高度
+        "status_width"      : 30,                   # 右侧状态栏的宽度
+
+    },
+    "sessions" : {
+        "pkuxkx" : {
+            "host" : "mud.pkuxkx.net",
+            "port" : "8081",
+            "encoding" : "utf8",
+            "autologin" : "{0};{1}",
+            "default_script": "examples",
+            "chars" : {
+                "display_title" : ["yourid", "yourpassword", ""],
+            }
+        }
+    },
+    "keys" : {
+        "f3"    : "#ig",
+        "f4"    : "#clear",
+        "f11"   : "#close",
+        "f12"   : "#exit",
+    }
+}
+
+def init_pymud_env(args):
+    print(f"欢迎使用PyMUD, 版本{Settings.__version__}. 使用PyMUD时, 建议建立一个新目录（任意位置），并将自己的脚本以及配置文件放到该目录下.")
+    print("即将开始为首次运行初始化环境...")
+    system = platform.system().lower()
+
+    dir = args.dir
+    if dir:
+        print(f"你已经指定了创建脚本的目录为 {args.dir}, 将不再检测操作系统")
+
+    else:
+        if system == "windows":
+            dir = input("检测到当前系统为Windows, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值[d:\pkuxkx]:")
+            if not dir: dir = "d:\\pkuxkx"
+
+        elif system == "linux":
+            dir = input("检测到当前系统为Linux, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值[~/pkuxkx]:")
+            if not dir: dir = "~/pkuxkx"
+
+        elif system == "darwin":
+            dir = input("检测到当前系统为MacOS, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值[~/pkuxkx]:")
+            if not dir: dir = "~/pkuxkx"
+
+        else:
+            print(f"当前系统不是Windows、Linux或MacOS, 无法通过init来进行配置, 请手动配置. 默认配置即将推出")
+
+
+    if not os.path.exists(dir):
+        print(f'检测到给定目录 {dir} 不存在，正在创建目录...', end = "")
+        os.mkdir(dir)
+        os.chdir(dir)
+        print(f'完成!')
+
+    if os.path.exists('pymud.cfg'):
+        print(f'检测到脚本目录下已存在pymud.cfg文件，将直接使用此文件进入PyMUD...')
+    else:
+        print(f'检测到脚本目录下不存在pymud.cfg文件，将使用默认内容创建该配置文件...')
+        with open('pymud.cfg', mode = 'x') as fp:
+            fp.writelines(json.dumps(CFG_TEMPLATE, indent = 4))
+
+    if not os.path.exists('examples.py'):
+        from pymud import pkuxkx
+        module_dir = pkuxkx.__file__
+        shutil.copyfile(module_dir, 'examples.py')
+        print(f'已将样例脚本拷贝至脚本目录，并加入默认配置文件')
+
+    print(f"后续可自行修改 {dir} 目录下的 pymud.cfg 文件以进行配置。")
+    if system == "windows":
+        print(f"后续运行PyMUD， 请在 {dir} 目录下键入命令： python -m pymud")
+    else:
+        print(f"后续运行PyMUD， 请在 {dir} 目录下键入命令： python3 -m pymud")
+
+    input('所有内容已初始化完毕, 请按回车进入PyMUD.')
+
+    module_entry(args)
+
+def module_entry(args):
+    if args.debug:
+        logging.basicConfig(level = logging.NOTSET,
+            format = '%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
+            datefmt = '%m-%d %H:%M',
+            filename = args.logfile,
+            filemode = 'a' if args.filemode else 'w',
+            encoding = "utf-8"
+            )
+        
+    else:
+        logging.basicConfig(level = logging.NOTSET,
+            format = '%(asctime)s %(name)-12s: %(message)s',
+            datefmt = '%m-%d %H:%M',
+            handlers = [logging.NullHandler()],
+            )
+        
+    cfg = "pymud.cfg"
+    if os.path.exists(cfg):
+        with open(cfg, "r", encoding="utf8", errors="ignore") as fp:
+            cfg_data = json.load(fp)
+            main(cfg_data)
+    else:
+        main()
+
 
 if __name__ == "__main__":
-    main()
+    parser = argparse.ArgumentParser(prog = "pymud", usage = "python -m pymud [-h] [-d] [-l logfile] [-a] {init} ...", description = "PyMUD命令行参数帮助")
+    subparsers = parser.add_subparsers(help = 'init用于初始化运行环境')
+
+    par_init = subparsers.add_parser('init', usage = "python -m pymud init [-h] [-d dir]", description = '初始化pymud运行环境, 包括建立脚本目录, 创建默认配置文件, 创建样例脚本等.')
+    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数据均会被记录。默认不启用。')
+    parser.add_argument('-l', '--logfile', dest = 'logfile', metavar = 'logfile', default = 'pymud.log', help = '指定调试模式下记录文件名，不指定时，默认为当前目录下的pymud.log')
+    parser.add_argument('-a', '--appendmode', dest = 'filemode', action = 'store_true', default = True, help = '指定log文件的访问模式是否为append尾部添加模式，默认为True。当为False时，使用w模式，即每次运行清空之前记录')
+
+    args=parser.parse_args()
+    if hasattr(args, 'func'):
+        args.func(args)
+    else:
+        module_entry(args)

pymud/dialogs.py

@@ -1,7 +1,7 @@
 import asyncio, webbrowser
 
 from prompt_toolkit.layout import AnyContainer, ConditionalContainer, Float, VSplit, HSplit, Window, WindowAlign, ScrollablePane, ScrollOffsets
-from prompt_toolkit.widgets import Button, Dialog, Label, MenuContainer, MenuItem, TextArea, SystemToolbar, Frame, RadioList 
+from prompt_toolkit.widgets import Button, Dialog, Label, MenuContainer, MenuItem, TextArea, SystemToolbar, Frame, RadioList
 from prompt_toolkit.layout.dimension import Dimension, D
 from prompt_toolkit import ANSI, HTML
 from prompt_toolkit.mouse_events import MouseEvent, MouseEventType
@@ -133,14 +133,12 @@ class LogSelectionDialog(BasicDialog):
     def __init__(self, text, values, modal=True):
         self._header_text = text
         self._selection_values = values
-        self._itemsCount = len(values)
-        if len(values) > 0:
-            self._radio_list = RadioList(values = self._selection_values)
-        else:
-            self._radio_list = Label('无记录'.center(13))
+        self._radio_list = RadioList(values = self._selection_values)
         super().__init__('选择查看的记录', modal)
 
     def create_body(self) -> AnyContainer:
+        
+
         body=HSplit([
             Label(text = self._header_text, dont_extend_height=True), 
             self._radio_list
@@ -153,9 +151,6 @@ class LogSelectionDialog(BasicDialog):
         return [ok_button, cancel_button]
     
     def btn_ok_clicked(self):
-        if self._itemsCount:
-            result = self._radio_list.current_value
-            self.set_done(result)
-        else:
-            self.set_done(False)
+        result = self._radio_list.current_value
+        self.set_done(result)
     

pymud/extras.py

@@ -1,7 +1,8 @@
 # External Libraries
 from unicodedata import east_asian_width
 from wcwidth import wcwidth
-import time
+from typing import Any
+import time, datetime
 
 from typing import Iterable
 from prompt_toolkit import ANSI
@@ -1007,5 +1008,76 @@ class DotDict(dict):
     def __setstate__(self, state):
         self.update(state)
 
+import importlib
+import importlib.util
 
+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/logger.py

@@ -1,10 +1,9 @@
-import os, re, datetime, threading, pathlib
+import os, re, datetime, threading
 from queue import SimpleQueue, Empty
-from pathlib import Path
 
 class Logger:
     """
-    PyMUD 的记录器类型，可用于会话中向文件记录数据。记录文件保存在当前目录下的 log 子目录中
+    PyMUD 的记录器类型，可用于会话中向文件记录数据
     
     :param name: 记录器名称，各记录器名称应保持唯一。记录器名称会作为记录文件名称的主要参数
     :param mode: 记录模式。可选模式包括 a, w, n 三种。
@@ -16,7 +15,7 @@ class Logger:
     :param raw: 记录带ANSI标记的原始内容，还是记录纯文本内容，默认为True，即记录带ANSI标记的原始内容。
     """
 
-    _esc_regx = re.compile(r"\x1b\[[\d;]+[abcdmz]", flags = re.IGNORECASE)
+    _esc_regx = re.compile("\x1b\\[[\d;]+[abcdmz]", flags = re.IGNORECASE)
 
     def __init__(self, name, mode = 'a', encoding = "utf-8", errors = "ignore", raw = False):
         self._name = name
@@ -57,12 +56,7 @@ class Logger:
                     now = datetime.datetime.now().strftime("%Y_%m_%d_%H_%M_%S")
                     filename = f"{self.name}.{now}.log"
 
-                logdir = Path.cwd().joinpath('log')
-                if not logdir.exists() or not logdir.is_dir():
-                    logdir.mkdir()
-
-                filename = logdir.joinpath(filename)
-                #filename = os.path.abspath(filename)
+                filename = os.path.abspath(filename)
                 self._stream = open(filename, mode = mode, encoding = self._encoding, errors = self._errors)
                 self._thread = t = threading.Thread(target=self._monitor)
                 t.daemon = True

pymud/objects.py

@@ -2,8 +2,7 @@
 MUD会话(session)中, 支持的对象列表
 """
 
-import asyncio, logging, re, importlib
-from abc import ABC, ABCMeta, abstractmethod
+import asyncio, logging, re
 from collections.abc import Iterable
 from collections import namedtuple
 from typing import Any
@@ -148,7 +147,7 @@ class CodeLine:
         return new_code_str, new_code
 
     async def async_execute(self, session, *args, **kwargs):           
-        return await session.exec_code_async(self, *args, **kwargs)
+        await session.exec_code_async(self, *args, **kwargs)
 
 class CodeBlock:
     """
@@ -278,16 +277,14 @@ class CodeBlock:
         """
         以异步方式执行该 CodeBlock。参数与 execute 相同。
         """
-        result = None
         for code in self.codes:
             if isinstance(code, CodeLine):
-                result = await code.async_execute(session, *args, **kwargs)
+                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:
     """
@@ -322,12 +319,7 @@ class BaseObject:
     "内部缩写代码前缀"
 
     def __init__(self, session, *args, **kwargs):
-        from .session import Session
-        if isinstance(session, Session):
-            self.session    = session
-        else:
-            assert("session must be an instance of class Session!")
-            
+        self.session    = 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__))
@@ -348,8 +340,6 @@ class BaseObject:
 
         self.log.debug(f"对象实例 {self} 创建成功.")
 
-        self.session.addObject(self)
-
     @property
     def enabled(self):
         "可读写属性，使能或取消使能本对象"
@@ -400,8 +390,7 @@ class BaseObject:
         return self.__detailed__()
     
     def __detailed__(self) -> str:
-        group = f'group = "{self.group}" ' if self.group else ''
-        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled}'
+        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled}'
 
 class GMCPTrigger(BaseObject):
     """
@@ -451,8 +440,7 @@ class GMCPTrigger(BaseObject):
             self._onSuccess(self.id, value, value_exp)
 
     def __detailed__(self) -> str:
-        group = f'group = "{self.group}" ' if self.group else ''
-        return f'<{self.__class__.__name__}> name = "{self.id}" value = "{self.value}" {group}enabled = {self.enabled} '
+        return f'<{self.__class__.__name__}> name = "{self.id}" value = "{self.value}" group = "{self.group}" enabled = {self.enabled} '
             
 class MatchObject(BaseObject):
     """
@@ -487,7 +475,7 @@ class MatchObject(BaseObject):
         super().__init__(session, patterns = patterns, *args, **kwargs)
 
     def __del__(self):
-        pass
+        self.reset()
 
     @property
     def patterns(self):
@@ -526,11 +514,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:
@@ -626,8 +614,7 @@ class MatchObject(BaseObject):
         return self.state
     
     def __detailed__(self) -> str:
-        group = f'group = "{self.group}" ' if self.group else ''
-        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled} patterns = "{self.patterns}"'
+        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} patterns = "{self.patterns}"'
 
 class Alias(MatchObject):
     """
@@ -657,8 +644,7 @@ class SimpleAlias(Alias):
         self._codeblock.execute(self.session, id = id, line = line, wildcards = wildcards)
 
     def __detailed__(self) -> str:
-        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}"'
+        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} patterns = "{self.patterns}" code = "{self._code}"'
     
     def __repr__(self) -> str:
         return self.__detailed__()
@@ -709,8 +695,7 @@ class SimpleTrigger(Trigger):
         self._codeblock.execute(self.session, id = id, line = line, raw = raw, wildcards = wildcards)
 
     def __detailed__(self) -> str:
-        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}"'
+        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} patterns = "{self.patterns}" code = "{self._code}"'
     
     def __repr__(self) -> str:
         return self.__detailed__()
@@ -731,20 +716,6 @@ 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 所管理。
@@ -996,8 +967,7 @@ class Timer(BaseObject):
             self.startTimer()
 
     def __detailed__(self) -> str:
-        group = f'group = "{self.group}" ' if self.group else ''
-        return f'<{self.__class__.__name__}> id = "{self.id}" {group}enabled = {self.enabled} timeout = {self.timeout}'
+        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} timeout = {self.timeout}'
     
     def __repr__(self) -> str:
         return self.__detailed__()
@@ -1019,6 +989,5 @@ class SimpleTimer(Timer):
         self._codeblock.execute(self.session, id = id)
 
     def __detailed__(self) -> str:
-        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}"'
+        return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} timeout = {self.timeout} code = "{self._code}"'
 

pymud/pkuxkx.py

@@ -17,9 +17,9 @@ class Configuration:
 
     # hpbrief long情况下的含义
     HP_KEYS = (
-        "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"
+        "exp", "pot", "maxneili", "neili", "maxjingli", "jingli", 
+        "maxqi", "effqi", "qi", "maxjing", "effjing", "jing", 
+        "zhenqi", "zhenyuan", "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 =  lambda id, line, wildcards: webbrowser.open(line))
+        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)
         # 2. fullme的链接对应的触发器，因为要进行多行匹配（3行），因此匹配模式pattern为3个正则表达式模式构成的元组（所有列表类型均可识别），无需像MushClient一样要指定multiline标识和linesToMatch数量
         # 当匹配成功后，调用ontri_hpbrief
         # 特别说明：此处的hpbrief触发匹配，需要set hpbrief long后才可以支持
@@ -130,6 +130,9 @@ 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)