pymud 0.19.1__py3-none-any.whl → 0.19.2.post1__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
 
@@ -81,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

@@ -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":
@@ -283,6 +306,11 @@ class PyMudApp:
                     children=[
                         MenuItem(Settings.text["about"], handler = self.act_about)
                     ]
+                ),
+
+                MenuItem(
+                    "",    # 增加一个空名称MenuItem，阻止右侧空白栏点击响应
+                    children=[]
                 )
             ],
             floats=[
@@ -350,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):
@@ -483,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}的会话，请更换名称再试.")
@@ -508,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()
@@ -611,6 +650,15 @@ class PyMudApp:
                     result = await self.show_dialog_as_float(dlgQuery)
                     if result:
                         session.disconnect()
+
+                        # 增加延时等待确保会话关闭
+                        while session.connected:
+                            await asyncio.sleep(0.1)
+
+                        for plugin in self._plugins.values():
+                            if isinstance(plugin, Plugin):
+                                plugin.onSessionDestroy(self.current_session)
+
                     else:
                         return
                 
@@ -706,13 +754,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
 
@@ -894,7 +967,6 @@ class PyMudApp:
         
 
 def main(cfg_data = None):
-    logging.disable()
     app = PyMudApp(cfg_data)
     app.run()