ErisPulse-HelpModule 2.1.2__tar.gz → 2.1.3__tar.gz

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.
@@ -39,13 +39,15 @@ class HelpModule(BaseModule):
39
39
  return module_config
40
40
 
41
41
  def _get_all_prefixes(self) -> list:
42
- """获取所有命令前缀列表"""
43
- event_config = config.getConfig("ErisPulse.event", {})
44
- command_config = event_config.get("command", {})
45
- prefix = command_config.get("prefix", "/")
42
+ """获取所有命令前缀列表(优先读框架维护的 command.prefix,旧版回退手读配置)"""
43
+ prefix = getattr(command, "prefix", None)
44
+ if prefix is None:
45
+ event_config = config.getConfig("ErisPulse.event", {}) or {}
46
+ command_config = event_config.get("command", {}) or {}
47
+ prefix = command_config.get("prefix", "/")
46
48
  if isinstance(prefix, list):
47
49
  return [str(p) for p in prefix] if prefix else ["/"]
48
- return [str(prefix)]
50
+ return [str(prefix)] if prefix else ["/"]
49
51
 
50
52
  def _get_command_prefix(self) -> str:
51
53
  """获取主显示前缀(第一个)"""
@@ -71,21 +73,47 @@ class HelpModule(BaseModule):
71
73
 
72
74
  return help_command
73
75
 
74
- def _build_command_list(self) -> List[Dict]:
76
+ # ==================== 会话感知查询(旧版框架自动回退) ====================
77
+
78
+ @staticmethod
79
+ def _query_commands(event) -> Dict:
80
+ """获取命令注册表;新版框架按作用域过滤当前会话不可用模块的命令"""
81
+ try:
82
+ return command.get_commands(event=event)
83
+ except TypeError:
84
+ return command.get_commands()
85
+
86
+ @staticmethod
87
+ def _query_visible_commands(event) -> Dict:
88
+ """获取可见命令;新版框架按作用域过滤当前会话不可用模块的命令"""
89
+ try:
90
+ return command.get_visible_commands(event=event)
91
+ except TypeError:
92
+ return command.get_visible_commands()
93
+
94
+ @staticmethod
95
+ def _query_command(name: str, event) -> Optional[Dict]:
96
+ """获取生效命令信息;新版框架在会话不可用时返回 None"""
97
+ try:
98
+ return command.get_command(name, event=event)
99
+ except TypeError:
100
+ return command.get_command(name)
101
+
102
+ def _build_command_list(self, event) -> List[Dict]:
75
103
  self.command_list = []
76
104
  module_config = self._get_config()
77
105
  show_hidden = module_config.get("show_hidden_commands", False)
78
106
 
79
107
  if show_hidden:
80
- all_commands = command.get_commands()
108
+ all_commands = self._query_commands(event)
81
109
  for cmd_name in all_commands:
82
- cmd_info = command.get_command(cmd_name)
110
+ cmd_info = self._query_command(cmd_name, event)
83
111
  if cmd_info and cmd_name == cmd_info.get("main_name"):
84
112
  self.command_list.append({"name": cmd_name, "info": cmd_info})
85
113
  else:
86
- visible_commands = command.get_visible_commands()
114
+ visible_commands = self._query_visible_commands(event)
87
115
  for cmd_name in visible_commands:
88
- cmd_info = command.get_command(cmd_name)
116
+ cmd_info = self._query_command(cmd_name, event)
89
117
  if cmd_info and cmd_name == cmd_info.get("main_name"):
90
118
  self.command_list.append({"name": cmd_name, "info": cmd_info})
91
119
 
@@ -105,7 +133,7 @@ class HelpModule(BaseModule):
105
133
  platform = event.get_platform()
106
134
  args = event.get_command_args()
107
135
 
108
- commands = self._build_command_list()
136
+ commands = self._build_command_list(event)
109
137
  module_config = self._get_config()
110
138
 
111
139
  prefixes = self._get_all_prefixes()
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ErisPulse-HelpModule
3
- Version: 2.1.2
3
+ Version: 2.1.3
4
4
  Summary: ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查看所有可用命令及其用法说明
5
5
  Author-email: wsu2059q <wsu2059@qq.com>
6
6
  License-Expression: MIT
@@ -13,6 +13,9 @@ Dynamic: license-file
13
13
  # ErisPulse-HelpModule
14
14
  ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查看所有可用命令及其用法说明
15
15
 
