pymud 0.19.0__py3-none-any.whl → 0.19.2__py3-none-any.whl

pymud/__main__.py

@@ -1,4 +1,4 @@
-import sys, os, json, platform, shutil
+import sys, os, json, platform, shutil, logging
 from .pymud import main
 from .settings import Settings
 
@@ -31,6 +31,12 @@ CFG_TEMPLATE = {
                 "display_title" : ["yourid", "yourpassword", ""],
             }
         }
+    },
+    "keys" : {
+        "f3"    : "#ig",
+        "f4"    : "#clear",
+        "f11"   : "#close",
+        "f12"   : "#exit",
     }
 }
 
@@ -75,6 +81,15 @@ if __name__ == "__main__":
 
         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')
+
     cfg = "pymud.cfg"
     if os.path.exists(cfg):
         with open(cfg, "r", encoding="utf8", errors="ignore") as fp:

pymud/pymud.py

@@ -1,4 +1,4 @@
-import asyncio, functools, re, logging, math, json, os
+import asyncio, functools, re, logging, math, json, os, webbrowser
 import importlib.util
 from prompt_toolkit.shortcuts import set_title
 from prompt_toolkit.output import ColorDepth
@@ -49,7 +49,30 @@ class STATUS_DISPLAY(Enum):
     FLOAT = 3
 
 class PyMudApp:
+    """
+    PYMUD程序管理主对象，对窗体、操作及所有会话进行管理。
+
+    PyMudApp对象不需要手动创建，在命令行中执行 ``python -m pymud`` 时会自动创建对象实例。
+
+    构造函数参数： 
+        - ``cfg_data``: 替代配置数据，由本地pymud.cfg文件读取，用于覆盖settings.py中的默认Settings数据
+
+    可替代字典: 含义请查阅 `应用配置及本地化 <settings.html>`_
+        - sessions: 用于创建菜单栏会话的字典
+        - client: 用于配置客户端属性的字典
+        - text: 用于各默认显示文字内容的字典
+        - server: 用于服务器选项的配置字典
+        - styles: 用于显示样式的定义字典
+        - keys: 用于快捷键定义的字典
+
+    *替代配置按不同的dict使用dict.update进行更新覆盖，因此可以仅指定需替代的部分。*
+    """
+
     def __init__(self, cfg_data = None) -> None:
+        """
+        构造PyMudApp对象实例，并加载替代配置。
+        """
+
         if cfg_data and isinstance(cfg_data, dict):
             for key in cfg_data.keys():
                 if key == "sessions":
@@ -65,6 +88,7 @@ class PyMudApp:
                 elif key == "keys":
                     Settings.keys.update(cfg_data[key])
 
+        self._mouse_support = True
         self._plugins  = DotDict()              # 增加 插件 字典
         self._globals  = DotDict()              # 增加所有session使用的全局变量
         self.sessions = {}
@@ -81,8 +105,10 @@ class PyMudApp:
         self.keybindings.add(Keys.Backspace)(self.delete_selection)
         self.keybindings.add(Keys.ControlLeft, is_global = True)(self.change_session)   # Control-左右箭头切换当前会话
         self.keybindings.add(Keys.ControlRight, is_global = True)(self.change_session)
+        self.keybindings.add(Keys.F1, is_global=True)(lambda event: webbrowser.open(Settings.__website__))
+        self.keybindings.add(Keys.F2, is_global=True)(self.toggle_mousesupport)
 
-        used_keys = [Keys.PageUp, Keys.PageDown, Keys.ControlZ, Keys.ControlC, Keys.ControlR, Keys.Up, Keys.Down, Keys.Left, Keys.Right, Keys.ControlLeft, Keys.ControlRight, Keys.Backspace, Keys.Delete]
+        used_keys = [Keys.PageUp, Keys.PageDown, Keys.ControlZ, Keys.ControlC, Keys.ControlR, Keys.Up, Keys.Down, Keys.Left, Keys.Right, Keys.ControlLeft, Keys.ControlRight, Keys.Backspace, Keys.Delete, Keys.F1, Keys.F2]
 
         for key, binding in Settings.keys.items():
             if (key not in used_keys) and binding and isinstance(binding, str):
@@ -95,6 +121,7 @@ class PyMudApp:
         try:
             clipboard = PyperclipClipboard()
             clipboard.set_text("test pyperclip")
+            clipboard.set_text("")
         except:
             clipboard = None
 
@@ -102,7 +129,7 @@ class PyMudApp:
             layout = Layout(self.root_container, focused_element=self.commandLine),
             enable_page_navigation_bindings=True,
             style=self.style,
-            mouse_support=True,
+            mouse_support=to_filter(self._mouse_support),
             full_screen=True,
             color_depth=ColorDepth.TRUE_COLOR,
             clipboard=clipboard,
@@ -279,6 +306,11 @@ class PyMudApp:
                     children=[
                         MenuItem(Settings.text["about"], handler = self.act_about)
                     ]
