forked from LiteyukiStudio/LiteyukiBot
126 lines
56 KiB
HTML
126 lines
56 KiB
HTML
|
<!doctype html>
|
||
|
|
<html lang="en-US" 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>
|
||
|
|
<link rel="alternate" hreflang="zh-cn" href="https://vuepress-theme-hope-docs-demo.netlify.app/dev/api/plugin/load.html"><meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/en/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="func load_plugin() -> Optional[Plugin] Description: 加载单个插件，可以是本地插件或是通过 pip 安装的插件。 Arguments: module_path: 插件名称 path.to.your.plugin 或插件路径 pathlib.Path(path/to/your/plugin): Sourc..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><meta property="og:updated_time" content="2024-08-29T06:19:39.000Z"><meta property="article:modified_time" content="2024-08-29T06:19:39.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"liteyuki.plugin.load","image":[""],"dateModified":"2024-08-29T06:19:39.000Z","author":[]}</script><script src="/js/en/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="func load_plugin() -> Optional[Plugin] Description: 加载单个插件，可以是本地插件或是通过 pip 安装的插件。 Arguments: module_path: 插件名称 path.to.your.plugin 或插件路径 pathlib.Path(path/to/your/plugin): Sourc...">
|
||
|
|
<link rel="preload" href="/assets/style-DI-mIFA3.css" as="style"><link rel="stylesheet" href="/assets/style-DI-mIFA3.css">
|
||
|
|
<link rel="modulepreload" href="/assets/app-BrSLFMno.js"><link rel="modulepreload" href="/assets/load.html-vqWYNnZD.js">
|
||
|
|
<link rel="prefetch" href="/assets/index.html-BRc-ukbu.js" as="script"><link rel="prefetch" href="/assets/index.html-B-QdpVk5.js" as="script"><link rel="prefetch" href="/assets/config.html-ByfkC6Sl.js" as="script"><link rel="prefetch" href="/assets/fandq.html-7BZ61hoO.js" as="script"><link rel="prefetch" href="/assets/install.html-C_5Msb8F.js" as="script"><link rel="prefetch" href="/assets/index.html-habFrhH_.js" as="script"><link rel="prefetch" href="/assets/index.html-yIsCMHYS.js" as="script"><link rel="prefetch" href="/assets/plugin.html-BE5Stkqz.js" as="script"><link rel="prefetch" href="/assets/resource.html-CiN4V672.js" as="script"><link rel="prefetch" href="/assets/index.html-BRSjr-CT.js" as="script"><link rel="prefetch" href="/assets/agreement.html-Ctx1Z0Nq.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-BArpTagj.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-JK7tEY7a.js" as="script"><link rel="prefetch" href="/assets/index.html-Sy0xA2-G.js" as="script"><link rel="prefetch" href="/assets/config.html-rUrfuUTG.js" as="script"><link rel="prefetch" href="/assets/exception.html-BnMRnhOq.js" as="script"><link rel="prefetch" href="/assets/log.html-ijRoOnbZ.js" as="script"><link rel="prefetch" href="/assets/mkdoc.html-CG6LDCeo.js" as="script"><link rel="prefetch" href="/assets/utils.html-Q6-Mrika.js" as="script"><link rel="prefetch" href="/assets/index.html-DpUXQlmv.js" as="script"><link rel="prefetch" href="/assets/config.html-XHk4vEe0.js" as="script"><link rel="prefetch" href="/assets/fandq.html-BphTKjC9.js" as="script"><link rel="prefetch" href="/assets/install.html-Cad8_mGy.js" as="script"><link rel="prefetch" href="/assets/index.html-ZiwDHybC.js" as="script"><link rel="prefetch" href="/assets/plugin.html-CIC_1RY6.js" as="script"><link rel="prefetch" href="/assets/resource.html-Q4zta0Sr.js" as="script"><link rel="prefetch" href="/assets/index.html-BASShJ1u.js" as="script"><link rel="prefetch" href="/assets/agreement.html-BiMBIuCT.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-CYt_Nh-e.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-BcOX-uML.js" as="script"><link rel="prefetch" href="/assets/index.html-C3m77Uzg.js" as="script"><link rel="prefetch" href="/assets/lifespan.html-3kuTaopj.js" as="script"><link rel="prefetch" href="/assets/index.html-DNrrGxqU.js" as="script"><link rel="prefetch" href="/assets/channel.html-By64tR4I.js" as="script"><link rel="prefetch" href="/assets/event.html-zozUf_lW.js" as="script"><link rel="prefetch" href="/assets/rpc.html-Cfscbe41.js" as="script"><link rel="prefetch" href="/assets/socks_channel.html-DoHrrRtF.js" as="script"><link rel="prefetch" href="/assets/storage.html-BQEAivlT.js" as="script"><link rel="prefetch" href="/assets/index.html-DPX5wxdH.js" as="script"><link rel="prefetch" href="/assets/manager.html-BpcEpo2N.js" as="script"><link rel="prefetch" href="/assets/index.html-CsezkkBR.js" as="script"><link rel="prefetch" href="/assets/observer.html-zaG_pHdW.js" as="script"><link rel="prefetch" href="/assets/plugin.html-CaVvzmwh.js" as="script"><link rel="prefetch" href="/assets/index.html-Dw3Pr99_.js" as="script"><link rel="prefetch" href="/assets/event.html-8XKJd3mq.js" as="script"><link rel="prefetch" href="/assets/matcher.html-BFJiZVNs.js" as="script"><link rel="prefetch" href="/assets/on.html-PtYPC2bP.js" as="script"><link rel="prefetch" href="/assets/rule.html-BBoLsCYj.js" as="script"><link rel="prefetch" href="/assets/session.html-TSjJpQ-A.js" as="script"><link rel="prefetch" href="/assets/index.html-GKGMh9vl.js" as="script"><link rel="prefetch" href="/assets/load.html-CwKJDbQ9.js" as="script"><link rel="prefetch" href="/assets/manager.html-Diwvbx67.js" as="script"><link rel="prefetch" href="/assets/model.html-DQYsOBev.js" as="script"><link rel="prefetch" href="/assets/liteecho.html-DfpcNzmX.js" as="script"><link rel="prefetch" href="/assets/index.html-CXehtI66.js" as="script"><link rel="prefetch" href="/assets/config.html-BGAqlTL9.js" as="script"><link rel="prefetch" href="/assets
|
||
|
|
</head>
|
||
|
|
<body>
|
||
|
|
<div id="app"><!--[--><!--[--><!--[--><span tabindex="-1"></span><a href="#main-content" class="vp-skip-link sr-only">Skip to main content</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="/en/"><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="/en/" aria-label="Home"><span class="font-icon icon fa-fw fa-sm fas fa-home" style=""></span>Home<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/deploy/" aria-label="Deploy"><!---->Deploy<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/usage/" aria-label="Usage"><!---->Usage<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link" href="/en/store/" aria-label="Extensions"><!---->Extensions<!----></a></div><div class="nav-item hide-in-mobile"><a class="route-link nav-link active" href="/en/dev/" aria-label="Contribute"><!---->Contribute<!----></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="Select language"><!--[--><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" href="/dev/api/plugin/load.html" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link active" href="/en/dev/api/plugin/load.html" 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 22.87C862.25 912.597 1002.667
|
||
|
|
<span class="token triple-quoted-string string">"""加载单个插件，可以是本地插件或是通过 `pip` 安装的插件。
|
||
|
|
|
||
|
|
参数:
|
||
|
|
module_path: 插件名称 `path.to.your.plugin`
|
||
|
|
或插件路径 `pathlib.Path(path/to/your/plugin)`
|
||
|
|
"""</span>
|
||
|
|
module_path <span class="token operator">=</span> path_to_module_name<span class="token punctuation">(</span>Path<span class="token punctuation">(</span>module_path<span class="token punctuation">)</span><span class="token punctuation">)</span> <span class="token keyword">if</span> <span class="token builtin">isinstance</span><span class="token punctuation">(</span>module_path<span class="token punctuation">,</span> Path<span class="token punctuation">)</span> <span class="token keyword">else</span> module_path
|
||
|
|
<span class="token keyword">try</span><span class="token punctuation">:</span>
|
||
|
|
module <span class="token operator">=</span> import_module<span class="token punctuation">(</span>module_path<span class="token punctuation">)</span>
|
||
|
|
_plugins<span class="token punctuation">[</span>module<span class="token punctuation">.</span>__name__<span class="token punctuation">]</span> <span class="token operator">=</span> Plugin<span class="token punctuation">(</span>name<span class="token operator">=</span>module<span class="token punctuation">.</span>__name__<span class="token punctuation">,</span> module<span class="token operator">=</span>module<span class="token punctuation">,</span> module_name<span class="token operator">=</span>module_path<span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">if</span> module<span class="token punctuation">.</span>__dict__<span class="token punctuation">.</span>get<span class="token punctuation">(</span><span class="token string">'__plugin_metadata__'</span><span class="token punctuation">,</span> <span class="token boolean">None</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
metadata<span class="token punctuation">:</span> <span class="token string">'PluginMetadata'</span> <span class="token operator">=</span> module<span class="token punctuation">.</span>__dict__<span class="token punctuation">[</span><span class="token string">'__plugin_metadata__'</span><span class="token punctuation">]</span>
|
||
|
|
display_name <span class="token operator">=</span> module<span class="token punctuation">.</span>__name__<span class="token punctuation">.</span>split<span class="token punctuation">(</span><span class="token string">'.'</span><span class="token punctuation">)</span><span class="token punctuation">[</span><span class="token operator">-</span><span class="token number">1</span><span class="token punctuation">]</span>
|
||
|
|
<span class="token keyword">elif</span> module<span class="token punctuation">.</span>__dict__<span class="token punctuation">.</span>get<span class="token punctuation">(</span><span class="token string">'__liteyuki_plugin_meta__'</span><span class="token punctuation">,</span> <span class="token boolean">None</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
metadata<span class="token punctuation">:</span> <span class="token string">'PluginMetadata'</span> <span class="token operator">=</span> module<span class="token punctuation">.</span>__dict__<span class="token punctuation">[</span><span class="token string">'__liteyuki_plugin_meta__'</span><span class="token punctuation">]</span>
|
||
|
|
display_name <span class="token operator">=</span> format_display_name<span class="token punctuation">(</span><span class="token string-interpolation"><span class="token string">f"</span><span class="token interpolation"><span class="token punctuation">{</span>metadata<span class="token punctuation">.</span>name<span class="token punctuation">}</span></span><span class="token string">(</span><span class="token interpolation"><span class="token punctuation">{</span>module<span class="token punctuation">.</span>__name__<span class="token punctuation">.</span>split<span class="token punctuation">(</span><span class="token string">'.'</span><span class="token punctuation">)</span><span class="token punctuation">[</span><span class="token operator">-</span><span class="token number">1</span><span class="token punctuation">]</span><span class="token punctuation">}</span></span><span class="token string">)"</span></span><span class="token punctuation">,</span> metadata<span class="token punctuation">.</span><span class="token builtin">type</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">elif</span> module<span class="token punctuation">.</span>__dict__<span class="token punctuation">.</span>get<span class="token punctuation">(</span><span class="token string">'__plugin_meta__'</span><span class="token punctuation">,</span> <span class="token boolean">None</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
metadata<span class="token punctuation">:</span> <span class="token string">'PluginMetadata'</span> <span class="token operator">=</span> module<span class="token punctuation">.</span>__dict__<span class="token punctuation">[</span><span class="token string">'__plugin_meta__'</span><span class="token punctuation">]</span>
|
||
|
|
display_name <span class="token operator">=</span> format_display_name<span class="token punctuation">(</span><span class="token string-interpolation"><span class="token string">f"</span><span class="token interpolation"><span class="token punctuation">{</span>metadata<span class="token punctuation">.</span>name<span class="token punctuation">}</span></span><span class="token string">(</span><span class="token interpolation"><span class="token punctuation">{</span>module<span class="token punctuation">.</span>__name__<span class="token punctuation">.</span>split<span class="token punctuation">(</span><span class="token string">'.'</span><span class="token punctuation">)</span><span class="token punctuation">[</span><span class="token operator">-</span><span class="token number">1</span><span class="token punctuation">]</span><span class="token punctuation">}</span></span><span class="token string">)"</span></span><span class="token punctuation">,</span> metadata<span class="token punctuation">.</span><span class="token builtin">type</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">else</span><span class="token punctuation">:</span>
|
||
|
|
logger<span class="token punctuation">.</span>opt<span class="token punctuation">(</span>colors<span class="token operator">=</span><span class="token boolean">True</span><span class="token punctuation">)</span><span class="token punctuation">.</span>warning<span class="token punctuation">(</span><span class="token string-interpolation"><span class="token string">f'The metadata of Liteyuki plugin "</span><span class="token interpolation"><span class="token punctuation">{</span>module<span class="token punctuation">.</span>__name__<span class="token punctuation">}</span></span><span class="token string">" is not specified, use empty.'</span></span><span class="token punctuation">)</span>
|
||
|
|
metadata <span class="token operator">=</span> PluginMetadata<span class="token punctuation">(</span>name<span class="token operator">=</span>module<span class="token punctuation">.</span>__name__<span class="token punctuation">)</span>
|
||
|
|
display_name <span class="token operator">=</span> module<span class="token punctuation">.</span>__name__<span class="token punctuation">.</span>split<span class="token punctuation">(</span><span class="token string">'.'</span><span class="token punctuation">)</span><span class="token punctuation">[</span><span class="token operator">-</span><span class="token number">1</span><span class="token punctuation">]</span>
|
||
|
|
_plugins<span class="token punctuation">[</span>module<span class="token punctuation">.</span>__name__<span class="token punctuation">]</span><span class="token punctuation">.</span>metadata <span class="token operator">=</span> metadata
|
||
|
|
logger<span class="token punctuation">.</span>opt<span class="token punctuation">(</span>colors<span class="token operator">=</span><span class="token boolean">True</span><span class="token punctuation">)</span><span class="token punctuation">.</span>success<span class="token punctuation">(</span><span class="token string-interpolation"><span class="token string">f'Succeeded to load liteyuki plugin "</span><span class="token interpolation"><span class="token punctuation">{</span>display_name<span class="token punctuation">}</span></span><span class="token string">"'</span></span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">return</span> _plugins<span class="token punctuation">[</span>module<span class="token punctuation">.</span>__name__<span class="token punctuation">]</span>
|
||
|
|
<span class="token keyword">except</span> Exception <span class="token keyword">as</span> e<span class="token punctuation">:</span>
|
||
|
|
logger<span class="token punctuation">.</span>opt<span class="token punctuation">(</span>colors<span class="token operator">=</span><span class="token boolean">True</span><span class="token punctuation">)</span><span class="token punctuation">.</span>success<span class="token punctuation">(</span><span class="token string-interpolation"><span class="token string">f'Failed to load liteyuki plugin "<r></span><span class="token interpolation"><span class="token punctuation">{</span>module_path<span class="token punctuation">}</span></span><span class="token string"></r>"'</span></span><span class="token punctuation">)</span>
|
||
|
|
traceback<span class="token punctuation">.</span>print_exc<span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token boolean">None</span>
|
||
|
|
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></details><h3 id="func-load-plugins-ignore-warning-bool-true-set-plugin" tabindex="-1"><a class="header-anchor" href="#func-load-plugins-ignore-warning-bool-true-set-plugin"><span><em>func</em> <code>load_plugins(*, ignore_warning: bool = True) -> set[Plugin]</code></span></a></h3><p><strong>Description</strong>: 导入文件夹下多个插件</p><p><strong>Arguments</strong>:</p><blockquote><ul><li>plugin_dir: 文件夹路径</li><li>ignore_warning: 是否忽略警告，通常是目录不存在或目录为空</li></ul></blockquote><details><summary><b>Source code</b></summary><div class="language-python line-numbers-mode" data-ext="py" data-title="py"><pre class="language-python"><code><span class="token keyword">def</span> <span class="token function">load_plugins</span><span class="token punctuation">(</span><span class="token operator">*</span>plugin_dir<span class="token punctuation">:</span> <span class="token builtin">str</span><span class="token punctuation">,</span> ignore_warning<span class="token punctuation">:</span> <span class="token builtin">bool</span><span class="token operator">=</span><span class="token boolean">True</span><span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span> <span class="token builtin">set</span><span class="token punctuation">[</span>Plugin<span class="token punctuation">]</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token triple-quoted-string string">"""导入文件夹下多个插件
|
||
|
|
|
||
|
|
参数:
|
||
|
|
plugin_dir: 文件夹路径
|
||
|
|
ignore_warning: 是否忽略警告，通常是目录不存在或目录为空
|
||
|
|
"""</span>
|
||
|
|
plugins <span class="token operator">=</span> <span class="token builtin">set</span><span class="token punctuation">(</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">for</span> dir_path <span class="token keyword">in</span> plugin_dir<span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">if</span> <span class="token keyword">not</span> os<span class="token punctuation">.</span>path<span class="token punctuation">.</span>exists<span class="token punctuation">(</span>dir_path<span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">if</span> <span class="token keyword">not</span> ignore_warning<span class="token punctuation">:</span>
|
||
|
|
logger<span class="token punctuation">.</span>warning<span class="token punctuation">(</span><span class="token string-interpolation"><span class="token string">f"Plugins dir '</span><span class="token interpolation"><span class="token punctuation">{</span>dir_path<span class="token punctuation">}</span></span><span class="token string">' does not exist."</span></span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">continue</span>
|
||
|
|
<span class="token keyword">if</span> <span class="token keyword">not</span> os<span class="token punctuation">.</span>listdir<span class="token punctuation">(</span>dir_path<span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">if</span> <span class="token keyword">not</span> ignore_warning<span class="token punctuation">:</span>
|
||
|
|
logger<span class="token punctuation">.</span>warning<span class="token punctuation">(</span><span class="token string-interpolation"><span class="token string">f"Plugins dir '</span><span class="token interpolation"><span class="token punctuation">{</span>dir_path<span class="token punctuation">}</span></span><span class="token string">' is empty."</span></span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">continue</span>
|
||
|
|
<span class="token keyword">if</span> <span class="token keyword">not</span> os<span class="token punctuation">.</span>path<span class="token punctuation">.</span>isdir<span class="token punctuation">(</span>dir_path<span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">if</span> <span class="token keyword">not</span> ignore_warning<span class="token punctuation">:</span>
|
||
|
|
logger<span class="token punctuation">.</span>warning<span class="token punctuation">(</span><span class="token string-interpolation"><span class="token string">f"Plugins dir '</span><span class="token interpolation"><span class="token punctuation">{</span>dir_path<span class="token punctuation">}</span></span><span class="token string">' is not a directory."</span></span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">continue</span>
|
||
|
|
<span class="token keyword">for</span> f <span class="token keyword">in</span> os<span class="token punctuation">.</span>listdir<span class="token punctuation">(</span>dir_path<span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
path <span class="token operator">=</span> Path<span class="token punctuation">(</span>os<span class="token punctuation">.</span>path<span class="token punctuation">.</span>join<span class="token punctuation">(</span>dir_path<span class="token punctuation">,</span> f<span class="token punctuation">)</span><span class="token punctuation">)</span>
|
||
|
|
module_name <span class="token operator">=</span> <span class="token boolean">None</span>
|
||
|
|
<span class="token keyword">if</span> os<span class="token punctuation">.</span>path<span class="token punctuation">.</span>isfile<span class="token punctuation">(</span>path<span class="token punctuation">)</span> <span class="token keyword">and</span> f<span class="token punctuation">.</span>endswith<span class="token punctuation">(</span><span class="token string">'.py'</span><span class="token punctuation">)</span> <span class="token keyword">and</span> <span class="token punctuation">(</span>f <span class="token operator">!=</span> <span class="token string">'__init__.py'</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
module_name <span class="token operator">=</span> <span class="token string-interpolation"><span class="token string">f'</span><span class="token interpolation"><span class="token punctuation">{</span>path_to_module_name<span class="token punctuation">(</span>Path<span class="token punctuation">(</span>dir_path<span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">}</span></span><span class="token string">.</span><span class="token interpolation"><span class="token punctuation">{</span>f<span class="token punctuation">[</span><span class="token punctuation">:</span><span class="token format-spec">-3]</span><span class="token punctuation">}</span></span><span class="token string">'</span></span>
|
||
|
|
<span class="token keyword">elif</span> os<span class="token punctuation">.</span>path<span class="token punctuation">.</span>isdir<span class="token punctuation">(</span>path<span class="token punctuation">)</span> <span class="token keyword">and</span> os<span class="token punctuation">.</span>path<span class="token punctuation">.</span>exists<span class="token punctuation">(</span>os<span class="token punctuation">.</span>path<span class="token punctuation">.</span>join<span class="token punctuation">(</span>path<span class="token punctuation">,</span> <span class="token string">'__init__.py'</span><span class="token punctuation">)</span><span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
module_name <span class="token operator">=</span> path_to_module_name<span class="token punctuation">(</span>path<span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">if</span> module_name<span class="token punctuation">:</span>
|
||
|
|
load_plugin<span class="token punctuation">(</span>module_name<span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">if</span> _plugins<span class="token punctuation">.</span>get<span class="token punctuation">(</span>module_name<span class="token punctuation">)</span><span class="token punctuation">:</span>
|
||
|
|
plugins<span class="token punctuation">.</span>add<span class="token punctuation">(</span>_plugins<span class="token punctuation">[</span>module_name<span class="token punctuation">]</span><span class="token punctuation">)</span>
|
||
|
|
<span class="token keyword">return</span> plugins
|
||
|
|
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></details><h3 id="func-format-display-name-str" tabindex="-1"><a class="header-anchor" href="#func-format-display-name-str"><span><em>func</em> <code>format_display_name() -> str</code></span></a></h3><p><strong>Description</strong>: 设置插件名称颜色，根据不同类型插件设置颜色</p><p><strong>Arguments</strong>:</p><blockquote><ul><li>display_name: 插件名称</li><li>plugin_type: 插件类型</li></ul></blockquote><p><strong>Return</strong>: str: 设置后的插件名称 <!----></p><details><summary><b>Source code</b></summary><div class="language-python line-numbers-mode" data-ext="py" data-title="py"><pre class="language-python"><code><span class="token keyword">def</span> <span class="token function">format_display_name</span><span class="token punctuation">(</span>display_name<span class="token punctuation">:</span> <span class="token builtin">str</span><span class="token punctuation">,</span> plugin_type<span class="token punctuation">:</span> PluginType<span class="token punctuation">)</span> <span class="token operator">-</span><span class="token operator">></span> <span class="token builtin">str</span><span class="token punctuation">:</span>
|
||
|
|
<span class="token triple-quoted-string string">"""
|
||
|
|
设置插件名称颜色，根据不同类型插件设置颜色
|
||
|
|
Args:
|
||
|
|
display_name: 插件名称
|
||
|
|
plugin_type: 插件类型
|
||
|
|
|
||
|
|
Returns:
|
||
|
|
str: 设置后的插件名称 <y>name</y>
|
||
|
|
"""</span>
|
||
|
|
color <span class="token operator">=</span> <span class="token string">'y'</span>
|
||
|
|
<span class="token keyword">match</span> plugin_type<span class="token punctuation">:</span>
|
||
|
|
<span class="token keyword">case</span> PluginType<span class="token punctuation">.</span>APPLICATION<span class="token punctuation">:</span>
|
||
|
|
color <span class="token operator">=</span> <span class="token string">'m'</span>
|
||
|
|
<span class="token keyword">case</span> PluginType<span class="token punctuation">.</span>TEST<span class="token punctuation">:</span>
|
||
|
|
color <span class="token operator">=</span> <span class="token string">'g'</span>
|
||
|
|
<span class="token keyword">case</span> PluginType<span class="token punctuation">.</span>MODULE<span class="token punctuation">:</span>
|
||
|
|
color <span class="token operator">=</span> <span class="token string">'e'</span>
|
||
|
|
<span class="token keyword">case</span> PluginType<span class="token punctuation">.</span>SERVICE<span class="token punctuation">:</span>
|
||
|
|
color <span class="token operator">=</span> <span class="token string">'c'</span>
|
||
|
|
<span class="token keyword">return</span> <span class="token string-interpolation"><span class="token string">f'<</span><span class="token interpolation"><span class="token punctuation">{</span>color<span class="token punctuation">}</span></span><span class="token string">></span><span class="token interpolation"><span class="token punctuation">{</span>display_name<span class="token punctuation">}</span></span><span class="token string"> [</span><span class="token interpolation"><span class="token punctuation">{</span>plugin_type<span class="token punctuation">.</span>name<span class="token punctuation">}</span></span><span class="token string">]</</span><span class="token interpolation"><span class="token punctuation">{</span>color<span class="token punctuation">}</span></span><span class="token string">>'</span></span>
|
||
|
|
</code></pre><div class="line-numbers" aria-hidden="true"><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div><div class="line-number"></div></div></div></details><h3 id="var-plugins" tabindex="-1"><a class="header-anchor" href="#var-plugins"><span><em><strong>var</strong></em> <code>_plugins = {}</code></span></a></h3><ul><li><strong>Type</strong>: <code>dict[str, Plugin]</code></li></ul><h3 id="var-metadata-module-dict-plugin-metadata" tabindex="-1"><a class="header-anchor" href="#var-metadata-module-dict-plugin-metadata"><span><em><strong>var</strong></em> <code>metadata = module.__dict__['__plugin_metadata__']</code></span></a></h3><ul><li><strong>Type</strong>: <code>'PluginMetadata'</code></li></ul><h3 id="var-metadata-module-dict-liteyuki-plugin-meta" tabindex="-1"><a class="header-anchor" href="#var-metadata-module-dict-liteyuki-plugin-meta"><span><em><strong>var</strong></em> <code>metadata = module.__dict__['__liteyuki_plugin_meta__']</code></span></a></h3><ul><li><strong>Type</strong>: <code>'PluginMetadata'</code></li></ul><h3 id="var-metadata-module-dict-plugin-meta" tabindex="-1"><a class="header-anchor" href="#var-metadata-module-dict-plugin-meta"><span><em><strong>var</strong></em> <code>metadata = module.__dict__['__plugin_meta__']</code></span></a></h3><ul><li><strong>Type</strong>: <code>'PluginMetadata'</code></li></ul></div><!--[--><!----><!--]--><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/LiteyukiStudio/LiteyukiBot/edit/main/docs/en/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.61h267.754a60.46 60.46 0 0 1 0 120.92H252.891a69.962 69.962 0 0 0-69.098 69.099V771.98a69.962 69.962 0 0 0 69.098 69.098h475.911A69.962 69.962 0 0 0 797.9 771.98V503.363a60.46 60.46 0 1 1 120.922 0V771.98A190.883 190.883 0 0 1 728.802 962z"></path></svg><!--]-->在 GitHub 上编辑<span><svg class="external-link-icon" xmlns="http://www.w3.org/2000/svg" aria-hidden="true" focusable="false" x="0px" y="0px" viewBox="0 0 100 100" width="15" height="15"><path fill="currentColor" d="M18.8,85.1h56l0,0c2.2,0,4-1.8,4-4v-32h-8v28h-48v-48h28v-8h-32l0,0c-2.2,0-4,1.8-4,4v56C14.8,83.3,16.6,85.1,18.8,85.1z"></path><polygon fill="currentColor" points="45.7,48.7 51.3,54.3 77.2,28.5 77.2,37.2 85.2,37.2 85.2,14.9 62.8,14.9 62.8,22.9 71.5,22.9"></polygon></svg><span class="external-link-icon-sr-only">open in new window</span></span><!----></a></div><div class="meta-item git-info"><div class="update-time"><span class="label">Last update: </span><!----></div><div class="contributors"><span class="label">Contributors: </span><!--[--><!--[--><span class="contributor" title="email: snowykami@outlook.com">snowy</span><!--]--><!--]--></div></div></footer><nav class="vp-page-nav"><a class="route-link nav-link active prev" href="/en/dev/api/plugin/" aria-label="liteyuki.plugin"><div class="hint"><span class="arr
|
||
|
|
<script type="module" src="/assets/app-BrSLFMno.js" defer></script>
|
||
|
|
</body>
|
||
|
|
</html>
|