2024-08-19 09:56:38 +08:00
|
|
|
<!doctype html>
|
|
|
|
|
<html lang="zh-CN" data-theme="light">
|
|
|
|
|
<head>
|
|
|
|
|
<meta charset="utf-8" />
|
|
|
|
|
<meta name="viewport" content="width=device-width,initial-scale=1" />
|
|
|
|
|
<meta name="generator" content="VuePress 2.0.0-rc.9" />
|
|
|
|
|
<meta name="theme" content="VuePress Theme Hope 2.0.0-rc.32" />
|
|
|
|
|
<style>
|
|
|
|
|
html {
|
|
|
|
|
background: var(--bg-color, #fff);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
html[data-theme="dark"] {
|
|
|
|
|
background: var(--bg-color, #1d1e1f);
|
|
|
|
|
}
|
|
|
|
|
|
|
|
|
|
body {
|
|
|
|
|
background: var(--bg-color);
|
|
|
|
|
}
|
|
|
|
|
</style>
|
|
|
|
|
<script>
|
|
|
|
|
const userMode = localStorage.getItem("vuepress-theme-hope-scheme");
|
|
|
|
|
const systemDarkMode =
|
|
|
|
|
window.matchMedia &&
|
|
|
|
|
window.matchMedia("(prefers-color-scheme: dark)").matches;
|
|
|
|
|
|
|
|
|
|
if (userMode === "dark" || (userMode !== "light" && systemDarkMode)) {
|
|
|
|
|
document.documentElement.setAttribute("data-theme", "dark");
|
|
|
|
|
}
|
|
|
|
|
</script>
|
2024-08-19 10:23:10 +08:00
|
|
|
<meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/dev/api/plugin/load.html"><meta property="og:site_name" content="LiteyukiBot 轻雪机器人"><meta property="og:title" content="liteyuki.plugin.load"><meta property="og:description" content="def load_plugin(module_path: str | Path) -> Optional[Plugin] 加载单个插件，可以是本地插件或是通过 pip 安装的插件。 参数: def load_plugins() -> set[Plugin] 导入文件夹下多个插件 参数: def format_display_name(display_n..."><meta property="og:type" content="article"><meta property="og:locale" content="zh-CN"><meta property="og:updated_time" content="2024-08-19T02:22:24.000Z"><meta property="article:modified_time" content="2024-08-19T02:22:24.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"liteyuki.plugin.load","image":[""],"dateModified":"2024-08-19T02:22:24.000Z","author":[]}</script><script src="/js/zh/get_data.js" type="module"></script><script src="/js/style.js" type="module"></script><link rel="icon" href="https://cdn.liteyuki.icu/favicon.ico"><link rel="stylesheet" href="https://cdn.bootcdn.net/ajax/libs/firacode/6.2.0/fira_code.min.css"><meta name="viewport" content="width=device-width, initial-scale=1.0, maximum-scale=1.0, user-scalable=no"><title>liteyuki.plugin.load | LiteyukiBot 轻雪机器人</title><meta name="description" content="def load_plugin(module_path: str | Path) -> Optional[Plugin] 加载单个插件，可以是本地插件或是通过 pip 安装的插件。 参数: def load_plugins() -> set[Plugin] 导入文件夹下多个插件 参数: def format_display_name(display_n...">
|
2024-08-19 09:56:38 +08:00
|
|
|
<link rel="preload" href="/assets/style-CSEr-Ojo.css" as="style"><link rel="stylesheet" href="/assets/style-CSEr-Ojo.css">
|
2024-08-19 10:23:10 +08:00
|
|
|
<link rel="modulepreload" href="/assets/app-ClSKFI0Z.js"><link rel="modulepreload" href="/assets/load.html-CvxaRout.js">
|
|
|
|
|
<link rel="prefetch" href="/assets/index.html-D0Bt1T9U.js" as="script"><link rel="prefetch" href="/assets/index.html-DaXmvTJu.js" as="script"><link rel="prefetch" href="/assets/config.html-CYfAO_BM.js" as="script"><link rel="prefetch" href="/assets/fandq.html-CbX4Oa-K.js" as="script"><link rel="prefetch" href="/assets/install.html-BXbF22sQ.js" as="script"><link rel="prefetch" href="/assets/index.html-CMnRejpC.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-D9-RS-2y.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-B71qCLAf.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-dugNecp3.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-SX_2TXET.js" as="script"><link rel="prefetch" href="/assets/index.html-BF9NHBIi.js" as="script"><link rel="prefetch" href="/assets/index.html-Dcs9njrb.js" as="script"><link rel="prefetch" href="/assets/plugin.html-B0-NBt0c.js" as="script"><link rel="prefetch" href="/assets/resource.html-CsnToyoH.js" as="script"><link rel="prefetch" href="/assets/index.html-g-jaJKkF.js" as="script"><link rel="prefetch" href="/assets/agreement.html-BY7Ztw2p.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-CajGilgY.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-CTcLnkNb.js" as="script"><link rel="prefetch" href="/assets/index.html-dEEyv6j0.js" as="script"><link rel="prefetch" href="/assets/config.html-CLmhJ8nB.js" as="script"><link rel="prefetch" href="/assets/exception.html-ZoJotBj1.js" as="script"><link rel="prefetch" href="/assets/log.html-CoXRjF_d.js" as="script"><link rel="prefetch" href="/assets/utils.html-BI44V38D.js" as="script"><link rel="prefetch" href="/assets/index.html-81eZ47um.js" as="script"><link rel="prefetch" href="/assets/config.html-BIx1RhzY.js" as="script"><link rel="prefetch" href="/assets/fandq.html-YES61shu.js" as="script"><link rel="prefetch" href="/assets/install.html-DmZw8FNx.js" as="script"><link rel="prefetch" href="/assets/index.html-CY9_vol5.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-wP1x3-tY.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-D2gM6vLg.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-BCcTVmTk.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-DhnovMOo.js" as="script"><link rel="prefetch" href="/assets/index.html-2OM7nJQU.js" as="script"><link rel="prefetch" href="/assets/plugin.html-CjlYfBAH.js" as="script"><link rel="prefetch" href="/assets/resource.html-H1_EAJOT.js" as="script"><link rel="prefetch" href="/assets/index.html-CPTl-N-a.js" as="script"><link rel="prefetch" href="/assets/agreement.html-BGnFQRlr.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-8M8m8aff.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-sKuVML_Q.js" as="script"><link rel="prefetch" href="/assets/index.html-BlcPKI_5.js" as="script"><link rel="prefetch" href="/assets/lifespan.html-BzX05ZW-.js" as="script"><link rel="prefetch" href="/assets/index.html-B94bKkp5.js" as="script"><link rel="prefetch" href="/assets/channel.html-Chz-exYI.js" as="script"><link rel="prefetch" href="/assets/event.html-_0zPI7GY.js" as="script"><link rel="prefetch" href="/assets/storage.html-CESZxtb0.js" as="script"><link rel="prefetch" href="/assets/index.html-DBdQbIrj.js" as="script"><link rel="prefetch" href="/assets/manager.html-DwXk__kq.js" as="script"><link rel="prefetch" href="/assets/index.html-CaQFG1mm.js" as="script"><link rel="prefetch" href="/assets/observer.html-0PCmzkq0.js" as="script"><link rel="prefetch" href="/assets/plugin.html-f0rc6yDY.js" as="script"><link rel="prefetch" href="/assets/index.html-Cpvj1C08.js" as="script"><link rel="prefetch" href="/assets/manager.html-BExsDzgj.js" as="script"><link rel="prefetch" href="/assets/model.html-64BMosUK.js" as="script"><link rel="prefetch" href="/assets/index.html-C9LZZ0tS.js" as="script"><link rel="prefetch" href="/assets/config.html-yG22ZQgb.js" as="script"><link rel="prefetch" href="/assets/exception.html-C2TaPotZ.
|
2024-08-19 09:56:38 +08:00
|
|
|
</head>
|
|
|
|
|
<body>
|
2024-08-19 10:23:10 +08:00
|
|
|
<div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">跳至主要內容</a><!--]--><div class="theme-container has-toc"><!--[--><header id="navbar" class="vp-navbar"><div class="vp-navbar-start"><button type="button" class="vp-toggle-sidebar-button" title="Toggle Sidebar"><span class="icon"></span></button><!--[--><!----><!--]--><!--[--><a class="route-link vp-brand" href="/"><img class="vp-nav-logo" src="https://cdn.liteyuki.icu/static/img/liteyuki_icon_640.png" alt><!----><span class="vp-site-name hide-in-pad">LiteyukiBot 轻雪机器人</span></a><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-center"><!--[--><!----><!--]--><!--[--><nav class="vp-nav-links"><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/" aria-label="首页"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>首页<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/deploy/" aria-label="安装及部署"><!---->安装及部署<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/usage/" aria-label="使用及功能"><!---->使用及功能<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/store/" aria-label="资源及插件"><!---->资源及插件<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link active" href="/dev/" aria-label="开发及贡献"><!---->开发及贡献<!----></a></div></nav><!--]--><!--[--><!----><!--]--></div><div class="vp-navbar-end"><!--[--><!----><!--]--><!--[--><div class="nav-item"><div class="dropdown-wrapper i18n-dropdown"><button type="button" class="dropdown-title" aria-label="选择语言"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon i18n-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="i18n icon" style="width:1rem;height:1rem;vertical-align:middle;"><path d="M379.392 460.8 494.08 575.488l-42.496 102.4L307.2 532.48 138.24 701.44l-71.68-72.704L234.496 460.8l-45.056-45.056c-27.136-27.136-51.2-66.56-66.56-108.544h112.64c7.68 14.336 16.896 27.136 26.112 35.84l45.568 46.08 45.056-45.056C382.976 312.32 409.6 247.808 409.6 204.8H0V102.4h256V0h102.4v102.4h256v102.4H512c0 70.144-37.888 161.28-87.04 210.944L378.88 460.8zM576 870.4 512 1024H409.6l256-614.4H768l256 614.4H921.6l-64-153.6H576zM618.496 768h196.608L716.8 532.48 618.496 768z"></path></svg><!--]--><span class="arrow"></span><ul class="nav-dropdown"><li class="dropdown-item"><a class="route-link nav-link active" href="/dev/api/plugin/load.html" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link" href="/en/" aria-label="English"><!---->English<!----></a></li></ul></button></div></div><div class="nav-item vp-repo"><a class="vp-repo-link" href="https://github.com/LiteyukiStudio/LiteyukiBot" target="_blank" rel="noopener noreferrer" aria-label="GitHub"><svg xmlns="http://www.w3.org/2000/svg" class="icon github-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="github icon" style="width:1.25rem;height:1.25rem;vertical-align:middle;"><path d="M511.957 21.333C241.024 21.333 21.333 240.981 21.333 512c0 216.832 140.544 400.725 335.574 465.664 24.49 4.395 32.256-10.07 32.256-23.083 0-11.69.256-44.245 0-85.205-136.448 29.61-164.736-64.64-164.736-64.64-22.315-56.704-54.4-71.765-54.4-71.765-44.587-30.464 3.285-29.824 3.285-29.824 49.195 3.413 75.179 50.517 75.179 50.517 43.776 75.008 114.816 53.333 142.762 40.79 4.523-31.66 17.152-53.377 31.19-65.537-108.971-12.458-223.488-54.485-223.488-242.602 0-53.547 19.114-97.323 50.517-131.67-5.035-12.33-21.93-62.293 4.779-129.834 0 0 41.258-13.184 134.912 50.346a469.803 469.803 0 0 1 122.88-16.554c41.642.213 83.626 5.632 122.88 16.554 93.653-63.488 134.784-50.346 134.784-50.346 26.752 67.541 9.898 117.504 4.864 129.834 31.402 34.347 50.474 78.123 50.474 131.67 0 188.586-114.73 230.016-224.042 242.09 17.578 15.232 33.578 44.672 33.578 90.454v135.85c0 13.142 7.936 27.606 32.854
|
2024-08-19 09:56:38 +08:00
|
|
|
|
|
|
|
|
或插件路径 `pathlib.Path(path/to/your/plugin)`
|
|
|
|
|
</code></pre><h3 id="def-load-plugins-set-plugin" tabindex="-1"><a class="header-anchor" href="#def-load-plugins-set-plugin"><span><em><strong>def</strong></em> <code>load_plugins() -> set[Plugin]</code></span></a></h3><p>导入文件夹下多个插件</p><p>参数:</p><pre><code>plugin_dir: 文件夹路径
|
|
|
|
|
|
|
|
|
|
ignore_warning: 是否忽略警告，通常是目录不存在或目录为空
|
|
|
|
|
</code></pre><h3 id="def-format-display-name-display-name-str-plugin-type-plugintype-str" tabindex="-1"><a class="header-anchor" href="#def-format-display-name-display-name-str-plugin-type-plugintype-str"><span><em><strong>def</strong></em> <code>format_display_name(display_name: str, plugin_type: PluginType) -> str</code></span></a></h3><p>设置插件名称颜色，根据不同类型插件设置颜色</p><p>Args:</p><pre><code>display_name: 插件名称
|
|
|
|
|
|
|
|
|
|
plugin_type: 插件类型
|
|
|
|
|
</code></pre><p>Returns:</p><pre><code>str: 设置后的插件名称 <y>name</y>
|
2024-08-19 10:23:10 +08:00
|
|
|
</code></pre><h3 id="var-module-path-path-to-module-name-path-module-path-if-isinstance-module-path-path-else-module-path" tabindex="-1"><a class="header-anchor" href="#var-module-path-path-to-module-name-path-module-path-if-isinstance-module-path-path-else-module-path"><span><em><strong>var</strong></em> <code>module_path = path_to_module_name(Path(module_path)) if isinstance(module_path, Path) else module_path</code></span></a></h3><h3 id="var-plugins-set" tabindex="-1"><a class="header-anchor" href="#var-plugins-set"><span><em><strong>var</strong></em> <code>plugins = set()</code></span></a></h3><h3 id="var-color-y" tabindex="-1"><a class="header-anchor" href="#var-color-y"><span><em><strong>var</strong></em> <code>color = 'y'</code></span></a></h3><h3 id="var-module-import-module-module-path" tabindex="-1"><a class="header-anchor" href="#var-module-import-module-module-path"><span><em><strong>var</strong></em> <code>module = import_module(module_path)</code></span></a></h3><h3 id="var-display-name-module-name-split-1" tabindex="-1"><a class="header-anchor" href="#var-display-name-module-name-split-1"><span><em><strong>var</strong></em> <code>display_name = module.__name__.split('.')[-1]</code></span></a></h3><h3 id="var-display-name-format-display-name-f-metadata-name-module-name-split-1-metadata-type" tabindex="-1"><a class="header-anchor" href="#var-display-name-format-display-name-f-metadata-name-module-name-split-1-metadata-type"><span><em><strong>var</strong></em> <code>display_name = format_display_name(f"{metadata.name}({module.__name__.split('.')[-1]})", metadata.type)</code></span></a></h3><h3 id="var-path-path-os-path-join-dir-path-f" tabindex="-1"><a class="header-anchor" href="#var-path-path-os-path-join-dir-path-f"><span><em><strong>var</strong></em> <code>path = Path(os.path.join(dir_path, f))</code></span></a></h3><h3 id="var-module-name-none" tabindex="-1"><a class="header-anchor" href="#var-module-name-none"><span><em><strong>var</strong></em> <code>module_name = None</code></span></a></h3><h3 id="var-color-m" tabindex="-1"><a class="header-anchor" href="#var-color-m"><span><em><strong>var</strong></em> <code>color = 'm'</code></span></a></h3><h3 id="var-color-g" tabindex="-1"><a class="header-anchor" href="#var-color-g"><span><em><strong>var</strong></em> <code>color = 'g'</code></span></a></h3><h3 id="var-color-e" tabindex="-1"><a class="header-anchor" href="#var-color-e"><span><em><strong>var</strong></em> <code>color = 'e'</code></span></a></h3><h3 id="var-color-c" tabindex="-1"><a class="header-anchor" href="#var-color-c"><span><em><strong>var</strong></em> <code>color = 'c'</code></span></a></h3><h3 id="var-module-name-f-path-to-module-name-path-dir-path-f-3" tabindex="-1"><a class="header-anchor" href="#var-module-name-f-path-to-module-name-path-dir-path-f-3"><span><em><strong>var</strong></em> <code>module_name = f'{path_to_module_name(Path(dir_path))}.{f[:-3]}'</code></span></a></h3><h3 id="var-module-name-path-to-module-name-path" tabindex="-1"><a class="header-anchor" href="#var-module-name-path-to-module-name-path"><span><em><strong>var</strong></em> <code>module_name = path_to_module_name(path)</code></span></a></h3></div><!--[--><!----><!--]--><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/LiteyukiStudio/LiteyukiBot/edit/main/docs/dev/api/plugin/load.md" rel="noopener noreferrer" target="_blank" aria-label="在 GitHub 上编辑" class="nav-link label"><!--[--><svg xmlns="http://www.w3.org/2000/svg" class="icon edit-icon" viewBox="0 0 1024 1024" fill="currentColor" aria-label="edit icon"><path d="M430.818 653.65a60.46 60.46 0 0 1-50.96-93.281l71.69-114.012 7.773-10.365L816.038 80.138A60.46 60.46 0 0 1 859.225 62a60.46 60.46 0 0 1 43.186 18.138l43.186 43.186a60.46 60.46 0 0 1 0 86.373L588.879 565.55l-8.637 8.637-117.466 68.234a60.46 60.46 0 0 1-31.958 11.229z"></path><path d="M728.802 962H252.891A190.883 190.883 0 0 1 62.008 771.98V296.934a190.883 190.883 0 0 1 190.883-192.61
|
|
|
|
|
<script type="module" src="/assets/app-ClSKFI0Z.js" defer></script>
|
2024-08-19 09:56:38 +08:00
|
|
|
</body>
|
|
|
|
|
</html>
|
