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

pymud/__init__.py

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

pymud/__main__.py

@@ -1,4 +1,4 @@
-import sys, os, json, platform, shutil, logging
+import sys, os, json, platform, shutil, logging, argparse
 from .pymud import main
 from .settings import Settings
 
@@ -40,63 +40,101 @@ CFG_TEMPLATE = {
     }
 }
 
-if __name__ == "__main__":
-    args = sys.argv
-    if (len(args) == 2) and (args[1] == "init"):
-        print(f"欢迎使用PyMUD, 版本{Settings.__version__}. 使用PyMUD时, 建议建立一个新目录（任意位置），并将自己的脚本以及配置文件放到该目录下.")
-        print("即将开始为首次运行初始化环境...")
-        uname = platform.uname()
-        system  = uname[0].lower()
+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\\"
+            dir = input("检测到当前系统为Windows, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值[d:\pkuxkx]:")
+            if not dir: dir = "d:\\pkuxkx"
+
         elif system == "linux":
-            dir = input("检测到当前系统为Linux, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值[~/pkuxkx/]:")
-            if not dir: dir = "~/pkuxkx/"
+            dir = input("检测到当前系统为Linux, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值[~/pkuxkx]:")
+            if not dir: dir = "~/pkuxkx"
 
-        if not os.path.exists(dir):
-            print(f'检测到给定目录 {dir} 不存在，正在创建目录...', end = "")
-            os.mkdir(dir)
-            os.chdir(dir)
-            print(f'完成!')
+        elif system == "darwin":
+            dir = input("检测到当前系统为MacOS, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值[~/pkuxkx]:")
+            if not dir: dir = "~/pkuxkx"
 
-        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 == "linux":
-            print(f"后续运行PyMUD， 请在 {dir} 目录下键入命令： python3 -m pymud")
         else:
-            print(f"后续运行PyMUD， 请在 {dir} 目录下键入命令： python -m pymud")
-
-        input('所有内容已初始化完毕, 请按回车进入PyMUD.')
-
-    if (len(args) == 2) and (args[1] == "withlog"):
-        # 指定带log时，打印log信息
-        # 所有级别log都存入文件
-        logging.basicConfig(level=logging.NOTSET,
-                            format='%(asctime)s %(name)-12s %(levelname)-8s %(message)s',
-                            datefmt='%m-%d %H:%M',
-                            filename='myapp.log',
-                            filemode='a')
-        
+            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:
-        logging.disable()
+        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()
+        main()
+
+
+if __name__ == "__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
+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
@@ -127,3 +127,30 @@ class NewSessionDialog(BasicDialog):
         encoding = get_app().layout.get_buffer_by_name("encoding").text
         result = (name, host, port, encoding)
         self.set_done(result)
+
+
+class LogSelectionDialog(BasicDialog):
+    def __init__(self, text, values, modal=True):
+        self._header_text = text
+        self._selection_values = values
+        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
+            ])
+        return body
+    
+    def create_buttons(self):
+        ok_button = EasternButton(text="确定", handler=self.btn_ok_clicked)
+        cancel_button = EasternButton(text="取消", handler=(lambda: self.set_done(False)))
+        return [ok_button, cancel_button]
+    
+    def btn_ok_clicked(self):
+        result = self._radio_list.current_value
+        self.set_done(result)
+    

pymud/extras.py

@@ -2,7 +2,7 @@
 from unicodedata import east_asian_width
 from wcwidth import wcwidth
 from typing import Any
-import time
+import time, datetime
 
 from typing import Iterable
 from prompt_toolkit import ANSI
@@ -434,6 +434,7 @@ class SessionBufferControl(BufferControl):
                         buffer.cursor_position = start
                         buffer.start_selection(selection_type=SelectionType.CHARACTERS)
                         buffer.cursor_position = end
+
                 else:
                     # Don't handle scroll events here.
                     return NotImplemented
@@ -1078,4 +1079,5 @@ class Plugin:
 
     def __getattr__(self, __name: str) -> Any:
         if hasattr(self.mod, __name):
-            return self.mod.__getattribute__(__name)
+            return self.mod.__getattribute__(__name)
+        

pymud/logger.py

