pymud 0.21.0a3__py3-none-any.whl → 0.21.0a5__py3-none-any.whl

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
pymud/modules.py CHANGED
@@ -1,432 +1,286 @@
1
-
2
- import importlib, importlib.util, functools
3
- from abc import ABC, ABCMeta
4
- from typing import Any, Annotated, Optional, Union
5
- from .objects import BaseObject, Command, Trigger, Alias, Timer, GMCPTrigger
6
- from .settings import Settings
7
- from .extras import DotDict
8
-
9
-
10
- class PymudDecorator:
11
- """
12
- 装饰器基类。使用装饰器可以快捷创建各类Pymud基础对象。
13
-
14
- :param type: 装饰器的类型,用于区分不同的装饰器,为字符串类型。
15
- :param args: 可变位置参数,用于传递额外的参数。
16
- :param kwargs: 可变关键字参数,用于传递额外的键值对参数。
17
- """
18
- def __init__(self, type: str, *args, **kwargs):
19
- self.type = type
20
- self.args = args
21
- self.kwargs = kwargs
22
-
23
- def __call__(self, func):
24
- decos = getattr(func, "__pymud_decorators__", [])
25
- decos.append(self)
26
- func.__pymud_decorators__ = decos
27
-
28
- return func
29
- return self
30
-
31
- def __repr__(self):
32
- return f"<{self.__class__.__name__} type = {self.type} args = {self.args} kwargs = {self.kwargs}>"
33
-
34
-
35
- def alias(
36
- patterns: Union[list[str], str],
37
- id: str = None,
38
- group: str = "",
39
- enabled: bool = True,
40
- ignoreCase: bool = False,
41
- isRegExp: bool = True,
42
- keepEval: bool = False,
43
- expandVar: bool = True,
44
- priority: int = 100,
45
- oneShot: bool = False,
46
- *args, **kwargs):
47
- """
48
- 使用装饰器创建一个别名(Alias)对象。被装饰的函数将在别名成功匹配时调用。
49
- 被装饰的函数,除第一个参数为类实例本身self之外,另外包括id, line, wildcards三个参数。
50
- 其中id为别名对象的唯一标识符,line为匹配的文本行,wildcards为匹配的通配符列表。
51
-
52
- :param patterns: 别名匹配的模式。
53
- :param id: 别名对象的唯一标识符,不指定时将自动生成唯一标识符。
54
- :param group: 别名所属的组名,默认为空字符串。
55
- :param enabled: 别名是否启用,默认为 True。
56
- :param ignoreCase: 匹配时是否忽略大小写,默认为 False
57
- :param isRegExp: 模式是否为正则表达式,默认为 True。
58
- :param keepEval: 若存在多个可匹配的别名时,是否持续匹配,默认为 False。
59
- :param expandVar: 是否展开变量,默认为 True。
60
- :param priority: 别名的优先级,值越小优先级越高,默认为 100。
61
- :param oneShot: 别名是否只触发一次后自动失效,默认为 False。
62
- :param args: 可变位置参数,用于传递额外的参数。
63
- :param kwargs: 可变关键字参数,用于传递额外的键值对参数。
64
- :return: PymudDecorator 实例,类型为 "alias"。
65
- """
66
- # 将传入的参数更新到 kwargs 字典中
67
- kwargs.update({
68
- "patterns": patterns,
69
- "id": id,
70
- "group": group,
71
- "enabled": enabled,
72
- "ignoreCase": ignoreCase,
73
- "isRegExp": isRegExp,
74
- "keepEval": keepEval,
75
- "expandVar": expandVar,
76
- "priority": priority,
77
- "oneShot": oneShot})
78
-
79
- # 如果 id 为 None,则从 kwargs 中移除 "id" 键
80
- if not id:
81
- kwargs.pop("id")
82
-
83
- return PymudDecorator("alias", *args, **kwargs)
84
-
85
- def trigger(
86
- patterns: Union[list[str], str],
87
- id: str = None,
88
- group: str = "",
89
- enabled: bool = True,
90
- ignoreCase: bool = False,
91
- isRegExp: bool = True,
92
- keepEval: bool = False,
93
- expandVar: bool = True,
94
- raw: bool = False,
95
- priority: int = 100,
96
- oneShot: bool = False,
97
- *args, **kwargs):
98
- """
99
- 使用装饰器创建一个触发器(Trigger)对象。
100
-
101
- :param patterns: 触发器匹配的模式。单行模式可以是字符串或正则表达式,多行模式必须是元组或列表,其中每个元素都是字符串或正则表达式。
102
- :param id: 触发器对象的唯一标识符,不指定时将自动生成唯一标识符。
103
- :param group: 触发器所属的组名,默认为空字符串。
104
- :param enabled: 触发器是否启用,默认为 True。
105
- :param ignoreCase: 匹配时是否忽略大小写,默认为 False。
106
- :param isRegExp: 模式是否为正则表达式,默认为 True。
107
- :param keepEval: 若存在多个可匹配的触发器时,是否持续匹配,默认为 False。
108
- :param expandVar: 是否展开变量,默认为 True。
109
- :param raw: 是否使用原始匹配方式,默认为 False。原始匹配方式下,不对 VT100 下的 ANSI 颜色进行解码,因此可以匹配颜色;正常匹配仅匹配文本。
110
- :param priority: 触发器的优先级,值越小优先级越高,默认为 100。
111
- :param oneShot: 触发器是否只触发一次后自动失效,默认为 False。
112
- :param args: 可变位置参数,用于传递额外的参数。
113
- :param kwargs: 可变关键字参数,用于传递额外的键值对参数。
114
- :return: PymudDecorator 实例,类型为 "trigger"。
115
- """
116
- # 将传入的参数更新到 kwargs 字典中
117
- kwargs.update({
118
- "patterns": patterns,
119
- "id": id,
120
- "group": group,
121
- "enabled": enabled,
122
- "ignoreCase": ignoreCase,
123
- "isRegExp": isRegExp,
124
- "keepEval": keepEval,
125
- "expandVar": expandVar,
126
- "raw": raw,
127
- "priority": priority,
128
- "oneShot": oneShot})
129
- if not id:
130
- kwargs.pop("id")
131
- return PymudDecorator("trigger", *args, **kwargs)
132
-
133
- def timer(timeout: float, id: str = None, group: str = "", enabled: bool = True, *args, **kwargs):
134
- """
135
- 使用装饰器创建一个定时器(Timer)对象。
136
-
137
- :param timeout: 定时器超时时间,单位为秒。
138
- :param id: 定时器对象的唯一标识符,不指定时将自动生成唯一标识符。
139
- :param group: 定时器所属的组名,默认为空字符串。
140
- :param enabled: 定时器是否启用,默认为 True。
141
- :param args: 可变位置参数,用于传递额外的参数。
142
- :param kwargs: 可变关键字参数,用于传递额外的键值对参数。
143
- :return: PymudDecorator 实例,类型为 "timer"
144
- """
145
- kwargs.update({
146
- "timeout": timeout,
147
- "id": id,
148
- "group": group,
149
- "enabled": enabled
150
- })
151
- if not id:
152
- kwargs.pop("id")
153
- return PymudDecorator("timer", *args, **kwargs)
154
-
155
- def gmcp(name: str, group: str = "", enabled: bool = True, *args, **kwargs):
156
- """
157
- 使用装饰器创建一个GMCP触发器(GMCPTrigger)对象。
158
-
159
- :param name: GMCP触发器的名称。
160
- :param group: GMCP触发器所属的组名,默认为空字符串。
161
- :param enabled: GMCP触发器是否启用,默认为 True。
162
- :param args: 可变位置参数,用于传递额外的参数。
163
- :param kwargs: 可变关键字参数,用于传递额外的键值对参数。
164
- :return: PymudDecorator 实例,类型为 "gmcp"。
165
- """
166
- kwargs.update({
167
- "id": name,
168
- "group": group,
169
- "enabled": enabled
170
- })
171
-
172
- return PymudDecorator("gmcp", *args, **kwargs)
173
-
174
- class PymudMeta(type):
175
- def __new__(cls, name, bases, attrs):
176
- decorator_funcs = {}
177
- for name, value in attrs.items():
178
- if hasattr(value, "__pymud_decorators__"):
179
- decorator_funcs[value.__name__] = getattr(value, "__pymud_decorators__", [])
180
-
181
- attrs["_decorator_funcs"] = decorator_funcs
182
-
183
- return super().__new__(cls, name, bases, attrs)
184
-
185
- class ModuleInfo:
186
- """
187
- 模块管理类。对加载的模块文件进行管理。该类型由Session类进行管理,无需人工创建和干预。
188
-
189
- 有关模块的分类和使用的详细信息,请参见 `脚本 <scripts.html>`_
190
-
191
- :param module_name: 模块的名称, 应与 import xxx 语法中的 xxx 保持一致
192
- :param session: 加载/创建本模块的会话
193
-
194
- """
195
- def __init__(self, module_name: str, session):
196
- self.session = session
197
- self._name = module_name
198
- self._ismainmodule = False
199
- self.load()
200
-
201
- def _load(self, reload = False):
202
- result = True
203
- if reload:
204
- self._module = importlib.reload(self._module)
205
- else:
206
- self._module = importlib.import_module(self.name)
207
- self._config = {}
208
- for attr_name in dir(self._module):
209
- attr = getattr(self._module, attr_name)
210
- if isinstance(attr, type) and attr.__module__ == self._module.__name__:
211
- if (attr_name == "Configuration") or issubclass(attr, IConfig):
212
- try:
213
- self._config[f"{self.name}.{attr_name}"] = attr(self.session, reload = reload)
214
- if not reload:
215
- self.session.info(Settings.gettext("configuration_created", self.name, attr_name))
216
- else:
217
- self.session.info(Settings.gettext("configuration_recreated", self.name, attr_name))
218
-
219
- except Exception as e:
220
- result = False
221
- self.session.error(Settings.gettext("configuration_fail", self.name, attr_name, e))
222
- self._ismainmodule = (self._config != {})
223
- return result
224
-
225
- def _unload(self):
226
- for key, config in self._config.items():
227
- if isinstance(config, Command):
228
- # Command 对象在从会话中移除时,自动调用其 unload 系列方法,因此不能产生递归
229
- self.session.delObject(config)
230
-
231
- else:
232
-
233
- if hasattr(config, "__unload__"):
234
- unload = getattr(config, "__unload__", None)
235
- if callable(unload): unload()
236
-
237
- if hasattr(config, "unload"):
238
- unload = getattr(config, "unload", None)
239
- if callable(unload): unload()
240
-
241
- if isinstance(config, BaseObject):
242
- self.session.delObject(config)
243
-
244
- del config
245
- self._config.clear()
246
-
247
- def load(self):
248
- "加载模块内容"
249
- if self._load():
250
- self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('load_ok')}")
251
- else:
252
- self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('load_fail')}")
253
-
254
- def unload(self):
255
- "卸载模块内容"
256
- self._unload()
257
- self._loaded = False
258
- self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('unload_ok')}")
259
-
260
- def reload(self):
261
- "模块文件更新后调用,重新加载已加载的模块内容"
262
- self._unload()
263
- self._load(reload = True)
264
- self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('reload_ok')}")
265
-
266
- @property
267
- def name(self):
268
- "只读属性,模块名称"
269
- return self._name
270
-
271
- @property
272
- def module(self):
273
- "只读属性,模块文件的 ModuleType 对象"
274
- return self._module
275
-
276
- @property
277
- def config(self):
278
- "只读字典属性,根据模块文件 ModuleType 对象创建的其中名为 Configuration 的类型或继承自 IConfig 的子类型实例(若有)"
279
- return self._config
280
-
281
- @property
282
- def ismainmodule(self):
283
- "只读属性,区分是否主模块(即包含具体config的模块)"
284
- return self._ismainmodule
285
-
286
- class IConfig(metaclass = PymudMeta):
287
- """
288
- 用于提示PyMUD应用是否自动创建该配置类型的基础类。
289
-
290
- 继承 IConfig 类型让应用自动管理该类型,唯一需要的是,构造函数中,仅存在一个必须指定的参数 Session。
291
-
292
- 在应用自动创建 IConfig 实例时,除 session 参数外,还会传递一个 reload 参数 (bool类型),表示是首次加载还是重新加载特性。
293
- 可以从kwargs 中获取该参数,并针对性的设计相应代码。例如,重新加载相关联的其他模块等。
294
- """
295
- def __init__(self, session, *args, **kwargs):
296
- from .session import Session
297
- if isinstance(session, Session):
298
- self.session = session
299
- self.__inline_objects__ = DotDict()
300
-
301
- if hasattr(self, "_decorator_funcs"):
302
- for func_name, decorators in self._decorator_funcs.items():
303
- func = getattr(self, func_name)
304
- for deco in decorators:
305
- if isinstance(deco, PymudDecorator):
306
- if deco.type == "alias":
307
- #patterns = deco.kwargs.pop("patterns")
308
- ali = Alias(self.session, *deco.args, **deco.kwargs, onSuccess = func)
309
- self.__inline_objects__[ali.id] = ali
310
-
311
- elif deco.type == "trigger":
312
- #patterns = deco.kwargs.pop("patterns")
313
- tri = Trigger(self.session, *deco.args, **deco.kwargs, onSuccess = func)
314
- self.__inline_objects__[tri.id] = tri
315
-
316
- elif deco.type == "timer":
317
- tim = Timer(self.session, *deco.args, **deco.kwargs, onSuccess = func)
318
- self.__inline_objects__[tim.id] = tim
319
-
320
- elif deco.type == "gmcp":
321
- gmcp = GMCPTrigger(self.session, name = deco.kwargs.get("id"), *deco.args, **deco.kwargs, onSuccess = func)
322
- self.__inline_objects__[gmcp.id] = gmcp
323
-
324
- def __unload__(self):
325
- if self.session:
326
- self.session.delObjects(self.__inline_objects__)
327
- if isinstance(self, BaseObject):
328
- self.session.delObject(self)
329
-
330
- @property
331
- def objs(self) -> DotDict:
332
- "返回内联自动创建的对象字典"
333
- return self.__inline_objects__
334
-
335
- def obj(self, obj_id: str) -> BaseObject:
336
- "根据对象ID返回内联自动创建的对象"
337
- return self.__inline_objects__.get(obj_id)
338
-
339
- class Plugin:
340
- """
341
- 插件管理类。对加载的插件文件进行管理。该类型由PyMudApp进行管理,无需人工创建。
342
-
343
- 有关插件的详细信息,请参见 `插件 <plugins.html>`_
344
-
345
- :param name: 插件的文件名, 如'myplugin.py'
346
- :param location: 插件所在的目录。自动加载的插件包括PyMUD包目录下的plugins目录以及当前目录下的plugins目录
347
-
348
- """
349
- def __init__(self, name, location):
350
- self._plugin_file = name
351
- self._plugin_loc = location
352
-
353
- self.reload()
354
-
355
- def reload(self):
356
- "加载/重新加载插件对象"
357
- #del self.modspec, self.mod
358
- self.modspec = importlib.util.spec_from_file_location(self._plugin_file[:-3], self._plugin_loc)
359
- self.mod = importlib.util.module_from_spec(self.modspec)
360
- self.modspec.loader.exec_module(self.mod)
361
-
362
- # self._app_init = self.mod.__dict__["PLUGIN_PYMUD_START"]
363
- # self._session_create = self.mod.__dict__["PLUGIN_SESSION_CREATE"]
364
- # self._session_destroy = self.mod.__dict__["PLUGIN_SESSION_DESTROY"]
365
- # self._app_destroy = self.mod.__dict__["PLUGIN_PYMUD_DESTROY"]
366
- self._app_init = self._load_mod_function("PLUGIN_PYMUD_START")
367
- self._session_create = self._load_mod_function("PLUGIN_SESSION_CREATE")
368
- self._session_destroy = self._load_mod_function("PLUGIN_SESSION_DESTROY")
369
- self._app_destroy = self._load_mod_function("PLUGIN_PYMUD_DESTROY")
370
-
371
- def _load_mod_function(self, func_name):
372
- # 定义一个默认函数,当插件文件中未定义指定名称的函数时,返回该函数
373
- # 该函数接受任意数量的位置参数和关键字参数,但不执行任何操作
374
- def default_func(*args, **kwargs):
375
- pass
376
-
377
- result = default_func
378
- if func_name in self.mod.__dict__:
379
- func = self.mod.__dict__[func_name]
380
- if callable(func):
381
- result = func
382
- return result
383
-
384
- @property
385
- def name(self):
386
- "插件名称,由插件文件中的 PLUGIN_NAME 常量定义"
387
- return self.mod.__dict__["PLUGIN_NAME"]
388
-
389
- @property
390
- def desc(self):
391
- "插件描述,由插件文件中的 PLUGIN_DESC 常量定义"
392
- return self.mod.__dict__["PLUGIN_DESC"]
393
-
394
- @property
395
- def help(self):
396
- "插件帮助,由插件文件中的文档字符串定义"
397
- return self.mod.__doc__
398
-
399
- def onAppInit(self, app):
400
- """
401
- PyMUD应用启动时对插件执行的操作,由插件文件中的 PLUGIN_PYMUD_START 函数定义
402
-
403
- :param app: 启动的 PyMudApp 对象实例
404
- """
405
- self._app_init(app)
406
-
407
- def onSessionCreate(self, session):
408
- """
409
- 新会话创建时对插件执行的操作,由插件文件中的 PLUGIN_SESSION_CREATE 函数定义
410
-
411
- :param session: 新创建的会话对象实例
412
- """
413
- self._session_create(session)
414
-
415
- def onSessionDestroy(self, session):
416
- """
417
- 会话关闭时(注意不是断开)对插件执行的操作,由插件文件中的 PLUGIN_SESSION_DESTROY 函数定义
418
-
419
- :param session: 所关闭的会话对象实例
420
- """
421
- self._session_destroy(session)
422
-
423
- def onAppDestroy(self, app):
424
- """
425
- PyMUD应用关闭时对插件执行的操作,由插件文件中的 PLUGIN_PYMUD_DESTROY 函数定义
426
- :param app: 关闭的 PyMudApp 对象实例
427
- """
428
- self._app_destroy(app)
429
-
430
- def __getattr__(self, __name: str) -> Any:
431
- if hasattr(self.mod, __name):
1
+
2
+ import importlib, importlib.util, traceback
3
+ from typing import Any
4
+ from .settings import Settings
5
+ from .extras import DotDict
6
+ from .decorators import exception, async_exception, PymudDecorator, print_exception
7
+
8
+ class PymudMeta(type):
9
+ def __new__(cls, name, bases, attrs):
10
+ decorator_funcs = {}
11
+ for name, value in attrs.items():
12
+ if hasattr(value, "__pymud_decorators__"):
13
+ decorator_funcs[value.__name__] = getattr(value, "__pymud_decorators__", [])
14
+
15
+ attrs["_decorator_funcs"] = decorator_funcs
16
+
17
+ return super().__new__(cls, name, bases, attrs)
18
+
19
+ class ModuleInfo:
20
+ """
21
+ 模块管理类。对加载的模块文件进行管理。该类型由Session类进行管理,无需人工创建和干预。
22
+
23
+ 有关模块的分类和使用的详细信息,请参见 `脚本 <scripts.html>`_
24
+
25
+ :param module_name: 模块的名称, 应与 import xxx 语法中的 xxx 保持一致
26
+ :param session: 加载/创建本模块的会话
27
+
28
+ """
29
+ def __init__(self, module_name: str, session):
30
+ from .session import Session
31
+ if isinstance(session, Session):
32
+ self.session = session
33
+ self._name = module_name
34
+ self._ismainmodule = False
35
+ self.load()
36
+
37
+ def _load(self, reload = False):
38
+ result = True
39
+ if reload:
40
+ self._module = importlib.reload(self._module)
41
+ else:
42
+ self._module = importlib.import_module(self.name)
43
+ self._config = {}
44
+ for attr_name in dir(self._module):
45
+ attr = getattr(self._module, attr_name)
46
+ if isinstance(attr, type) and attr.__module__ == self._module.__name__:
47
+ if (attr_name == "Configuration") or issubclass(attr, IConfig):
48
+ try:
49
+ self._config[f"{self.name}.{attr_name}"] = attr(self.session, reload = reload)
50
+ if not reload:
51
+ self.session.info(Settings.gettext("configuration_created", self.name, attr_name))
52
+ else:
53
+ self.session.info(Settings.gettext("configuration_recreated", self.name, attr_name))
54
+
55
+ except Exception as e:
56
+ result = False
57
+ self.session.error(Settings.gettext("configuration_fail", self.name, attr_name, e))
58
+ self._ismainmodule = (self._config != {})
59
+ return result
60
+
61
+ def _unload(self):
62
+ from .objects import BaseObject, Command
63
+ for key, config in self._config.items():
64
+ if isinstance(config, Command):
65
+ # Command 对象在从会话中移除时,自动调用其 unload 系列方法,因此不能产生递归
66
+ self.session.delObject(config)
67
+
68
+ else:
69
+
70
+ if hasattr(config, "__unload__"):
71
+ unload = getattr(config, "__unload__", None)
72
+ if callable(unload): unload()
73
+
74
+ if hasattr(config, "unload"):
75
+ unload = getattr(config, "unload", None)
76
+ if callable(unload): unload()
77
+
78
+ if isinstance(config, BaseObject):
79
+ self.session.delObject(config)
80
+
81
+ del config
82
+ self._config.clear()
83
+
84
+ def load(self):
85
+ "加载模块内容"
86
+ if self._load():
87
+ self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('load_ok')}")
88
+ else:
89
+ self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('load_fail')}")
90
+
91
+ def unload(self):
92
+ "卸载模块内容"
93
+ self._unload()
94
+ self._loaded = False
95
+ self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('unload_ok')}")
96
+
97
+ def reload(self):
98
+ "模块文件更新后调用,重新加载已加载的模块内容"
99
+ self._unload()
100
+ self._load(reload = True)
101
+ self.session.info(f"{Settings.gettext('entity_module' if self.ismainmodule else 'non_entity_module')} {self.name} {Settings.gettext('reload_ok')}")
102
+
103
+ @property
104
+ def name(self):
105
+ "只读属性,模块名称"
106
+ return self._name
107
+
108
+ @property
109
+ def module(self):
110
+ "只读属性,模块文件的 ModuleType 对象"
111
+ return self._module
112
+
113
+ @property
114
+ def config(self):
115
+ "只读字典属性,根据模块文件 ModuleType 对象创建的其中名为 Configuration 的类型或继承自 IConfig 的子类型实例(若有)"
116
+ return self._config
117
+
118
+ @property
119
+ def ismainmodule(self):
120
+ "只读属性,区分是否主模块(即包含具体config的模块)"
121
+ return self._ismainmodule
122
+
123
+ class IConfigBase(metaclass = PymudMeta):
124
+ """
125
+ 用于支持对装饰器写法对象进行管理的基础类。
126
+ 该类型相当于原来的IConfig类,唯一区别时,模块加载时,不会对本类型创建实例对象。
127
+ 主要用于对插件中定义的Command提供装饰器写法支持,因为这些Command是在会话构建时创建,因此不能在模块加载时自动创建,也就不能继承自IConfig。
128
+ """
129
+ def __init__(self, session, *args, **kwargs):
130
+ from .session import Session
131
+ from .objects import Alias, Trigger, Timer, GMCPTrigger
132
+ if isinstance(session, Session):
133
+ self.session = session
134
+ self.__inline_objects__ = DotDict()
135
+
136
+ if hasattr(self, "_decorator_funcs"):
137
+ deco_funcs = getattr(self, "_decorator_funcs")
138
+ for func_name, decorators in deco_funcs.items():
139
+ func = getattr(self, func_name)
140
+ for deco in decorators:
141
+ if isinstance(deco, PymudDecorator):
142
+ if deco.type == "alias":
143
+ #patterns = deco.kwargs.pop("patterns")
144
+ ali = Alias(self.session, *deco.args, **deco.kwargs, onSuccess = func)
145
+ self.__inline_objects__[ali.id] = ali
146
+
147
+ elif deco.type == "trigger":
148
+ #patterns = deco.kwargs.pop("patterns")
149
+ tri = Trigger(self.session, *deco.args, **deco.kwargs, onSuccess = func)
150
+ self.__inline_objects__[tri.id] = tri
151
+
152
+ elif deco.type == "timer":
153
+ tim = Timer(self.session, *deco.args, **deco.kwargs, onSuccess = func)
154
+ self.__inline_objects__[tim.id] = tim
155
+
156
+ elif deco.type == "gmcp":
157
+ gmcp = GMCPTrigger(self.session, name = deco.kwargs.get("id"), *deco.args, **deco.kwargs, onSuccess = func)
158
+ self.__inline_objects__[gmcp.id] = gmcp
159
+
160
+ def __unload__(self):
161
+ from .objects import BaseObject
162
+ if self.session:
163
+ self.session.delObjects(self.__inline_objects__)
164
+ if isinstance(self, BaseObject):
165
+ self.session.delObject(self)
166
+
167
+ @property
168
+ def objs(self) -> DotDict:
169
+ "返回内联自动创建的对象字典"
170
+ return self.__inline_objects__
171
+
172
+ def obj(self, obj_id: str):
173
+ "根据对象ID返回内联自动创建的对象"
174
+ return self.__inline_objects__.get(obj_id, None) # type: ignore
175
+
176
+ class IConfig(IConfigBase):
177
+ """
178
+ 用于提示PyMUD应用是否自动创建该配置类型的基础类。
179
+
180
+ 继承 IConfig 类型让应用自动管理该类型,唯一需要的是,构造函数中,仅存在一个必须指定的参数 Session。
181
+
182
+ 在应用自动创建 IConfig 实例时,除 session 参数外,还会传递一个 reload 参数 (bool类型),表示是首次加载还是重新加载特性。
183
+ 可以从kwargs 中获取该参数,并针对性的设计相应代码。例如,重新加载相关联的其他模块等。
184
+ """
185
+
186
+ class Plugin:
187
+ """
188
+ 插件管理类。对加载的插件文件进行管理。该类型由PyMudApp进行管理,无需人工创建。
189
+
190
+ 有关插件的详细信息,请参见 `插件 <plugins.html>`_
191
+
192
+ :param name: 插件的文件名, 如'myplugin.py'
193
+ :param location: 插件所在的目录。自动加载的插件包括PyMUD包目录下的plugins目录以及当前目录下的plugins目录
194
+
195
+ """
196
+ def __init__(self, name, location):
197
+ self._plugin_file = name
198
+ self._plugin_loc = location
199
+
200
+ self.reload()
201
+
202
+ def reload(self):
203
+ "加载/重新加载插件对象"
204
+ #del self.modspec, self.mod
205
+ self.modspec = importlib.util.spec_from_file_location(self._plugin_file[:-3], self._plugin_loc)
206
+ if self.modspec and self.modspec.loader:
207
+ self.mod = importlib.util.module_from_spec(self.modspec)
208
+ self.modspec.loader.exec_module(self.mod)
209
+
210
+ self._app_init = self._load_mod_function("PLUGIN_PYMUD_START")
211
+ self._session_create = self._load_mod_function("PLUGIN_SESSION_CREATE")
212
+ self._session_destroy = self._load_mod_function("PLUGIN_SESSION_DESTROY")
213
+ self._app_destroy = self._load_mod_function("PLUGIN_PYMUD_DESTROY")
214
+
215
+ else:
216
+ raise FileNotFoundError(Settings.gettext("exception_plugin_file_not_found", self._plugin_file))
217
+
218
+ def _load_mod_function(self, func_name):
219
+ # 定义一个默认函数,当插件文件中未定义指定名称的函数时,返回该函数
220
+ # 该函数接受任意数量的位置参数和关键字参数,但不执行任何操作
221
+ def default_func(*args, **kwargs):
222
+ pass
223
+
224
+ result = default_func
225
+ if func_name in self.mod.__dict__:
226
+ func = self.mod.__dict__[func_name]
227
+ if callable(func):
228
+ result = func
229
+ return result
230
+
231
+ @property
232
+ def name(self):
233
+ "插件名称,由插件文件中的 PLUGIN_NAME 常量定义"
234
+ return self.mod.__dict__["PLUGIN_NAME"]
235
+
236
+ @property
237
+ def desc(self):
238
+ "插件描述,由插件文件中的 PLUGIN_DESC 常量定义"
239
+ return self.mod.__dict__["PLUGIN_DESC"]
240
+
241
+ @property
242
+ def help(self):
243
+ "插件帮助,由插件文件中的文档字符串定义"
244
+ return self.mod.__doc__
245
+
246
+ def onAppInit(self, app):
247
+ """
248
+ PyMUD应用启动时对插件执行的操作,由插件文件中的 PLUGIN_PYMUD_START 函数定义
249
+
250
+ :param app: 启动的 PyMudApp 对象实例
251
+ """
252
+ self._app_init(app)
253
+
254
+ def onSessionCreate(self, session):
255
+ """
256
+ 新会话创建时对插件执行的操作,由插件文件中的 PLUGIN_SESSION_CREATE 函数定义
257
+
258
+ :param session: 新创建的会话对象实例
259
+ """
260
+ try:
261
+ self._session_create(session)
262
+ except Exception as e:
263
+ print_exception(session, e)
264
+
265
+
266
+ def onSessionDestroy(self, session):
267
+ """
268
+ 会话关闭时(注意不是断开)对插件执行的操作,由插件文件中的 PLUGIN_SESSION_DESTROY 函数定义
269
+
270
+ :param session: 所关闭的会话对象实例
271
+ """
272
+ try:
273
+ self._session_destroy(session)
274
+ except Exception as e:
275
+ print_exception(session, e)
276
+
277
+ def onAppDestroy(self, app):
278
+ """
279
+ PyMUD应用关闭时对插件执行的操作,由插件文件中的 PLUGIN_PYMUD_DESTROY 函数定义
280
+ :param app: 关闭的 PyMudApp 对象实例
281
+ """
282
+ self._app_destroy(app)
283
+
284
+ def __getattr__(self, __name: str) -> Any:
285
+ if hasattr(self.mod, __name):
432
286
  return self.mod.__getattribute__(__name)