使用 markdown 格式的强调语法

This commit is contained in:
hemengyang
2022-01-12 18:19:21 +08:00
parent 0099364838
commit 4ba1a09fb7
25 changed files with 536 additions and 536 deletions

View File

@ -12,15 +12,15 @@ from .plugin import Plugin, get_plugin
def load_plugin(module_path: str) -> Optional[Plugin]:
"""
使用 ``PluginManager`` 加载单个插件,可以是本地插件或是通过 ``pip`` 安装的插件。
使用 `PluginManager` 加载单个插件,可以是本地插件或是通过 `pip` 安装的插件。
:参数:
* ``module_path: str``: 插件名称 ``path.to.your.plugin``
* `module_path: str`: 插件名称 `path.to.your.plugin`
:返回:
- ``Optional[Plugin]``
- `Optional[Plugin]`
"""
manager = PluginManager([module_path])
@ -30,15 +30,15 @@ def load_plugin(module_path: str) -> Optional[Plugin]:
def load_plugins(*plugin_dir: str) -> Set[Plugin]:
"""
导入目录下多个插件,以 ``_`` 开头的插件不会被导入!
导入目录下多个插件,以 `_` 开头的插件不会被导入!
:参数:
- ``*plugin_dir: str``: 插件路径
- `*plugin_dir: str`: 插件路径
:返回:
- ``Set[Plugin]``
- `Set[Plugin]`
"""
manager = PluginManager(search_path=plugin_dir)
_managers.append(manager)
@ -49,16 +49,16 @@ def load_all_plugins(
module_path: Iterable[str], plugin_dir: Iterable[str]
) -> Set[Plugin]:
"""
导入指定列表中的插件以及指定目录下多个插件,以 ``_`` 开头的插件不会被导入!
导入指定列表中的插件以及指定目录下多个插件,以 `_` 开头的插件不会被导入!
:参数:
- ``module_path: Iterable[str]``: 指定插件集合
- ``plugin_dir: Iterable[str]``: 指定插件路径集合
- `module_path: Iterable[str]`: 指定插件集合
- `plugin_dir: Iterable[str]`: 指定插件路径集合
:返回:
- ``Set[Plugin]``
- `Set[Plugin]`
"""
manager = PluginManager(module_path, plugin_dir)
_managers.append(manager)
@ -67,16 +67,16 @@ def load_all_plugins(
def load_from_json(file_path: str, encoding: str = "utf-8") -> Set[Plugin]:
"""
导入指定 json 文件中的 ``plugins`` 以及 ``plugin_dirs`` 下多个插件,以 ``_`` 开头的插件不会被导入!
导入指定 json 文件中的 `plugins` 以及 `plugin_dirs` 下多个插件,以 `_` 开头的插件不会被导入!
:参数:
- ``file_path: str``: 指定 json 文件路径
- ``encoding: str``: 指定 json 文件编码
- `file_path: str`: 指定 json 文件路径
- `encoding: str`: 指定 json 文件编码
:返回:
- ``Set[Plugin]``
- `Set[Plugin]`
"""
with open(file_path, "r", encoding=encoding) as f:
data = json.load(f)
@ -89,17 +89,17 @@ def load_from_json(file_path: str, encoding: str = "utf-8") -> Set[Plugin]:
def load_from_toml(file_path: str, encoding: str = "utf-8") -> Set[Plugin]:
"""
导入指定 toml 文件 ``[tool.nonebot]`` 中的 ``plugins`` 以及 ``plugin_dirs`` 下多个插件,
以 ``_`` 开头的插件不会被导入!
导入指定 toml 文件 `[tool.nonebot]` 中的 `plugins` 以及 `plugin_dirs` 下多个插件,
以 `_` 开头的插件不会被导入!
:参数:
- ``file_path: str``: 指定 toml 文件路径
- ``encoding: str``: 指定 toml 文件编码
- `file_path: str`: 指定 toml 文件路径
- `encoding: str`: 指定 toml 文件编码
:返回:
- ``Set[Plugin]``
- `Set[Plugin]`
"""
with open(file_path, "r", encoding=encoding) as f:
data = tomlkit.parse(f.read()) # type: ignore
@ -127,7 +127,7 @@ def load_builtin_plugin(name: str) -> Optional[Plugin]:
:返回:
- ``Plugin``
- `Plugin`
"""
return load_plugin(f"nonebot.plugins.{name}")
@ -138,7 +138,7 @@ def load_builtin_plugins(*plugins) -> Set[Plugin]:
:返回:
- ``Set[Plugin]``
- `Set[Plugin]`
"""
return load_all_plugins([f"nonebot.plugins.{p}" for p in plugins], [])
@ -149,14 +149,14 @@ def require(name: str) -> Export:
:参数:
* ``name: str``: 插件名,与 ``load_plugin`` 参数一致。如果为 ``load_plugins`` 导入的插件,则为文件(夹)名。
* `name: str`: 插件名,与 `load_plugin` 参数一致。如果为 `load_plugins` 导入的插件,则为文件(夹)名。
:返回:
- ``Export``
- `Export`
:异常:
- ``RuntimeError``: 插件无法加载
- `RuntimeError`: 插件无法加载
"""
plugin = get_plugin(name) or load_plugin(name)
if not plugin: