pymud 0.20.4__py3-none-any.whl → 0.21.0a1__py3-none-any.whl

pymud/main.py

@@ -1,9 +1,10 @@
-import os, sys, json, platform, shutil, logging, argparse
+import os, sys, json, platform, shutil, logging, argparse, locale
 from pathlib import Path
 from .pymud import PyMudApp
 from .settings import Settings
 
 CFG_TEMPLATE = {
+    "language" : "chs",                             # 语言设置，默认为简体中文
     "client": {
         "buffer_lines"      : 5000,                 # 保留缓冲行数
 
@@ -41,50 +42,114 @@ CFG_TEMPLATE = {
     }
 }
 
+def detect_system_language():
+    """
+    检测系统语言，返回中文或英文"
+    """
+    lang = "chs"
+    try:
+        value = locale.getlocale()[0]
+        if value and (value.lower().startswith("zh") or value.lower().startswith("chinese")):  # 中文
+            lang = "chs"
+        else:
+            lang = "eng"
+    except Exception as e:
+        # default is chs
+        pass
+
+    return lang
+
 def init_pymud_env(args):
-    print(f"欢迎使用PyMUD, 版本{Settings.__version__}. 使用PyMUD时, 建议建立一个新目录（任意位置），并将自己的脚本以及配置文件放到该目录下.")
-    print("即将开始为首次运行初始化环境...")
-    
-    dir = args.dir
-    if dir:
-        print(f"你已经指定了创建脚本的目录为 {args.dir}")
-        dir = Path(dir)
-    else:
-        dir = Path.home().joinpath('pkuxkx')
-
-        system = platform.system().lower()
-        dir_enter = input(f"检测到当前系统为 {system}, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值 [{dir}]:")
-        if dir_enter:
-            dir = Path(dir_enter)
-                      
-    if dir.exists() and dir.is_dir():
-        print(f'检测到给定目录 {dir} 已存在，切换至此目录...')
-    else:
-        print(f'检测到给定目录 {dir} 不存在，正在创建并切换至目录...')
-        dir.mkdir()
-    
-    os.chdir(dir)
+    lang = detect_system_language()
+    if lang == "chs":
+        print(f"欢迎使用PyMUD, 版本{Settings.__version__}. 使用PyMUD时, 建议建立一个新目录（任意位置），并将自己的脚本以及配置文件放到该目录下.")
+        print("即将开始为首次运行初始化环境...")
+        
+        dir = args.dir
+        if dir:
+            print(f"你已经指定了创建脚本的目录为 {args.dir}")
+            dir = Path(dir)
+        else:
+            dir = Path.home().joinpath('pkuxkx')
+
+            system = platform.system().lower()
+            dir_enter = input(f"检测到当前系统为 {system}, 请指定游戏脚本的目录（若目录不存在会自动创建），直接回车表示使用默认值 [{dir}]:")
+            if dir_enter:
+                dir = Path(dir_enter)
+                        
+        if dir.exists() and dir.is_dir():
+            print(f'检测到给定目录 {dir} 已存在，切换至此目录...')
+        else:
+            print(f'检测到给定目录 {dir} 不存在，正在创建并切换至目录...')
+            dir.mkdir()
+        
+        os.chdir(dir)
 
-    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")
+        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，或直接使用快捷命令 pymud")
+        else:
+            print(f"后续运行PyMUD， 请在 {dir} 目录下键入命令： python3 -m pymud，或直接使用快捷命令 pymud")
 
-    input('所有内容已初始化完毕, 请按回车进入PyMUD.')
+        input('所有内容已初始化完毕, 请按回车进入PyMUD.')
+
+    else:
+        print(f"Welcome to PyMUD, version {Settings.__version__}. When using pymud, it is suggested that a new folder should be created (in any place), and the cfg configuration and all the scripts have been placed in the directory.")
+        print("Starting to initialize the environment for the first time...")
+        dir = args.dir
+        if dir:
+            print(f"You have specified the directory to create the script as {args.dir}")
+            dir = Path(dir)
+        else:
+            dir = Path.home().joinpath('pkuxkx')
+
+            system = platform.system().lower()
+            dir_enter = input(f"Detected the current system is {system}, please specify the directory of the game script (if the directory does not exist, it will be automatically created), press Enter to use the default value [{dir}]:")
+            if dir_enter:
+                dir = Path(dir_enter)
+                        
+        if dir.exists() and dir.is_dir():
+            print(f'Detected that the given directory {dir} already exists, switching to this directory...')
+        else:
+            print(f'Detected that the given directory {dir} does not exist, creating and switching to the directory...')
+            dir.mkdir()
+        
+        os.chdir(dir)
+
+        if os.path.exists('pymud.cfg'):
+            print(f'Detected that the pymud.cfg file already exists in the script directory, entering PyMUD directly using this file...')
+        else:
+            print(f'Detected that the pymud.cfg file does not exist in the script directory, creating the configuration file using the default content...')
+            with open('pymud.cfg', mode = 'x') as fp:
+                CFG_TEMPLATE["language"] = "eng"
+                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'The sample script has been copied to the script directory and added to the default configuration file')
+
+        print(f"Afterwards, you can modify the pymud.cfg file in the {dir} directory for configuration.")
+        if system == "windows":
+            print(f"Afterwards, please type the command 'python -m pymud' in the {dir} directory to run PyMUD, or use the shortcut command pymud")
+        else:
+            print(f"Afterwards, please type the command 'python3 -m pymud' in the {dir} directory to run PyMUD, or use the shortcut command pymud")
+
+        input('Press Enter to enter PyMUD.')
 
     startApp(args)
 