@@ -0,0 +1,154 @@
+import os, re, datetime, threading
+from queue import SimpleQueue, Empty
+
+class Logger:
+    """
+    PyMUD 的记录器类型，可用于会话中向文件记录数据
+    
+    :param name: 记录器名称，各记录器名称应保持唯一。记录器名称会作为记录文件名称的主要参数
+    :param mode: 记录模式。可选模式包括 a, w, n 三种。
+       - a为添加模式，当新开始记录时，会添加在原有记录文件（name.log）之后。
+       - w为覆写模式，当新开始记录时，会覆写原记录文件（name.log）。
+       - n为新建模式，当新开始记录时，会以name和当前时间为参数新建一个文件（name.now.log）用于记录。
+    :param encoding: 记录文件的编码格式，默认为 "utf-8"
+    :param errors: 当编码模式失败时的处理方式，默认为 "ignore"
+    :param raw: 记录带ANSI标记的原始内容，还是记录纯文本内容，默认为True，即记录带ANSI标记的原始内容。
+    """
+
+    _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
+        self._enabled = False
+        self._raw = raw
+        self.mode = mode
+        self._encoding = encoding
+        self._errors = errors
+        self._lock = threading.RLock()
+        self._stream = None
+        
+        self._queue = SimpleQueue()
+
+    @property
+    def name(self):
+        "记录器名称，仅在创建时设置，过程中只读"
+        return self._name
+
+    @property
+    def enabled(self):
+        """
+        使能属性。
+        从false切换到true时，会打开文件，创建后台线程进行记录。
+        从true切换到false时，会终止后台记录线程，并关闭记录文件。
+        """
+        return self._enabled
+
+    @enabled.setter
+    def enabled(self, enabled):
+        if self._enabled != enabled:
+            if enabled:
+                mode = "a"
+
+                if self._mode in ("a", "w"):
+                    filename = f"{self.name}.log"
+                    mode = self._mode
+                elif self._mode == "n":
+                    now = datetime.datetime.now().strftime("%Y_%m_%d_%H_%M_%S")
+                    filename = f"{self.name}.{now}.log"
+
+                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
+                t.start()
+
+            else:
+                self._queue.put_nowait(None)
+                self._thread.join()
+                self._thread = None
+                self._closeFile()
+
+            self._enabled = enabled
+
+    @property
+    def raw(self):
+        "属性，设置和获取是否记录带有ANSI标记的原始记录"
+        return self._raw
+    
+    @raw.setter
+    def raw(self, val: bool):
+        self._raw = val
+
+    @property
+    def mode(self):
+        "属性，记录器模式，可为 a, w, n"
+        return self._mode
+    
+    @mode.setter
+    def mode(self, value):
+        if value in ("a", "w", "n"):
+            self._mode = value
+
+    def _closeFile(self):
+        """
+        Closes the stream.
+        """
+        self._lock.acquire()
+        try:
+            if self._stream:
+                try:
+                    self._stream.flush()
+                finally:
+                    stream = self._stream
+                    self._stream = None
+                    stream.close()
+        finally:
+            self._lock.release()
+
+    def log(self, msg):
+        """
+        向记录器记录信息。记录的信息会通过队列发送到独立的记录线程。
+        当记录器未使能时，使用该函数调用也不会记录。
+        
+        :param msg: 要记录的信息
+        """
+        if self._enabled:
+            self._queue.put_nowait(msg)
+
+    def _monitor(self):
+        """
+        Monitor the queue for records, and ask the handler
+        to deal with them.
+
+        This method runs on a separate, internal thread.
+        The thread will terminate if it sees a sentinel object in the queue.
+        """
+        newline = True
+        while True:
+            try:
+                data = self._queue.get(block = True)
+                if data:
+                    self._lock.acquire()
+
+                    if newline:
+                        now = datetime.datetime.now().strftime("%Y-%m-%d %H:%M:%S")
+                        header = f"{now} {self._name}: "
+                        self._stream.write(header)
+                        newline = False
+
+                    if data.endswith("\n"):
+                        data = data.rstrip("\n").rstrip("\r") + "\n"
+                        newline = True
+
+                    if not self._raw:
+                        data = self._esc_regx.sub("", data)
+
+                    self._stream.write(data)
+
+                    self._stream.flush()
+                    self._lock.release()
+
+                else:
+                    break
+            except Empty:
+                break

pymud/objects.py

@@ -5,7 +5,6 @@ MUD会话(session)中, 支持的对象列表
 import asyncio, logging, re
 from collections.abc import Iterable
 from collections import namedtuple
-import functools
 from typing import Any
 from .settings import Settings
 
@@ -991,3 +990,4 @@ class SimpleTimer(Timer):
 
     def __detailed__(self) -> str:
         return f'<{self.__class__.__name__}> id = "{self.id}" group = "{self.group}" enabled = {self.enabled} timeout = {self.timeout} code = "{self._code}"'
+

pymud/pymud.py

@@ -1,6 +1,7 @@
-import asyncio, functools, re, logging, math, json, os, webbrowser
+import asyncio, functools, re, logging, math, json, os, webbrowser, threading
+from datetime import datetime
 import importlib.util
-from prompt_toolkit.shortcuts import set_title
+from prompt_toolkit.shortcuts import set_title, radiolist_dialog
 from prompt_toolkit.output import ColorDepth
 from prompt_toolkit.clipboard.pyperclip import PyperclipClipboard
 from prompt_toolkit import HTML
@@ -8,7 +9,7 @@ from prompt_toolkit.buffer import Buffer
 from prompt_toolkit.application import Application
 from prompt_toolkit.filters import Condition
 from prompt_toolkit.key_binding import KeyBindings
-from prompt_toolkit.layout import ConditionalContainer, Float, VSplit, HSplit, Window, WindowAlign
+from prompt_toolkit.layout import ConditionalContainer, Float, VSplit, HSplit, Window, WindowAlign, ScrollbarMargin, NumberedMargin
 from prompt_toolkit.layout.layout import Layout
 from prompt_toolkit.layout.controls import FormattedTextControl
 from prompt_toolkit.layout.dimension import D
@@ -38,7 +39,7 @@ from .objects import CodeBlock
 from .extras import MudFormatProcessor, SessionBuffer, EasternMenuContainer, VSplitWindow, SessionBufferControl, DotDict, Plugin
 from .session import Session
 from .settings import Settings
-from .dialogs import MessageDialog, WelcomeDialog, QueryDialog, NewSessionDialog
+from .dialogs import MessageDialog, WelcomeDialog, QueryDialog, NewSessionDialog, LogSelectionDialog
 
 from enum import Enum
 
@@ -140,6 +141,12 @@ class PyMudApp:
         set_title("{} {}".format(Settings.__appname__, Settings.__version__))
         self.set_status(Settings.text["welcome"])
 
+        self.loggers = dict()           # 所有记录字典
+        self.showLog = False            # 是否显示记录页
+        self.logFileShown = ''          # 记录页显示的记录文件名
+        self.logSessionBuffer = SessionBuffer()
+        self.logSessionBuffer.name = "LOGBUFFER"
+
         self.load_plugins()
 
     def initUI(self):
@@ -193,6 +200,7 @@ class PyMudApp:
             width = D(preferred = Settings.client["naws_width"]),
             height = D(preferred = Settings.client["naws_height"]),
             wrap_lines=Condition(lambda: is_true(self.wrap_lines)),
+            #left_margins=[NumberedMargin()],
             #right_margins=[ScrollbarMargin(True)],   
             style="class:text-area"
             )
@@ -363,16 +371,26 @@ class PyMudApp:
                 menu.children.append(sub)
             menus.append(menu)
 
+        menus.append(MenuItem("-", disabled=True))
+        menus.append(MenuItem(Settings.text["show_log"], handler = self.show_logSelectDialog))
         menus.append(MenuItem("-", disabled=True))
         menus.append(MenuItem(Settings.text["exit"], handler=self.act_exit))
 
         return menus
 
+    def invalidate(self):
+        "刷新显示界面"
+        self.app.invalidate()
+
     def scroll(self, lines = 1):
         "内容滚动指定行数，小于0为向上滚动，大于0为向下滚动"
         if self.current_session:
             s = self.current_session
             b = s.buffer
+        elif self.showLog:
+            b = self.logSessionBuffer
+            
+        if isinstance(b, Buffer):
             if lines < 0:
                 b.cursor_up(-1 * lines)
             elif lines > 0:
@@ -439,11 +457,22 @@ class PyMudApp:
                     new_key = keys[idx+1]
                     self.activate_session(new_key)
 
+                elif (idx == count -1) and self.showLog:
+                    self.showLogInTab()
+
             elif event.key_sequence[-1].key == Keys.ControlLeft:
                 if idx > 0:
                     new_key = keys[idx-1]
                     self.activate_session(new_key)
 
+        else:
+            if self.showLog:
+                if event.key_sequence[-1].key == Keys.ControlLeft:
+                    keys = list(self.sessions.keys())
+                    if len(keys) > 0:
+                        new_key = keys[-1]
+                        self.activate_session(new_key)
+
     def toggle_mousesupport(self, event: KeyPressEvent):
         """快捷键F2: 切换鼠标支持状态。用于远程连接时本地复制命令执行操作"""
         self._mouse_support = not self._mouse_support
@@ -482,8 +511,8 @@ class PyMudApp:
                     selection = line_plain[start:end]
                     self.app.clipboard.set_text(selection)
                     self.set_status("已复制：{}".format(selection))
-
-                    self.current_session.setVariable("%copy", selection)
+                    if self.current_session:
+                        self.current_session.setVariable("%copy", selection)
                 else:
                     # 多行只认行
                     lines = []
@@ -494,8 +523,9 @@ class PyMudApp:
 
                     self.app.clipboard.set_text("\n".join(lines))
                     self.set_status("已复制：行数{}".format(1 + erow - srow))
-
-                    self.current_session.setVariable("%copy", "\n".join(lines))
+                    
+                    if self.current_session:
+                        self.current_session.setVariable("%copy", "\n".join(lines))
                     
             else:
                 # Control-R 复制带有ANSI标记的原始内容（对应字符关系会不正确，因此RAW复制时自动整行复制）
@@ -503,15 +533,18 @@ class PyMudApp:
                     line = b.document.current_line
                     self.app.clipboard.set_text(line)
                     self.set_status("已复制：{}".format(line))
-
-                    self.current_session.setVariable("%copy", line)
+                    
+                    if self.current_session:
+                        self.current_session.setVariable("%copy", line)
 
                 else:
                     lines = b.document.lines[srow:erow+1]
                     copy_raw_text = "".join(lines)
                     self.app.clipboard.set_text(copy_raw_text)
                     self.set_status("已复制：行数{}".format(1 + erow - srow))
-                    self.current_session.setVariable("%copy", copy_raw_text)
+
+                    if self.current_session:
+                        self.current_session.setVariable("%copy", copy_raw_text)
 
                 # data = self.consoleView.buffer.copy_selection()
                 # self.app.clipboard.set_data(data)
@@ -552,6 +585,52 @@ class PyMudApp:
 
         return result
 
+    def show_logSelectDialog(self):
+        async def coroutine():
+            head_line = "   {}{}{}".format('记录文件名'.ljust(15), '文件大小'.rjust(16), '最后修改时间'.center(17))
+            
+            log_list = list()
+            files = [f for f in os.listdir('.') if os.path.isfile(f) and f.endswith('.log')]
+            for file in files:
+                filename = os.path.basename(file).ljust(20)
+                filesize = f"{os.path.getsize(file):,} Bytes".rjust(20)
+                # ctime   = datetime.fromtimestamp(os.path.getctime(file)).strftime('%Y-%m-%d %H:%M:%S').rjust(23)
+                mtime   = datetime.fromtimestamp(os.path.getmtime(file)).strftime('%Y-%m-%d %H:%M:%S').rjust(23)
+                
+                file_display_line = "{}{}{}".format(filename, filesize, mtime)
+                log_list.append((file, file_display_line))
+            
+            dialog = LogSelectionDialog(
+                text = head_line,
+                values = log_list
+            )
+
+            result = await self.show_dialog_as_float(dialog)
+
+            if result:
+                self.logFileShown = result
+                self.showLogInTab()
+
+        asyncio.ensure_future(coroutine())
+
+    def showLogInTab(self):
+        "在记录也显示LOG记录"
+        self.current_session = None
+        self.showLog = True
+
+        if self.logFileShown:
+            filename = os.path.abspath(self.logFileShown)
+            if os.path.exists(filename):
+                lock = threading.RLock()
+                lock.acquire()
+                with open(filename, 'r', encoding = 'utf-8', errors = 'ignore') as file:
+                    self.logSessionBuffer._set_text(file.read())
+                lock.release()
+
+            self.logSessionBuffer.cursor_position = len(self.logSessionBuffer.text)
+            self.consoleView.buffer = self.logSessionBuffer
+            self.app.invalidate()
+
     def activate_session(self, key):
         "激活指定名称的session，并将该session设置为当前session"
         session = self.sessions.get(key, None)
@@ -627,9 +706,22 @@ class PyMudApp:
             b.exit_selection()
             b.cursor_position = len(b.text)
 
+        elif self.showLog:
+            b = self.logSessionBuffer
+            b.exit_selection()
+            b.cursor_position = len(b.text)
+
     def act_close_session(self):
         "菜单: 关闭当前会话"
-        self.close_session()
+        if self.current_session:
+            self.close_session()
+
+        elif self.showLog:
+            self.showLog = False
+            self.logSessionBuffer.text = ""
+            if len(self.sessions.keys()) > 0:
+                new_sess = list(self.sessions.keys())[0]
+                self.activate_session(new_sess)
 
     def act_echoinput(self):
         "菜单: 显示/隐藏输入指令"
@@ -722,12 +814,21 @@ class PyMudApp:
     def btn_title_clicked(self, name, mouse_event: MouseEvent):
         "顶部会话标签点击切换鼠标事件"
         if mouse_event.event_type == MouseEventType.MOUSE_UP:
-            self.activate_session(name)
+            if name == '[LOG]':
+                self.showLogInTab()
+            else:
+                self.activate_session(name)
 
     def get_frame_title(self):
         "顶部会话标题选项卡"
         if len(self.sessions.keys()) == 0:
-            return Settings.__appname__ + " " + Settings.__version__
+            if not self.showLog:
+                return Settings.__appname__ + " " + Settings.__version__
+            else:
+                if self.logFileShown:
+                    return f'[LOG] {self.logFileShown}'
+                else:
+                    return f'[LOG]'
         
         title_formatted_list = []
         for key, session in self.sessions.items():
@@ -746,6 +847,17 @@ class PyMudApp:
             title_formatted_list.append((style, key, functools.partial(self.btn_title_clicked, key)))
             title_formatted_list.append(("", " | "))
 
+        if self.showLog:
+            if self.current_session is None:
+                style = style = Settings.styles["selected"]
+            else:
+                style = Settings.styles["normal"]
+
+            title = f'[LOG] {self.logFileShown}' if self.logFileShown else f'[LOG]'
+
+            title_formatted_list.append((style, title, functools.partial(self.btn_title_clicked, '[LOG]')))
+            title_formatted_list.append(("", " | "))
+
         return title_formatted_list[:-1]
 
     def get_statusbar_text(self):
@@ -880,13 +992,20 @@ class PyMudApp:
                     self.current_session.writeline("")
                 else:
                     try:
+                        self.current_session.log.log(f"命令行键入: {cmd_line}\n")
+
                         cb = CodeBlock(cmd_line)
                         cb.execute(self.current_session)
                     except Exception as e:
                         self.current_session.warning(e)
                         self.current_session.exec_command(cmd_line)
             else:
-                self.set_status("当前没有正在运行的session.")
+                if cmd_line == "#exit":
+                    self.act_exit()
+                elif (cmd_line == "#close") and self.showLog:
+                    self.act_close_session()
+                else:
+                    self.set_status("当前没有正在运行的session.")
 
         # 配置：命令行内容保留
         if Settings.client["remain_last_input"]:
@@ -1013,7 +1132,7 @@ class PyMudApp:
                         self._plugins[plugin.name] = plugin
                         plugin.onAppInit(self)
                     except Exception as e:
-                        self.set_status(f"文件: {plugins_dir}\{file} 不是一个合法的插件文件，加载错误，信息为: {e}")
+                        self.set_status(f"文件: {plugins_dir}\\{file} 不是一个合法的插件文件，加载错误，信息为: {e}")
         
         # 然后加载当前目录下的插件
         current_dir = os.path.abspath(".")
@@ -1028,8 +1147,7 @@ class PyMudApp:
                         self._plugins[plugin.name] = plugin
                         plugin.onAppInit(self)
                     except Exception as e:
-                        self.set_status(f"文件: {plugins_dir}\{file} 不是一个合法的插件文件. 加载错误，信息为: {e}")
-
+                        self.set_status(f"文件: {plugins_dir}\\{file} 不是一个合法的插件文件. 加载错误，信息为: {e}")
 
     def reload_plugin(self, plugin: Plugin):
         "重新加载指定插件"

pymud/session.py

@@ -1,7 +1,11 @@
 import asyncio, logging, re, math, os, pickle, datetime, importlib, importlib.util, sysconfig
 from collections.abc import Iterable
 from collections import OrderedDict
+import logging, queue
+from logging import FileHandler
+from logging.handlers import QueueHandler, QueueListener
 
+from .logger import Logger
 from .extras import SessionBuffer, DotDict, Plugin
 from .protocol import MudClientProtocol
 from .objects import Trigger, Alias, Command, Timer, SimpleAlias, SimpleTrigger, SimpleTimer, GMCPTrigger, CodeBlock, CodeLine
@@ -73,6 +77,8 @@ class Session:
         "py",           # 直接执行python语句
 
         "all",          # 所有会话执行