16
+ > **2.7.0+ 用户推荐使用 [ErisPulse-HelpNext](https://pypi.org/project/ErisPulse-HelpNext/)**(Takumi 图片渲染 / 昼夜主题 / 完整 i18n)。
17
+ > 本模块(HelpModule)继续保留,优先保持**向后兼容性**,适合无法使用 Takumi 图片渲染或停留在旧版本的环境。
18
+
16
19
  ## 功能特性
17
20
  提供 Event 子模块中 command 模块中统一的命令帮助功能
18
21
  - 自动收集并显示所有已注册的命令
@@ -20,6 +23,7 @@ ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查
20
23
  - 支持命令分组显示
21
24
  - 可配置是否显示隐藏命令
22
25
  - 支持命令别名显示
26
+ - 会话感知(ErisPulse 2.8.0+):被作用域禁用的模块,其命令不在当前会话的帮助中列出;旧版框架自动回退为全量列表,行为不变
23
27
 
24
28
  ## 使用方法
25
29
 
@@ -55,3 +59,14 @@ group_commands = true # 是否按组显示命令
55
59
  ## 依赖
56
60
 
57
61
  - ErisPulse SDK 2.2.0+
62
+
63
+ ## 升级到 Next
64
+
65
+ 如果你在使用 ErisPulse 2.7.0+ 且需要图片化帮助(Apple 风格卡片、昼夜主题、多语言),请安装 HelpNext:
66
+
67
+ ```bash
68
+ epsdk install HelpNext
69
+ epsdk uninstall HelpModule
70
+ ```
71
+
72
+ > 注意:HelpModule 与 HelpNext 都注册 `/help` 命令,请只启用其中一个。
@@ -1,6 +1,6 @@
1
1
  Metadata-Version: 2.4
2
2
  Name: ErisPulse-HelpModule
3
- Version: 2.1.2
3
+ Version: 2.1.3
4
4
  Summary: ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查看所有可用命令及其用法说明
5
5
  Author-email: wsu2059q <wsu2059@qq.com>
6
6
  License-Expression: MIT
@@ -13,6 +13,9 @@ Dynamic: license-file
13
13
  # ErisPulse-HelpModule
14
14
  ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查看所有可用命令及其用法说明
15
15
 
16
+ > **2.7.0+ 用户推荐使用 [ErisPulse-HelpNext](https://pypi.org/project/ErisPulse-HelpNext/)**(Takumi 图片渲染 / 昼夜主题 / 完整 i18n)。
17
+ > 本模块(HelpModule)继续保留,优先保持**向后兼容性**,适合无法使用 Takumi 图片渲染或停留在旧版本的环境。
18
+
16
19
  ## 功能特性
17
20
  提供 Event 子模块中 command 模块中统一的命令帮助功能
18
21
  - 自动收集并显示所有已注册的命令
@@ -20,6 +23,7 @@ ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查
20
23
  - 支持命令分组显示
21
24
  - 可配置是否显示隐藏命令
22
25
  - 支持命令别名显示
26
+ - 会话感知(ErisPulse 2.8.0+):被作用域禁用的模块,其命令不在当前会话的帮助中列出;旧版框架自动回退为全量列表,行为不变
23
27
 
24
28
  ## 使用方法
25
29
 
@@ -55,3 +59,14 @@ group_commands = true # 是否按组显示命令
55
59
  ## 依赖
56
60
 
57
61
  - ErisPulse SDK 2.2.0+
62
+
63
+ ## 升级到 Next
64
+
65
+ 如果你在使用 ErisPulse 2.7.0+ 且需要图片化帮助(Apple 风格卡片、昼夜主题、多语言),请安装 HelpNext:
66
+
67
+ ```bash
68
+ epsdk install HelpNext
69
+ epsdk uninstall HelpModule
70
+ ```
71
+
72
+ > 注意:HelpModule 与 HelpNext 都注册 `/help` 命令,请只启用其中一个。
@@ -1,6 +1,9 @@
1
1
  # ErisPulse-HelpModule
2
2
  ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查看所有可用命令及其用法说明
3
3
 
4
+ > **2.7.0+ 用户推荐使用 [ErisPulse-HelpNext](https://pypi.org/project/ErisPulse-HelpNext/)**(Takumi 图片渲染 / 昼夜主题 / 完整 i18n)。
5
+ > 本模块(HelpModule)继续保留,优先保持**向后兼容性**,适合无法使用 Takumi 图片渲染或停留在旧版本的环境。
6
+
4
7
  ## 功能特性
5
8
  提供 Event 子模块中 command 模块中统一的命令帮助功能
6
9
  - 自动收集并显示所有已注册的命令
@@ -8,6 +11,7 @@ ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查
8
11
  - 支持命令分组显示
9
12
  - 可配置是否显示隐藏命令
10
13
  - 支持命令别名显示
14
+ - 会话感知(ErisPulse 2.8.0+):被作用域禁用的模块,其命令不在当前会话的帮助中列出;旧版框架自动回退为全量列表,行为不变
11
15
 
12
16
  ## 使用方法
13
17
 
@@ -43,3 +47,14 @@ group_commands = true # 是否按组显示命令
43
47
  ## 依赖
44
48
 
45
49
  - ErisPulse SDK 2.2.0+
50
+
51
+ ## 升级到 Next
52
+
53
+ 如果你在使用 ErisPulse 2.7.0+ 且需要图片化帮助(Apple 风格卡片、昼夜主题、多语言),请安装 HelpNext:
54
+
55
+ ```bash
56
+ epsdk install HelpNext
57
+ epsdk uninstall HelpModule
58
+ ```
59
+
60
+ > 注意:HelpModule 与 HelpNext 都注册 `/help` 命令,请只启用其中一个。
@@ -1,6 +1,6 @@
1
1
  [project]
2
2
  name = "ErisPulse-HelpModule"
3
- version = "2.1.2"
3
+ version = "2.1.3"
4
4
  description = "ErisPulse 帮助命令模块,提供自动化的命令帮助系统,支持查看所有可用命令及其用法说明"
5
5
  readme = "README.md"
6
6
  requires-python = ">=3.10"