pymud/modules.py

@@ -2,8 +2,126 @@
 import importlib, importlib.util
 from abc import ABC, ABCMeta
 from typing import Any
-from .objects import BaseObject, Command
+from .objects import BaseObject, Command, Trigger, Alias, Timer, GMCPTrigger
+from .settings import Settings
+from .extras import DotDict
 
+class PymudDecorator:
+    """
+    装饰器基类。使用装饰器可以快捷创建各类Pymud基础对象。
+    
+        :param type: 装饰器的类型，用于区分不同的装饰器，为字符串类型。
+        :param args: 可变位置参数，用于传递额外的参数。
+        :param kwargs: 可变关键字参数，用于传递额外的键值对参数。
+    """
+    def __init__(self, type: str, *args, **kwargs):
+        self.type = type
+        self.args = args
+        self.kwargs = kwargs
+
+    def __call__(self, func):
+        decos = getattr(func, "__pymud_decorators__", [])
+        decos.append(self)
+        func.__pymud_decorators__ = decos
+        return func
+        return self
+
+    def __repr__(self):
+        return f"<{self.__class__.__name__} type = {self.type} args = {self.args} kwargs = {self.kwargs}>"
+
+
+def alias(patterns, id = None, group = "", enabled = True, ignoreCase = False, isRegExp = True, keepEval = False, expandVar = True, priority = 100, oneShot = False,  *args, **kwargs):
+    """
+    使用装饰器创建一个别名（Alias）对象。被装饰的函数将在别名成功匹配时调用。
+    被装饰的函数，除第一个参数为类实例本身self之外，另外包括id, line, wildcards三个参数。
+    其中id为别名对象的唯一标识符，line为匹配的文本行，wildcards为匹配的通配符列表。
+
+    :param patterns: 别名匹配的模式。
+    :param id: 别名对象的唯一标识符，不指定时将自动生成唯一标识符。
+    :param group: 别名所属的组名，默认为空字符串。
+    :param enabled: 别名是否启用，默认为 True。
+    :param ignoreCase: 匹配时是否忽略大小写，默认为 False。
+    :param isRegExp: 模式是否为正则表达式，默认为 True。
+    :param keepEval: 若存在多个可匹配的别名时，是否持续匹配，默认为 False。
+    :param expandVar: 是否展开变量，默认为 True。
+    :param priority: 别名的优先级，值越小优先级越高，默认为 100。
+    :param oneShot: 别名是否只触发一次后自动失效，默认为 False。
+    :param args: 可变位置参数，用于传递额外的参数。
+    :param kwargs: 可变关键字参数，用于传递额外的键值对参数。
+    :return: PymudDecorator 实例，类型为 "alias"。
+    """
+    # 将传入的参数更新到 kwargs 字典中
+    kwargs.update({
+        "patterns": patterns,
+        "id": id, 
+        "group": group, 
+        "enabled": enabled, 
+        "ignoreCase": ignoreCase, 
+        "isRegExp": isRegExp, 
+        "keepEval": keepEval, 
+        "expandVar": expandVar, 
+        "priority": priority, 
+        "oneShot": oneShot})
+    
+    # 如果 id 为 None，则从 kwargs 中移除 "id" 键
+    if not id:
+        kwargs.pop("id")
+
+    return PymudDecorator("alias", *args, **kwargs)
+def trigger(patterns, id = None, group = "", enabled = True, ignoreCase = False, isRegExp = True, keepEval = False, expandVar = True, raw = False, priority = 100, oneShot = False,  *args, **kwargs):
+    """
+    使用装饰器创建一个触发器（Trigger）对象。
+
+    :param patterns: 触发器匹配的模式。单行模式可以是字符串或正则表达式，多行模式必须是元组或列表，其中每个元素都是字符串或正则表达式。
+    :param id: 触发器对象的唯一标识符，不指定时将自动生成唯一标识符。
+    :param group: 触发器所属的组名，默认为空字符串。
+    :param enabled: 触发器是否启用，默认为 True。
+    :param ignoreCase: 匹配时是否忽略大小写，默认为 False。
+    :param isRegExp: 模式是否为正则表达式，默认为 True。
+    :param keepEval: 若存在多个可匹配的触发器时，是否持续匹配，默认为 False。
+    :param expandVar: 是否展开变量，默认为 True。
+    :param raw: 是否使用原始匹配方式，默认为 False。原始匹配方式下，不对 VT100 下的 ANSI 颜色进行解码，因此可以匹配颜色；正常匹配仅匹配文本。
+    :param priority: 触发器的优先级，值越小优先级越高，默认为 100。
+    :param oneShot: 触发器是否只触发一次后自动失效，默认为 False。
+    :param args: 可变位置参数，用于传递额外的参数。
+    :param kwargs: 可变关键字参数，用于传递额外的键值对参数。
+    :return: PymudDecorator 实例，类型为 "trigger"。
+    """
+    # 将传入的参数更新到 kwargs 字典中
+    kwargs.update({
+        "patterns": patterns,
+        "id": id, 
+        "group": group, 
+        "enabled": enabled, 
+        "ignoreCase": ignoreCase, 
+        "isRegExp": isRegExp, 
+        "keepEval": keepEval, 
+        "expandVar": expandVar, 
+        "raw": raw,
+        "priority": priority, 
+        "oneShot": oneShot})
+    if not id:
+        kwargs.pop("id")
+    return PymudDecorator("trigger", *args, **kwargs)
+
+def timer(timeout, *args, **kwargs):
+    kwargs.update({"timeout": timeout})
+    return PymudDecorator("timer", *args, **kwargs)
+
+def gmcp(name, *args, **kwargs):
+    kwargs.update({"id": name})
+    return PymudDecorator("gmcp", *args, **kwargs)
+class PymudMeta(type):
+    def __new__(cls, name, bases, attrs):
+        decorator_funcs = {}
+        for name, value in attrs.items():
+            if hasattr(value, "__pymud_decorators__"):
+                decorator_funcs[value.__name__] = getattr(value, "__pymud_decorators__", [])
+                
+        attrs["_decorator_funcs"] = decorator_funcs
+
+        return super().__new__(cls, name, bases, attrs)
+    
 class ModuleInfo:
     """
     模块管理类。对加载的模块文件进行管理。该类型由Session类进行管理，无需人工创建和干预。
@@ -33,10 +151,14 @@ class ModuleInfo:
                 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 ''}创建成功.")
+                        if not reload:
+                            self.session.info(Settings.gettext("configuration_created", self.name, attr_name))
+                        else:
+                            self.session.info(Settings.gettext("configuration_recreated", self.name, attr_name))
+
                     except Exception as e:
                         result = False
-                        self.session.error(f"配置对象 {self.name}.{attr_name} 创建失败. 错误信息为: {e}")
+                        self.session.error(Settings.gettext("configuration_fail", self.name, attr_name, e))
         self._ismainmodule = (self._config != {})
         return result
     
@@ -65,21 +187,21 @@ class ModuleInfo:
     def load(self):
         "加载模块内容"
         if self._load():
-            self.session.info(f"{'主' if self.ismainmodule else '从'}配置模块 {self.name} 加载完成.")
+            self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('load_ok')}")
         else:
-            self.session.error(f"{'主' if self.ismainmodule else '从'}配置模块 {self.name} 加载失败.")
+            self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('load_fail')}")
 
     def unload(self):
         "卸载模块内容"
         self._unload()
         self._loaded = False
-        self.session.info(f"{'主' if self.ismainmodule else '从'}配置模块 {self.name} 卸载完成.")
+        self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('unload_ok')}")
 
     def reload(self):
         "模块文件更新后调用，重新加载已加载的模块内容"
         self._unload()
         self._load(reload = True)
-        self.session.info(f"{'主' if self.ismainmodule else '从'}配置模块 {self.name} 重新加载完成.")
+        self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('reload_ok')}")
 
     @property
     def name(self):
@@ -101,7 +223,7 @@ class ModuleInfo:
         "只读属性，区分是否主模块（即包含具体config的模块）"
         return self._ismainmodule
 
-class IConfig(metaclass = ABCMeta):
+class IConfig(metaclass = PymudMeta):
     """
     用于提示PyMUD应用是否自动创建该配置类型的基础类（模拟接口）。
     
@@ -111,11 +233,48 @@ class IConfig(metaclass = ABCMeta):
     可以从kwargs 中获取该参数，并针对性的设计相应代码。例如，重新加载相关联的其他模块等。
     """
     def __init__(self, session, *args, **kwargs):
-        self.session = session
+        from .session import Session
+        if isinstance(session, Session):
+            self.session = session
+        self.__inline_objects__ = DotDict()
+
+        if hasattr(self, "_decorator_funcs"):
+            for func_name, decorators in self._decorator_funcs.items():
+                func = getattr(self, func_name)
+                for deco in decorators:
+                    if isinstance(deco, PymudDecorator):
+                        if deco.type == "alias":
+                            patterns = deco.kwargs.pop("patterns")
+                            ali = Alias(self.session, patterns, *deco.args, **deco.kwargs, onSccess = func)
+                            self.__inline_objects__[ali.id] = ali
+                        
+                        elif deco.type == "trigger":
+                            patterns = deco.kwargs.pop("patterns")
+                            tri = Trigger(self.session, patterns, *deco.args, **deco.kwargs, onSuccess = func)
+                            self.__inline_objects__[tri.id] = tri
+
+                        elif deco.type == "timer":
+                            tim = Timer(self.session, *deco.args, **deco.kwargs, onSuccess = func)
+                            self.__inline_objects__[tim.id] = tim
+
+                        elif deco.type == "gmcp":
+                            gmcp = GMCPTrigger(self.session, deco.kwargs.get("id"), *deco.args, **deco.kwargs, onSuccess = func)
+                            self.__inline_objects__[gmcp.id] = gmcp
 
     def __unload__(self):
         if self.session:
-            self.session.delObject(self)
+            self.session.delObjects(self.__inline_objects__)
+            if isinstance(self, BaseObject):
+                self.session.delObject(self)
+
+    @property
+    def objs(self) -> DotDict:
+        "返回内联自动创建的对象字典"
+        return self.__inline_objects__
+    
+    def obj(self, obj_id: str) -> BaseObject:
+        "根据对象ID返回内联自动创建的对象"
+        return self.__inline_objects__.get(obj_id)
 
 class Plugin:
     """