+                ),
+
+                MenuItem(
+                    "",    # 增加一个空名称MenuItem，阻止右侧空白栏点击响应
+                    children=[]
                 )
             ],
             floats=[
@@ -346,11 +378,13 @@ class PyMudApp:
                 b.cursor_down(lines)
 
     def page_up(self, event: KeyPressEvent) -> None:
-        lines = (self.app.output.get_size().rows - 5) // 2 - 1
+        #lines = (self.app.output.get_size().rows - 5) // 2 - 1
+        lines = self.get_height() // 2 - 1
         self.scroll(-1 * lines)
 
     def page_down(self, event: KeyPressEvent) -> None:
-        lines = (self.app.output.get_size().rows - 5) // 2 - 1
+        #lines = (self.app.output.get_size().rows - 5) // 2 - 1
+        lines = self.get_height() // 2 - 1
         self.scroll(lines)
 
     def custom_key_press(self, event: KeyPressEvent):
@@ -404,6 +438,13 @@ class PyMudApp:
                     new_key = keys[idx-1]
                     self.activate_session(new_key)
 
+    def toggle_mousesupport(self, event: KeyPressEvent):
+        self._mouse_support = not self._mouse_support
+        if self._mouse_support:
+            self.app.renderer.output.enable_mouse_support()
+        else:
+            self.app.renderer.output.disable_mouse_support()
+
     def copy(self, raw = False):
         b = self.consoleView.buffer
         if b.selection_state:
@@ -472,6 +513,10 @@ class PyMudApp:
             self.sessions[name] = session
             self.activate_session(name)
 
+            for plugin in self._plugins.values():
+                if isinstance(plugin, Plugin):
+                    plugin.onSessionCreate(session)
+
             result = True
         else:
             self.set_status(f"错误！已存在一个名为{name}的会话，请更换名称再试.")
@@ -497,12 +542,17 @@ class PyMudApp:
                     result = await self.show_dialog_as_float(dlgQuery)
                     if result:
                         self.current_session.disconnect()
+
+                        # 增加延时等待确保会话关闭
+                        while self.current_session.connected:
+                            await asyncio.sleep(0.1)
+                            
                     else:
                         return
 
                 for plugin in self._plugins.values():
                     if isinstance(plugin, Plugin):
-                        plugin.onSessionCreate(self.current_session)
+                        plugin.onSessionDestroy(self.current_session)
 
                 name = self.current_session.name
                 self.current_session.clean()
@@ -600,6 +650,11 @@ class PyMudApp:
                     result = await self.show_dialog_as_float(dlgQuery)
                     if result:
                         session.disconnect()
+
+                        # 增加延时等待确保会话关闭
+                        while session.connected:
+                            await asyncio.sleep(0.1)
+
                     else:
                         return
                 
@@ -651,10 +706,13 @@ class PyMudApp:
         ]
     
     def get_statusbar_right_text(self):
-        con_str, tri_status = "", ""
+        con_str, mouse_support, tri_status = "", "", ""
+        if not self._mouse_support:
+            mouse_support = "鼠标已禁用 "
+
         if self.current_session:
             if self.current_session._ignore:
-                tri_status = "全局禁用"
+                tri_status = "全局禁用 "
 
             if not self.current_session.connected:
                 con_str = "未连接"
@@ -678,7 +736,7 @@ class PyMudApp:
                 else:
                     con_str = "已连接：{:.0f}秒".format(sec)
 
-        return "{} {} {} {} ".format(tri_status, con_str, Settings.__appname__, Settings.__version__)
+        return "{}{}{} {} {} ".format(mouse_support, tri_status, con_str, Settings.__appname__, Settings.__version__)
 
     def get_statuswindow_text(self):
         text = ""
@@ -692,13 +750,38 @@ class PyMudApp:
         self.app.invalidate()
 
     def handle_session(self, *args):
-        "\x1b[1m命令\x1b[0m: #session {名称} {宿主机} {端口} {编码}\n" \
-        "      创建一个远程连接会话，使用指定编码格式连接到远程宿主机的指定端口并保存为 {名称} \n" \
-        "      如， #session newstart mud.pkuxkx.net 8080 GBK \n" \
-        "      当不指定编码格式时, 默认使用utf-8编码 \n" \
-        "      如， #session newstart mud.pkuxkx.net 8081 \n" \
-        "      可以直接使用#{名称}将指定会话切换为当前会话，如#newstart \n" \
-        "\x1b[1m相关\x1b[0m: help, exit\n"
+        '''
+        嵌入命令 #session 的执行函数，创建一个远程连接会话。
+        该函数不应该在代码中直接调用。
+
+        使用:
+            - #session {Name} {Host} {Port} {Encoding}
+            - 当不指定 Encoding: 时, 默认使用utf-8编码
+            - 可以直接使用 #{名称} 切换会话和操作会话命令
+
+        参数:
+            :Name: 会话名称
+            :Host: 服务器域名或IP地址
+            :Port: 端口号
+            :Encoding: 编码格式，不指定时默认为 utf8
+    
+        示例:
+            ``#session {名称} {宿主机} {端口} {编码}`` 
+                创建一个远程连接会话，使用指定编码格式连接到远程宿主机的指定端口并保存为 {名称} 。其中，编码可以省略，此时使用Settings.server["default_encoding"]的值，默认为utf8
+            ``#session newstart mud.pkuxkx.net 8080 GBK`` 
+                使用GBK编码连接到mud.pkuxkx.net的8080端口，并将该会话命名为newstart
+            ``#session newstart mud.pkuxkx.net 8081`` 
+                使用UTF8编码连接到mud.pkuxkx.net的8081端口，并将该会话命名为newstart
+            ``#newstart`` 
+                将名称为newstart的会话切换为当前会话
+            ``#newstart give miui gold`` 
+                使名称为newstart的会话执行give miui gold指令，但不切换到该会话
+
+        相关命令:
+            - #close
+            - #exit
+
+        '''
 
         nothandle = True
 
