75 lines
104 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="en-US" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>load | Marsho AI</title>
<meta name="description" content="Kawaii, Intelligent and Easy to Extend">
<meta name="generator" content="VitePress v1.6.3">
<link rel="preload stylesheet" href="/assets/style.3fMz-wjd.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
<script type="module" src="/assets/app.DB2-4pOg.js"></script>
<link rel="preload" href="/assets/inter-roman-latin.Di8DUHzh.woff2" as="font" type="font/woff2" crossorigin="">
<link rel="modulepreload" href="/assets/chunks/theme.B1VGcao-.js">
<link rel="modulepreload" href="/assets/chunks/framework.CTVYQtO4.js">
<link rel="modulepreload" href="/assets/en_dev_api_plugin_load.md.YI3IFDft.lean.js">
<link rel="icon" type="image/x-icon" href="/favicon.ico">
<script id="check-dark-mode">(()=>{const e=localStorage.getItem("vitepress-theme-appearance")||"auto",a=window.matchMedia("(prefers-color-scheme: dark)").matches;(!e||e==="auto"?a:e==="dark")&&document.documentElement.classList.add("dark")})();</script>
<script id="check-mac-os">document.documentElement.classList.toggle("mac",/Mac|iPhone|iPod|iPad/i.test(navigator.platform));</script>
</head>
<body>
<div id="app"><div class="Layout" data-v-f2ef7826><!--[--><!--]--><!--[--><span tabindex="-1" data-v-81e21773></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-81e21773>Skip to content</a><!--]--><!----><header class="VPNav" data-v-f2ef7826 data-v-438f8bce><div class="VPNavBar" data-v-438f8bce data-v-7997f19d><div class="wrapper" data-v-7997f19d><div class="container" data-v-7997f19d><div class="title" data-v-7997f19d><div class="VPNavBarTitle has-sidebar" data-v-7997f19d data-v-8f2b86e4><a class="title" href="/en/" data-v-8f2b86e4><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/marsho-full.svg" alt="Marsho Logo" data-v-b5ae02ee><!--]--><!--[--><img class="VPImage light logo" src="/marsho-full.svg" alt="Marsho Logo" data-v-b5ae02ee><!--]--><!--]--><!--]--><span data-v-8f2b86e4>Marsho AI</span><!--[--><!--]--></a></div></div><div class="content" data-v-7997f19d><div class="content-body" data-v-7997f19d><!--[--><!--]--><div class="VPNavBarSearch search" data-v-7997f19d><!----></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-7997f19d data-v-ec41fe23><span id="main-nav-aria-label" class="visually-hidden" data-v-ec41fe23> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en" tabindex="0" data-v-ec41fe23 data-v-711b3800><!--[--><span data-v-711b3800>Home</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/start/install" tabindex="0" data-v-ec41fe23 data-v-711b3800><!--[--><span data-v-711b3800>Usage</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/en/dev/extension" tabindex="0" data-v-ec41fe23 data-v-711b3800><!--[--><span data-v-711b3800>Develop</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-7997f19d data-v-e4f4561d data-v-7089f475><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="Language" data-v-7089f475><span class="text" data-v-7089f475><span class="vpi-languages option-icon" data-v-7089f475></span><!----><span class="vpi-chevron-down text-icon" data-v-7089f475></span></span></button><div class="menu" data-v-7089f475><div class="VPMenu" data-v-7089f475 data-v-30cc7172><!----><!--[--><!--[--><div class="items" data-v-e4f4561d><p class="title" data-v-e4f4561d>English</p><!--[--><div class="VPMenuLink" data-v-e4f4561d data-v-acd6ccb4><a class="VPLink link" href="/dev/api/plugin/load" data-v-acd6ccb4><!--[--><span data-v-acd6ccb4>简体中文</span><!--]--></a></div><div class="VPMenuLink" data-v-e4f4561d data-v-acd6ccb4><a class="VPLink link" href="/ja/dev/api/plugin/load" data-v-acd6ccb4><!--[--><span data-v-acd6ccb4>日本語</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-7997f19d data-v-7f088f89><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-7f088f89 data-v-aedb97ac data-v-4cf15231><span class="check" data-v-4cf15231><span class="icon" data-v-4cf15231><!--[--><span class="vpi-sun sun" data-v-aedb97ac></span><span class="vpi-moon moon" data-v-aedb97ac></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-7997f19d data-v-b364c366 data-v-605e17f0><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai" aria-label="github" target="_blank" rel="noopener" data-v-605e17f0 data-v-bff34bab><span class="vpi-social-github"></span></a><a class="VPSocialLink no-icon" href="https://git.liteyuki.icu/LiteyukiStudio/nonebot-plugin-marshoai" aria-label target="_blank" rel="noopener" data-v-605e17f0 data-v-bff34bab><svg t="1725391346807" class="icon" viewBox="0 0 1025 1024" version="1.1" xmlns="http://www.w3.org/2000/svg" p-id="5067" width="256" height="256"><path d="M1004.692673 466.396616l-447.094409-447.073929c-25.743103-25.763582-67.501405-25.763582-93.264987 0l-103.873521 103.873521 78.171378 78.171378c12.533635-6.00058 2
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> _plugins.get(name)</span></span></code></pre></div></details><hr><h3 id="func-get-plugins-dict-str-plugin" tabindex="-1"><em><strong>func</strong></em> <code>get_plugins() -&gt; dict[str, Plugin]</code> <a class="header-anchor" href="#func-get-plugins-dict-str-plugin" aria-label="Permalink to &quot;***func*** `get_plugins() -&gt; dict[str, Plugin]`&quot;"></a></h3><p><strong>Description</strong>: 获取所有插件</p><p><strong>Return</strong>: dict[str, Plugin]: 插件集合</p><details><summary><b>Source code</b> or <a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/load.py#L39" target="_blank">View on GitHub</a></summary><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> get_plugins</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">() -&gt; dict[</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, Plugin]:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> _plugins</span></span></code></pre></div></details><hr><h3 id="func-load-plugin-module-path-str-path-allow-reload-bool-false-optional-plugin" tabindex="-1"><em><strong>func</strong></em> <code>load_plugin(module_path: str | Path, allow_reload: bool = False) -&gt; Optional[Plugin]</code> <a class="header-anchor" href="#func-load-plugin-module-path-str-path-allow-reload-bool-false-optional-plugin" aria-label="Permalink to &quot;***func*** `load_plugin(module_path: str | Path, allow_reload: bool = False) -&gt; Optional[Plugin]`&quot;"></a></h3><p><strong>Description</strong>: 加载单个插件,可以是本地插件或是通过 <code>pip</code> 安装的插件。 该函数产生的副作用在于将插件加载到 <code>_plugins</code> 中。</p><p><strong>Arguments</strong>:</p><blockquote><ul><li>module_path: 插件名称 <code>path.to.your.plugin</code></li><li>或插件路径 <code>pathlib.Path(path/to/your/plugin)</code>:</li></ul></blockquote><p><strong>Return</strong>: Optional[Plugin]: 插件对象</p><details><summary><b>Source code</b> or <a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/load.py#L48" target="_blank">View on GitHub</a></summary><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> load_plugin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(module_path: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> |</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> Path, allow_reload: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">bool</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">False</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) -&gt; Optional[Plugin]:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> module_path </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> path_to_module_name(Path(module_path)) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">if</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> isinstance</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(module_path, Path) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">else</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> module_path</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> try</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> module </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> import_module(module_path)</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> Plugin(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">name</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">module.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">__name__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">.split(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;.&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)[</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">1</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">], </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">module</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">module, </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">module_name</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">module_path, </span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">module_path</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">module.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">__file__</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin.name </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> _plugins </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">and</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">not</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> allow_reload):</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> raise</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> ValueError</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;插件名称重复: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">plugin.name</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> else</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> _plugins[plugin.name] </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin.metadata </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> getattr</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(module, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;__marsho_meta__&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">None</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin.metadata </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">is</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> None</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> logger.opt(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">colors</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">True</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).warning(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;成功加载小棉插件 &lt;y&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">plugin.name</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&lt;/y&gt;, 但是没有定义元数据&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> else</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> logger.opt(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">colors</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">True</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).success(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;成功加载小棉插件 &lt;c&gt;&quot;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">plugin.metadata.name</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&quot;&lt;/c&gt;&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> except</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> Exception</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> as</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> e:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> logger.opt(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">colors</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">True</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).success(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;加载小棉插件失败 &quot;&lt;r&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">module_path</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&lt;/r&gt;&quot;&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> traceback.print_exc()</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> None</span></span></code></pre></div></details><hr><h3 id="func-load-plugins-plugin-dirs-str-set-plugin" tabindex="-1"><em><strong>func</strong></em> <code>load_plugins(*plugin_dirs: str) -&gt; set[Plugin]</code> <a class="header-anchor" href="#func-load-plugins-plugin-dirs-str-set-plugin" aria-label="Permalink to &quot;***func*** `load_plugins(*plugin_dirs: str) -&gt; set[Plugin]`&quot;"></a></h3><p><strong>Description</strong>: 导入文件夹下多个插件</p><p><strong>Arguments</strong>:</p><blockquote><ul><li>plugin_dir: 文件夹路径</li><li>ignore_warning: 是否忽略警告,通常是目录不存在或目录为空</li></ul></blockquote><p><strong>Return</strong>: set[Plugin]: 插件集合</p><details><summary><b>Source code</b> or <a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/load.py#L97" target="_blank">View on GitHub</a></summary><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> load_plugins</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">plugin_dirs: </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">str</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">) -&gt; set[Plugin]:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugins </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> set</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">()</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> for</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin_dir </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin_dirs:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> for</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> f </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">in</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> os.listdir(plugin_dir):</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> path </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> Path(os.path.join(plugin_dir, f))</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> module_name </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> None</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> os.path.isfile(path) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">and</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> f.endswith(</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;.py&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">):</span></span>
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;单文件加载&#39;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> module_name </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">path_to_module_name(Path(plugin_dir))</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">.</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">f[:</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">-</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">3</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">]</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> elif</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> os.path.isdir(path) </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">and</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> os.path.exists(os.path.join(path, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;__init__.py&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)):</span></span>
<span class="line"><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;"> &#39;包加载&#39;</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> module_name </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> path_to_module_name(path)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> module_name </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">and</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (plugin </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> load_plugin(module_name)):</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugins.add(plugin)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugins</span></span></code></pre></div></details><hr><h3 id="func-reload-plugin-plugin-plugin-optional-plugin" tabindex="-1"><em><strong>func</strong></em> <code>reload_plugin(plugin: Plugin) -&gt; Optional[Plugin]</code> <a class="header-anchor" href="#func-reload-plugin-plugin-plugin-optional-plugin" aria-label="Permalink to &quot;***func*** `reload_plugin(plugin: Plugin) -&gt; Optional[Plugin]`&quot;"></a></h3><p><strong>Description</strong>: 开发模式下的重新加载插件 该方法无法保证没有副作用,因为插件可能会有自己的初始化方法 如果出现异常请重启即可</p><p><strong>Arguments</strong>:</p><blockquote><ul><li>plugin: 插件对象</li></ul></blockquote><p><strong>Return</strong>: Optional[Plugin]: 插件对象</p><details><summary><b>Source code</b> or <a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/load.py#L126" target="_blank">View on GitHub</a></summary><div class="language-python vp-adaptive-theme"><button title="Copy Code" class="copy"></button><span class="lang">python</span><pre class="shiki shiki-themes github-light github-dark vp-code" tabindex="0"><code><span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> reload_plugin</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(plugin: Plugin) -&gt; Optional[Plugin]:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> try</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> plugin.module_path:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> (new_plugin </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">:=</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> load_plugin(plugin.module_name, </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">True</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)):</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> logger.opt(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">colors</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">True</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).debug(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;重新加载插件 &quot;&lt;y&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">new_plugin.name</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&lt;/y&gt;&quot; 成功, 若出现异常或副作用请重启&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> new_plugin</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> else</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> logger.opt(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">colors</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">True</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).error(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;重新加载插件失败 &quot;&lt;r&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">plugin.name</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&lt;/r&gt;&quot;&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> None</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> else</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> logger.opt(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">colors</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">True</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).error(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;插件不支持重载 &quot;&lt;r&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">plugin.name</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&lt;/r&gt;&quot;&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> None</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> except</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> Exception</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> as</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> e:</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> logger.opt(</span><span style="--shiki-light:#E36209;--shiki-dark:#FFAB70;">colors</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">=</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">True</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">).error(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">f</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;重新加载插件失败 &quot;&lt;r&gt;</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">{</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">plugin.name</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">}</span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&lt;/r&gt;&quot;&#39;</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">)</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> traceback.print_exc()</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> None</span></span></code></pre></div></details><h3 id="var-module" tabindex="-1">var <code>module</code> <a class="header-anchor" href="#var-module" aria-label="Permalink to &quot;var `module`&quot;"></a></h3><ul><li><p><strong>Description</strong>: 导入模块对象</p></li><li><p><strong>Default</strong>: <code>import_module(module_path)</code></p></li></ul><h3 id="var-module-name" tabindex="-1">var <code>module_name</code> <a class="header-anchor" href="#var-module-name" aria-label="Permalink to &quot;var `module_name`&quot;"></a></h3><ul><li><p><strong>Description</strong>: 单文件加载</p></li><li><p><strong>Default</strong>: <code>f&#39;{path_to_module_name(Path(plugin_dir))}.{f[:-3]}&#39;</code></p></li></ul><h3 id="var-module-name-1" tabindex="-1">var <code>module_name</code> <a class="header-anchor" href="#var-module-name-1" aria-label="Permalink to &quot;var `module_name`&quot;"></a></h3><ul><li><p><strong>Description</strong>: 包加载</p></li><li><p><strong>Default</strong>: <code>path_to_module_name(path)</code></p></li></ul></div></div></main><footer class="VPDocFooter" data-v-d9ad38ba data-v-abb507f0><!--[--><!--]--><div class="edit-info" data-v-abb507f0><div class="edit-link" data-v-abb507f0><a class="VPLink link vp-external-link-icon no-icon edit-link-button" href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai//plugin/load.py" target="_blank" rel="noreferrer" data-v-abb507f0><!--[--><span class="vpi-square-pen edit-link-icon" data-v-abb507f0></span> Edit this page<!--]--></a></div><div class="last-updated" data-v-abb507f0><p class="VPLastUpdated" data-v-abb507f0 data-v-0a31532b>Last updated: <time datetime="2024-12-14T11:16:59.000Z" data-v-0a31532b></time></p></div></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-abb507f0><span class="visually-hidden" id="doc-footer-aria-label" data-v-abb507f0>Pager</span><div class="pager" data-v-abb507f0><a class="VPLink link pager-link prev" href="/en/dev/api/plugin/" data-v-abb507f0><!--[--><span class="desc" data-v-abb507f0>Prev</span><span class="title" data-v-abb507f0>index</span><!--]--></a></div><div class="pager" data-v-abb507f0><a class="VPLink link pager-link next" href="/en/dev/api/plugin/models" data-v-abb507f0><!--[--><span class="desc" data-v-abb507f0>Next</span><span class="title" data-v-abb507f0>models</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-f2ef7826 data-v-1f3d8ce5><div class="container" data-v-1f3d8ce5><p class="message" data-v-1f3d8ce5>The document is being improved. Suggestions are welcome.</p><p class="copyright" data-v-1f3d8ce5>© 2024 <a href="https://liteyuki.icu" target="_blank">Liteyuki Studio</a></p></div></footer><!--[--><!--]--></div></div>
<script>window.__VP_HASH_MAP__=JSON.parse("{\"dev_api_azure.md\":\"B8-f9FUH\",\"dev_api_azure_onebot.md\":\"AF08dydV\",\"dev_api_config.md\":\"Cfe3T77C\",\"dev_api_constants.md\":\"CzodSzEx\",\"dev_api_deal_latex.md\":\"TC9acXCk\",\"dev_api_dev.md\":\"xtZBfvCK\",\"dev_api_hooks.md\":\"Oex5Osbq\",\"dev_api_hunyuan.md\":\"cwjzNkK4\",\"dev_api_index.md\":\"Cm--m-dj\",\"dev_api_instances.md\":\"DWIbF7zd\",\"dev_api_marsho.md\":\"DWR-5060\",\"dev_api_marsho_onebot.md\":\"CKXlpK6h\",\"dev_api_metadata.md\":\"gXVQsfb6\",\"dev_api_models.md\":\"Cbw0SnoS\",\"dev_api_observer.md\":\"DJa7EQIJ\",\"dev_api_plugin_func_call_caller.md\":\"ChdLIn42\",\"dev_api_plugin_func_call_index.md\":\"BYaO0YMf\",\"dev_api_plugin_func_call_models.md\":\"BqDLHq48\",\"dev_api_plugin_func_call_params.md\":\"5fFv65No\",\"dev_api_plugin_func_call_utils.md\":\"Cc06pgce\",\"dev_api_plugin_index.md\":\"D1cv5Bdt\",\"dev_api_plugin_load.md\":\"BThuue9-\",\"dev_api_plugin_models.md\":\"CMGeDMNV\",\"dev_api_plugin_register.md\":\"BcHWky_t\",\"dev_api_plugin_typing.md\":\"Bvzcc0i7\",\"dev_api_plugin_utils.md\":\"C8C60oh0\",\"dev_api_plugins_builtin_tools_chat.md\":\"EYzBkM7q\",\"dev_api_plugins_builtin_tools_file_io.md\":\"D8stO352\",\"dev_api_plugins_builtin_tools_index.md\":\"BZHQ5NNH\",\"dev_api_plugins_builtin_tools_liteyuki.md\":\"DiKmnkxA\",\"dev_api_plugins_builtin_tools_manager.md\":\"W6867JUV\",\"dev_api_plugins_builtin_tools_network.md\":\"CNUPusyd\",\"dev_api_plugins_builtin_tools_utils.md\":\"DDnRSzzR\",\"dev_api_plugins_marshoai_bangumi_index.md\":\"BLootinZ\",\"dev_api_plugins_marshoai_basic_index.md\":\"mHSCujgc\",\"dev_api_plugins_test_marshoai_basic_index.md\":\"Bi6J7R_z\",\"dev_api_plugins_test_marshoai_memory_command.md\":\"Cw7GmcD9\",\"dev_api_plugins_test_marshoai_memory_config.md\":\"DvFLax41\",\"dev_api_plugins_test_marshoai_memory_index.md\":\"ju9E5a1x\",\"dev_api_plugins_test_random_number_generator.md\":\"CzKwNN4y\",\"dev_api_plugins_test_snowykami_testplugin_index.md\":\"UDPC-Uc5\",\"dev_api_plugins_test_weather_demo.md\":\"-1KDL3oN\",\"dev_api_plugins_twisuki_megakits_index.md\":\"SJwjK6ir\",\"dev_api_plugins_twisuki_megakits_mk_morse_code.md\":\"BigBH96X\",\"dev_api_plugins_twisuki_megakits_mk_nya_code.md\":\"C6N9gA91\",\"dev_api_plugins_twisuki_petcat_index.md\":\"CyrVKk9d\",\"dev_api_plugins_twisuki_petcat_pc_cat.md\":\"Cw1-Jasb\",\"dev_api_plugins_twisuki_petcat_pc_info.md\":\"Hinys1nW\",\"dev_api_plugins_twisuki_petcat_pc_shop.md\":\"B1e0ZSxF\",\"dev_api_plugins_twisuki_petcat_pc_token.md\":\"iG64fH2l\",\"dev_api_tools_marshoai_bangumi_index.md\":\"Duze3TVP\",\"dev_api_tools_marshoai_basic_index.md\":\"BMkA9afb\",\"dev_api_tools_marshoai_megakits_index.md\":\"D48xEWt6\",\"dev_api_tools_marshoai_megakits_mk_common.md\":\"oRuEYCjm\",\"dev_api_tools_marshoai_megakits_mk_info.md\":\"DW5Ec5cn\",\"dev_api_tools_marshoai_megakits_mk_morse_code.md\":\"CmkxAt56\",\"dev_api_tools_marshoai_megakits_mk_nya_code.md\":\"BQAd-_l9\",\"dev_api_tools_marshoai_memory_index.md\":\"9yOjTtrq\",\"dev_api_tools_marshoai_meogirl_index.md\":\"BlcRo3XU\",\"dev_api_tools_marshoai_meogirl_mg_info.md\":\"Cay9kOBk\",\"dev_api_tools_marshoai_meogirl_mg_introduce.md\":\"dL8Yu_O0\",\"dev_api_tools_marshoai_meogirl_mg_search.md\":\"Dr7zV14D\",\"dev_api_tools_wip_marshoai_memory_index.md\":\"C1sn4qQD\",\"dev_api_util.md\":\"bY3K-Z46\",\"dev_api_util_hunyuan.md\":\"BcYu4BNL\",\"dev_extension.md\":\"DfIbM0Ke\",\"dev_index.md\":\"BbZ4wGtm\",\"dev_project.md\":\"CI3gYpYz\",\"en_dev_api_azure.md\":\"DT1uzYnu\",\"en_dev_api_azure_onebot.md\":\"CIa2eHTt\",\"en_dev_api_config.md\":\"DGpQD45h\",\"en_dev_api_constants.md\":\"sXFtrMz7\",\"en_dev_api_deal_latex.md\":\"BU7zmmQG\",\"en_dev_api_dev.md\":\"CIcPV23r\",\"en_dev_api_hooks.md\":\"9nKsutJk\",\"en_dev_api_hunyuan.md\":\"BVjQMbdk\",\"en_dev_api_index.md\":\"DIBcHO1C\",\"en_dev_api_instances.md\":\"Uv5rIROF\",\"en_dev_api_marsho.md\":\"B5cqigWE\",\"en_dev_api_marsho_onebot.md\":\"Cv_1bxx2\",\"en_dev_api_metadata.md\":\"8d7RngMY\",\"en_dev_api_models.md\":\"CMIk6dnq\",\"en_dev_api_observer.md\":\"BwAsqPFr\",\"en_dev_a
</body>
</html>