pymud/objects.py

@@ -37,7 +37,7 @@ class CodeLine:
                 elif ch == "}":
                     brace_count -= 1
                     if brace_count < 0:
-                        raise Exception("错误的代码块，大括号数量不匹配")
+                        raise Exception(Settings.gettext("excpetion_brace_not_matched"))
                     arg += ch
                 elif ch == "'":
                     if single_quote == 0:
@@ -60,7 +60,7 @@ class CodeLine:
                     arg += ch
 
             if (single_quote > 0) or (double_quote > 0):
-                raise Exception("引号的数量不匹配")
+                raise Exception(Settings.gettext("exception_quote_not_matched"))
             
             if arg:
                 code_params.append(arg)
@@ -178,7 +178,7 @@ class CodeBlock:
             elif ch == "}":
                 brace_count -= 1
                 if brace_count < 0:
-                    raise Exception("错误的代码块，大括号数量不匹配")
+                    raise Exception(Settings.gettext("excpetion_brace_not_matched"))
                 line += ch
             elif ch == ";":
                 if brace_count == 0:
@@ -264,7 +264,7 @@ class CodeBlock:
             elif self.syncmode == "sync":
                 sync = True
             elif self.syncmode == "conflict":
-                session.warning("该命令中同时存在强制同步命令和强制异步命令，将使用异步执行，同步命令将失效。")
+                session.warning(Settings.gettext("exception_forced_async"))
                 sync = False
 
         if sync:
@@ -326,7 +326,7 @@ class BaseObject:
         if isinstance(session, Session):
             self.session    = session
         else:
-            assert("session must be an instance of class Session!")
+            assert(Settings.gettext("exception_session_type_fail"))
             
         self._enabled   = True              # give a default value
         self.log        = logging.getLogger(f"pymud.{self.__class__.__name__}")
@@ -625,7 +625,7 @@ class MatchObject(BaseObject):
             await self.event.wait()
             self.reset()
         except Exception as e:
-            self.error(f"异步执行中遇到异常, {e}")
+            self.error(Settings.gettext("exception_in_async", e))
 
         return self.state