@@ -717,72 +800,6 @@ class PyMudApp:
         if nothandle:
             self.set_status("错误的#session命令")
 
-    def handle_help(self, *args):
-        "\x1b[1m命令\x1b[0m: #help {主题}\n" \
-        "      当不带参数时, #help会列出所有可用的帮助主题\n" \
-        "\x1b[1m相关\x1b[0m: session, exit\n"
-
-        if self.current_session:
-            if len(args) == 0:      # 不带参数，打印所有支持的help主题
-                self._print_all_help()
-            
-            elif len(args) >= 1:    # 大于1个参数，第1个为 topic， 其余参数丢弃
-                topic = args[0]
-
-                if topic in ("exit", "close", "session", "help"):
-                    command = getattr(self, f"handle_{topic}", None)
-                    docstring = command.__doc__
-                elif topic in self.current_session._commands_alias.keys():
-                    command = self.current_session._commands_alias[topic]
-                    docstring = self.current_session._cmds_handler[command].__doc__
-                elif topic in self.current_session._sys_commands:
-                    docstring = self.current_session._cmds_handler[topic].__doc__
-                else:
-                    docstring = f"未找到主题{topic}, 请确认输入是否正确."
-                
-                self.current_session.writetobuffer(docstring)
-
-        else:
-            self.act_about()
-    
-    def _print_all_help(self):
-        """打印所有可用的help主题, 并根据终端尺寸进行排版"""
-        width = self.get_width()
-
-        cmds = ["exit", "close", "session", "all", "help"]
-        cmds.extend(Session._commands_alias.keys())
-        cmds.extend(Session._sys_commands)
-        cmds.sort()
-
-        cmd_count = len(cmds)
-        left = (width - 8) // 2
-        right = width - 8 - left
-        self.current_session.writetobuffer("#"*left + "  HELP  " + "#"*right, newline = True)
-        cmd_per_line = (width - 2) // 20
-        lines = math.ceil(cmd_count / cmd_per_line)
-        left_space = (width - cmd_per_line * 20) // 2
-
-        for idx in range(0, lines):
-            start = idx * cmd_per_line
-            end   = (idx + 1) * cmd_per_line
-            if end > cmd_count: end = cmd_count
-            line_cmds = cmds[start:end]
-            self.current_session.writetobuffer(" " * left_space)
-            for cmd in line_cmds:
-                if cmd in Session._sys_commands:
-                    self.current_session.writetobuffer(f"{cmd.upper():<20}")
-                else:
-                    self.current_session.writetobuffer(f"\x1b[32m{cmd.upper():<20}\x1b[0m")
-
-            self.current_session.writetobuffer("", newline = True)
-
-        self.current_session.writetobuffer("#"*width, newline = True)
-
-    def handle_exit(self, *args):
-        "\x1b[1m命令\x1b[0m: #exit \n" \
-        "      退出PYMUD程序\n" \
-        "\x1b[1m相关\x1b[0m: session\n"
-
     def enter_pressed(self, buffer: Buffer):
         cmd_line = buffer.text
         space_index = cmd_line.find(" ")
@@ -795,31 +812,15 @@ class PyMudApp:
             if self.current_session:
                 self.current_session.last_command = cmd_line
 
-        if cmd_line == "#exit":
-            self.act_exit()
-
-        elif cmd_line == "#close":
-            self.close_session()
-
-        elif cmd_line.startswith("#session"):
+        if cmd_line.startswith("#session"):
             cmd_tuple = cmd_line[1:].split()
             self.handle_session(*cmd_tuple[1:])
 
-        elif cmd_line.startswith("#help"):
-            #self.act_about()
-            cmd_tuple = cmd_line[1:].split()
-            self.handle_help(*cmd_tuple[1:])
-
-        elif cmd_line[1:] in self.sessions.keys():
-            self.activate_session(cmd_line[1:])
-
         else:
             if self.current_session:
                 if len(cmd_line) == 0:
                     self.current_session.writeline("")
                 else:
-                    # 增加额外处置：当创建代码块出现异常时，直接执行本行内容
-                    # 是为了解决find-draw里面原图的有关内容，会出现引号、括号不匹配情况
                     try:
                         cb = CodeBlock(cmd_line)
                         cb.execute(self.current_session)
@@ -962,7 +963,6 @@ class PyMudApp:
         
 
 def main(cfg_data = None):
-    logging.disable()
     app = PyMudApp(cfg_data)
     app.run()