工具

ehforwarderbot.utils.extra(name, desc)[源代码]

用于从端的「附加功能」接口的装饰器（decorator）。

参数

  • name (str) – 面向用户的功能名称。

  • desc (str) – 简短的描述和用法。在描述中应使用 {function_name} 代替函数名。

返回类型

Callable[..., Optional[str]]

返回

被修饰的方法。

示例

@extra(name="复读机", desc="返回输入的文本。\n\n用法：\n    {function_name} 文本")
def echo(self, text: str) -> Optional[str]:
    return text
ehforwarderbot.utils.get_base_path()[源代码]

获取 EFB 数据目录的路径。该路径可由环境变量 EFB_DATA_PATH 定义。

如果未定义 EFB_DATA_PATH，默认路径为 ~/.ehforwarderbot。

如果返回的路径不存在，该方法将创建该目录。

返回类型

Path

返回

数据路径。

ehforwarderbot.utils.get_config_path(module_id=None, ext='yaml')[源代码]

获取配置档案的路径。默认为 ~/.ehforwarderbot/profiles/profile_name/module_id/config.yaml。

如果返回的路径不存在，该方法将创建该目录，但不会创建配置文件。

参数

  • module_id (Optional[NewType()(ModuleID, str)]) – 组件 ID

  • ext (str) – 配置文件的扩展名。默认为 "yaml"。

返回类型

Path

返回

配置文件路径。

ehforwarderbot.utils.get_custom_modules_path()[源代码]

获取自定义信道的路径

返回类型

Path

返回

自定义信道的路经。

ehforwarderbot.utils.get_data_path(module_id)[源代码]

获取分配给组件的永久存储目录的路径。

如果返回的路径不存在，该方法将创建该目录。

参数

module_id (NewType()(ModuleID, str)) – 组件 ID

返回类型

Path

返回

指定组件的路经。

ehforwarderbot.utils.locate_module(module_id, module_type=None)[源代码]

通过组件 ID 定位组件

参数

  • module_id (NewType()(ModuleID, str)) – 组件 ID

  • module_type (Optional[str]) – 组件类型，'master'、'slave' 和 'middleware' 之一