+
+        "log",          # 记录处置
     )
 
     _commands_alias = {
@@ -96,7 +102,8 @@ class Session:
     def __init__(self, app, name, host, port, encoding = None, after_connect = None, loop = None, **kwargs):
         self.pyversion = sysconfig.get_python_version()   
         self.loop = loop or asyncio.get_running_loop()    
-        self.log = logging.getLogger("pymud.Session")
+        self.syslog = logging.getLogger("pymud.Session")
+
         self.application = app
         self.name = name
         self._transport = None
@@ -109,6 +116,9 @@ class Session:
         self._events["connected"]    = None
         self._events["disconnected"] = None
 
+        self._loggers = dict()
+        self.log = self.getLogger(name)
+
         self._auto_script = kwargs.get("scripts", None)
 
         self._cmds_handler = dict()                         # 支持的命令的处理函数字典
@@ -159,7 +169,6 @@ class Session:
                             self.warning(f"自动从{file}中加载变量失败，错误消息为： {e}")
 
         
-
         if self._auto_script:
             self.info(f"即将自动加载以下模块:{self._auto_script}")
             self.load_module(self._auto_script)
@@ -340,6 +349,33 @@ class Session:
     def event_disconnected(self, event):
         self._events["disconnected"] = event
 
+    def getLogger(self, name, mode = 'a', encoding = 'utf-8', encoding_errors = 'ignore', raw = False) -> Logger:
+        """
+        根据指定名称和参数获取并返回一个记录器。若指定名称不存在，则创建一个该名称记录器。
+        
+        :param name: 指定的记录器名称
+        :param mode: 记录器的模式，可接受值为 a, w, n。 具体请参见 Logger 对象中 mode 参数
+        :param encoding: 记录文件的编码格式
+        :param encoding_errors: 编码错误的处理方式
+        :param raw: 是否以带ANSI标记的原始格式进行记录
+
+        :return 指定名称的记录器 Logger 对象
+        """
+        if name not in self.application.loggers.keys():
+            logger = Logger(name, mode, encoding, encoding_errors, raw)
+            self._loggers[name] = logger
+            self.application.loggers[name] = logger
+
+        else:
+            if name not in self._loggers.keys():
+                self.warning(f"其它会话中已存在一个名为 {name} 的记录器，将直接返回该记录器")
+
+            logger = self.application.loggers[name]
+            logger.mode = mode
+            logger.raw = raw
+
+        return logger
+
     @property
     def modules(self) -> OrderedDict:
         """
@@ -484,6 +520,7 @@ class Session:
         :param newline: 是否额外增加换行符
         """
         self.buffer.insert_text(data)
+        self.log.log(data)
 
         if len(data) > 0 and (data[-1] == "\n"):
             self._line_count += 1
@@ -491,6 +528,7 @@ class Session:
         if newline:
             self.buffer.insert_text(self.newline_cli)
             self._line_count += 1
+            self.log.log(self.newline_cli)
 
     def clear_half(self):
         """
@@ -520,7 +558,7 @@ class Session:
         if self.connected:
             self._transport.write_eof()
         self.state = "DISCONNECTED"
-        self.log.info(f"服务器断开连接! {self._protocol.__repr__}")
+        self.syslog.info(f"服务器断开连接! {self._protocol.__repr__}")
     
     def feed_gmcp(self, name, value) -> None:
         """
@@ -703,19 +741,22 @@ class Session:
         if self.seperator in line:
             lines = line.split(self.seperator)
             for ln in lines:
+                if Settings.client["echo_input"]:
+                    self.writetobuffer(f"\x1b[32m{ln}\x1b[0m")
+                else:
+                    self.log.log(f"\x1b[32m{ln}\x1b[0m\n")
+
                 cmd = ln + self.newline
                 self.write(cmd.encode(self.encoding, Settings.server["encoding_errors"]))
                 
-                if Settings.client["echo_input"]:
-                    self.writetobuffer(f"\x1b[32m{cmd}\x1b[0m")
-
         else:
+            if Settings.client["echo_input"]:
+                self.writetobuffer(f"\x1b[32m{line}\x1b[0m")
+            else:
+                self.log.log(f"\x1b[32m{line}\x1b[0m\n")
+
             cmd = line + self.newline
             self.write(cmd.encode(self.encoding, Settings.server["encoding_errors"]))
-
-            #if Settings.client["echo_input"]:
-            if Settings.client["echo_input"] and (len(cmd) > len(self.newline)):        # 修改2023-12-3， 向服务器发送空回车时，不回显
-                self.writetobuffer(f"\x1b[32m{cmd}\x1b[0m")
     
     def exec(self, cmd: str, name = None, *args, **kwargs):
         """
@@ -1604,7 +1645,8 @@ class Session:
             - #session
         '''
 
-        self.application.close_session()
+        #self.application.close_session()
+        self.application.act_close_session()
 
     async def handle_wait(self, code: CodeLine = None, *args, **kwargs):
         '''
@@ -2316,7 +2358,12 @@ class Session:
             else:
                 mod = self._modules[module_name]["module"]
                 config = self._modules[module_name]["config"]
-                if config: del config
+                if config: 
+                    if hasattr(config, "unload"):
+                        unload = getattr(config, "unload", None)
+                        if callable(unload):
+                            unload(config)
+                    del config
                 mod = importlib.reload(mod)
                 if hasattr(mod, 'Configuration'):
                     config = mod.Configuration(self)
@@ -2832,3 +2879,94 @@ class Session:
         :param style: 要输出信息的格式(ANSI)， 默认为 ERR_STYLE, \x1b[31m
         """
         self.info2(msg, title, style)
+
+    def handle_log(self, code: CodeLine = None, *args, **kwargs):
+        '''
+        嵌入命令 #log 的执行函数，控制当前会话的记录状态。
+        该函数不应该在代码中直接调用。
+
+        使用:
+            - #log : 显示所有记录器的状态情况
+            - #log start [logger-name] [-a|-w|-n] [-r] : 启动一个记录器
+
+                参数:
+                    - :logger-name: 记录器名称。当不指定时，选择名称为会话名称的记录器（会话默认记录器）
+                    - :-a|-w|-n: 记录器模式选择。 -a 为添加模式（未指定时默认值），在原记录文件后端添加； -w 为覆写模式，清空原记录文件并重新记录； -n 为新建模式，以名称和当前时间为参数，使用 name.now.log 形式创建新的记录文件
+                    - :-r: 指定记录器是否使用 raw 模式
+
+            - #log stop [logger-name] : 停止一个记录器
+                
+                参数:
+                    - :logger-name: 记录器名称。当不指定时，选择名称为会话名称的记录器（会话默认记录器）
+
+            - #log show [loggerFile]: 显示全部日志记录或指定记录文件
+
+                参数:
+                    - :loggerFile: 要显示的记录文件名称。当不指定时，弹出对话框列出当前目录下所有记录文件
+
+        示例:
+            - ``#log`` : 在当前会话窗口列出所有记录器状态
+            - ``#log start`` : 启动本会话默认记录器（记录器名为会话名）。该记录器以纯文本模式，将后续所有屏幕输出、键盘键入、命令输入等记录到 name.log 文件的后端
+            - ``#log start -r`` : 启动本会话默认记录器。该记录器以raw模式，将后续所有屏幕输出、键盘键入、命令输入等记录到 name.log 文件的后端
+            - ``#log start chat`` : 启动名为 chat 的记录器。该记录器以纯文本模式，记录代码中调用过该记录器 .log 进行记录的信息
+            - ``#log stop`` : 停止本会话默认记录器（记录器名为会话名）。
+
+        注意:
+            - 记录器文件模式（-a|-w|-n）在修改后，只有在下一次该记录器启动时才会生效
+            - 记录器记录模式（-r）在修改后立即生效
+        '''
+        
+        args = list()
+        if isinstance(code, CodeLine):
+            args = code.code[2:]
+
+        if len(args) == 0:
+            session_loggers = set(self._loggers.keys())
+            app_loggers = set(self.application.loggers.keys()).difference(session_loggers)
+            self.info("本会话中的记录器情况:")
+            for name in session_loggers:
+                logger = self.application.loggers[name]
+                self.info(f"记录器 {logger.name}, 当前状态: {'开启' if logger.enabled else '关闭'}, 文件模式: {logger.mode}, 记录模式: {'ANSI' if logger.raw else '纯文本'}")
+
+            if len(app_loggers) > 0:
+                self.info("本应用其他会话中的记录器情况:")
+                for name in app_loggers:
+                    logger = self.application.loggers[name]
+                    self.info(f"记录器 {logger.name}, 当前状态: {'开启' if logger.enabled else '关闭'}, 文件模式: {logger.mode}, 记录模式: {'ANSI' if logger.raw else '纯文本'}")
+
+        else:
+            name = self.name
+            if len(args) > 1 and not args[1].startswith('-'):
+                name = args[1]
+
+            if (args[0] == "start"):
+                if "-n" in args:
+                    mode = "n"
+                    mode_name = '新建'
+                elif "-w" in args:
+                    mode = "w"
+                    mode_name = '覆写'
+                else:
+                    mode = "a"
+                    mode_name = '添加'
+
+                raw = True if "-r" in args else False
+                raw_name = '原始ANSI' if raw else '纯文本'
+
+                logger = self.getLogger(name = name, mode = mode, raw = raw)
+                logger.enabled = True
+
+                self.info(f"{datetime.datetime.now()}: 记录器{name}以{mode_name}文件模式以及{raw_name}记录模式开启。")
+
+            elif (args[0] == "stop"):
+                self.info(f"{datetime.datetime.now()}: 记录器{name}记录已关闭。")
+                self.log.enabled = False
+
+            elif (args[0] == "show"):
+                if len(args) > 1 and not args[1].startswith('-'):
+                    file = args[1]
+                    self.application.logFileShown = file
+                    self.application.showLogInTab()
+                else:
+                    self.application.show_logSelectDialog()
+

pymud/settings.py

@@ -11,9 +11,9 @@ class Settings:
     "APP 名称, 默认PYMUD"
     __appdesc__   = "a MUD client written in Python"
     "APP 简要描述"
-    __version__   = "0.19.4"
+    __version__   = "0.20.0"
     "APP 当前版本"
-    __release__   = "2024-04-20"
+    __release__   = "2024-08-14"
     "APP 当前版本发布日期"
     __author__    = "本牛(newstart)@北侠"
     "APP 作者"
@@ -79,6 +79,7 @@ class Settings:
         "welcome"           : "欢迎使用PYMUD客户端 - 北大侠客行，最好的中文MUD游戏",
         "world"             : "世界",
         "new_session"       : "创建新会话...",
+        "show_log"          : "显示记录信息",
         "exit"              : "退出",
         "session"           : "会话",
         "connect"           : "连接/重新连接",
@@ -88,7 +89,7 @@ class Settings:
         "copy"              : "复制(纯文本)",
         "copyraw"           : "复制(ANSI)",
         "clearsession"      : "清空会话内容",
-        "closesession"      : "关闭当前会话",
+        "closesession"      : "关闭当前页面",
         "autoreconnect"     : "打开/关闭自动重连",
         "loadconfig"        : "加载脚本配置",
         "reloadconfig"      : "重新加载脚本配置",

{pymud-0.19.4.dist-info → pymud-0.20.0a1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.1
 Name: pymud
-Version: 0.19.4
+Version: 0.20.0a1
 Summary: a MUD Client written in Python
 Author-email: "newstart@pkuxkx" <crapex@crapex.cc>
 Maintainer-email: "newstart@pkuxkx" <crapex@crapex.cc>
@@ -970,3 +970,9 @@ Requires-Dist: prompt-toolkit
 + 功能调整: #var, #global 指令中，现在对字符串会先使用 eval 转换类型，转换失败时使用 str 类型。例如， #var myvar 1 时，myvar类型将为int
 + 功能调整: 变量替代时，会自动实现类型转化，当被替代变量值为非 str 类型时不会再报错
 + 问题修复: 修复之前从后向前选择时，无法复制的问题
+
+### 0.19.5 (2024-08-XX)
++ 功能调整: 恢复在__init__.py中增加PyMudApp的导出，可以恢复使用from pymud import PyMudApp了
++ 功能调整: 在没有session的时候，也可以执行#exit命令
++ 功能调整: 模块加载和重新加载前，会自动调用模块的unload方法（若有）
++ 功能新增: 增加log功能（待设计）

pymud-0.20.0a1.dist-info/RECORD

@@ -0,0 +1,17 @@
+pymud/__init__.py,sha256=Ep6JrWv2wwlLV5nI7F6BOA7Ei6yVgnxvhIRwFGPr2Oc,501
+pymud/__main__.py,sha256=ybi8pA0BXCZJ_GWgndllT7f1FBBE2tGNCByN0zkaSu0,6748
+pymud/dialogs.py,sha256=D0ZtCeoBchF5eYzXumkOi3p-maCQZu4v9-wJgxQ790o,6500
+pymud/extras.py,sha256=QwWwLavVtuXfg0Qb0f_040va1_kej27P-ZB_19HB6Qk,42422
+pymud/logger.py,sha256=39I_rFBU5MEiOTJyU7GAy9cY_MpYHKiXNgBhpokQrTA,5358
+pymud/objects.py,sha256=0aUc-PZfVSdYPEAamY0eO6k3P9wJcw6PNxfSE8eZZeE,38072
+pymud/pkuxkx.py,sha256=vWXHU6GF0HQ0eWb3LmxFVRP0cKnigffCX7Z-LJvwVtw,11496
+pymud/protocol.py,sha256=QfDXjlg2OcJXmVoXf_3mAemnYotRXDUlEZNQjhkfXdA,49106
+pymud/pymud.py,sha256=2dbgnzlG9476esOfyp9sv-lRSTpMuRaCXnqrOofOu24,48182
+pymud/session.py,sha256=uAWt0-AZWpDvVfCjzoxWDpuOwCQ8s1DN_DZ-rVAC5xs,121232
+pymud/settings.py,sha256=XkyFWTskPGZljuWCaC8cU18ie8-FkecEtb0h3OfcfjU,7145
+pymud-0.20.0a1.dist-info/LICENSE.txt,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
+pymud-0.20.0a1.dist-info/METADATA,sha256=N57G7pGHXWfYKJ2YwJjWFMSYxvfkvwIpmsTKTR1hjro,68201
+pymud-0.20.0a1.dist-info/WHEEL,sha256=HiCZjzuy6Dw0hdX5R3LCFPDmFS4BWl8H-8W39XfmgX4,91
+pymud-0.20.0a1.dist-info/entry_points.txt,sha256=diPUOtTkhgC1hVny7Cdg4aRhaHSynMQoraE7ZhJxUcw,37
+pymud-0.20.0a1.dist-info/top_level.txt,sha256=8Gp1eXjxixXjqhhti6tLCspV_8s9sNV3z5Em2_KRhD4,6
+pymud-0.20.0a1.dist-info/RECORD,,

{pymud-0.19.4.dist-info → pymud-0.20.0a1.dist-info}/WHEEL

@@ -1,5 +1,5 @@
 Wheel-Version: 1.0
-Generator: bdist_wheel (0.43.0)
+Generator: setuptools (72.2.0)
 Root-Is-Purelib: true
 Tag: py3-none-any
 

pymud-0.19.4.dist-info/RECORD

@@ -1,16 +0,0 @@
-pymud/__init__.py,sha256=5SteBKAKAizt98QOxDRuGxRHhoDAijdG8lC5U7az2SM,422
-pymud/__main__.py,sha256=I6jFLnTErSuM0G828WUx5EIAmMNAzqYr2AT1zdtGmp0,4636
-pymud/dialogs.py,sha256=SRNHOashupNi7128Bg_35J1rrI2TsZEakTbaMW5d9PU,5596
-pymud/extras.py,sha256=p2fgnzKFtaAvcYqayMNSZhrC3BpvfkbF_la3SfGaWBA,42400
-pymud/objects.py,sha256=hERTIctGF660CoHwZf00-5RZ1-bqCPK2QuwmTZ7NceU,38088
-pymud/pkuxkx.py,sha256=vWXHU6GF0HQ0eWb3LmxFVRP0cKnigffCX7Z-LJvwVtw,11496
-pymud/protocol.py,sha256=QfDXjlg2OcJXmVoXf_3mAemnYotRXDUlEZNQjhkfXdA,49106
-pymud/pymud.py,sha256=HgmAXBXNMjo8xKAVQRS2XOshp-hieEy7bjvaXGq_0Y0,43230
-pymud/session.py,sha256=18QIArVTPKEBETv4pTWSXssy12XbM4cFj0IhCyio49U,114503
-pymud/settings.py,sha256=p1YPxDAh0isRsoRVGOgklawXYkzUE490irNiizWylB4,7092
-pymud-0.19.4.dist-info/LICENSE.txt,sha256=IwGE9guuL-ryRPEKi6wFPI_zOhg7zDZbTYuHbSt_SAk,35823
-pymud-0.19.4.dist-info/METADATA,sha256=ApUZTZZRwQvR0vXUAd1gMTlcfLjT3NWYz2mKtmuHJmo,67839
-pymud-0.19.4.dist-info/WHEEL,sha256=GJ7t_kWBFywbagK5eo9IoUwLW6oyOeTKmQ-9iHFVNxQ,92
-pymud-0.19.4.dist-info/entry_points.txt,sha256=diPUOtTkhgC1hVny7Cdg4aRhaHSynMQoraE7ZhJxUcw,37
-pymud-0.19.4.dist-info/top_level.txt,sha256=8Gp1eXjxixXjqhhti6tLCspV_8s9sNV3z5Em2_KRhD4,6
-pymud-0.19.4.dist-info/RECORD,,