45 lines
85 KiB
HTML
Raw Normal View History

<!DOCTYPE html>
<html lang="zh-Hans" dir="ltr">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<title>utils | 小棉智能</title>
<meta name="description" content="可爱,智能且易扩展">
<meta name="generator" content="VitePress v1.6.3">
<link rel="preload stylesheet" href="/assets/style.BUX0sJO8.css" as="style">
<link rel="preload stylesheet" href="/vp-icons.css" as="style">
<script type="module" src="/assets/app.Bp4HFj8X.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.C6meSkt5.js">
<link rel="modulepreload" href="/assets/chunks/framework.BHrE6nLq.js">
<link rel="modulepreload" href="/assets/dev_api_plugin_func_call_utils.md.CxQqE_UY.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-23d7ee04><!--[--><!--]--><!--[--><span tabindex="-1" data-v-21500cc4></span><a href="#VPContent" class="VPSkipLink visually-hidden" data-v-21500cc4>Skip to content</a><!--]--><!----><header class="VPNav" data-v-23d7ee04 data-v-fbfa125b><div class="VPNavBar" data-v-fbfa125b data-v-6aee6108><div class="wrapper" data-v-6aee6108><div class="container" data-v-6aee6108><div class="title" data-v-6aee6108><div class="VPNavBarTitle has-sidebar" data-v-6aee6108 data-v-05d55397><a class="title" href="/" data-v-05d55397><!--[--><!--]--><!--[--><!--[--><!--[--><img class="VPImage dark logo" src="/marsho-full.svg" alt="Marsho Logo" data-v-9ebe201e><!--]--><!--[--><img class="VPImage light logo" src="/marsho-full.svg" alt="Marsho Logo" data-v-9ebe201e><!--]--><!--]--><!--]--><span data-v-05d55397>小棉智能</span><!--[--><!--]--></a></div></div><div class="content" data-v-6aee6108><div class="content-body" data-v-6aee6108><!--[--><!--]--><div class="VPNavBarSearch search" data-v-6aee6108><!----></div><nav aria-labelledby="main-nav-aria-label" class="VPNavBarMenu menu" data-v-6aee6108 data-v-30adaf87><span id="main-nav-aria-label" class="visually-hidden" data-v-30adaf87> Main Navigation </span><!--[--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/" tabindex="0" data-v-30adaf87 data-v-bae6b1fb><!--[--><span data-v-bae6b1fb></span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/start/use" tabindex="0" data-v-30adaf87 data-v-bae6b1fb><!--[--><span data-v-bae6b1fb>使用</span><!--]--></a><!--]--><!--[--><a class="VPLink link VPNavBarMenuLink" href="/dev/extension" tabindex="0" data-v-30adaf87 data-v-bae6b1fb><!--[--><span data-v-bae6b1fb>开发</span><!--]--></a><!--]--><!--]--></nav><div class="VPFlyout VPNavBarTranslations translations" data-v-6aee6108 data-v-ef89c5a6 data-v-361e1e3d><button type="button" class="button" aria-haspopup="true" aria-expanded="false" aria-label="语言" data-v-361e1e3d><span class="text" data-v-361e1e3d><span class="vpi-languages option-icon" data-v-361e1e3d></span><!----><span class="vpi-chevron-down text-icon" data-v-361e1e3d></span></span></button><div class="menu" data-v-361e1e3d><div class="VPMenu" data-v-361e1e3d data-v-3cb383e8><!----><!--[--><!--[--><div class="items" data-v-ef89c5a6><p class="title" data-v-ef89c5a6>简体中文</p><!--[--><div class="VPMenuLink" data-v-ef89c5a6 data-v-e719711c><a class="VPLink link" href="/en/dev/api/plugin/func_call/utils" data-v-e719711c><!--[--><span data-v-e719711c>English</span><!--]--></a></div><div class="VPMenuLink" data-v-ef89c5a6 data-v-e719711c><a class="VPLink link" href="/ja/dev/api/plugin/func_call/utils" data-v-e719711c><!--[--><span data-v-e719711c>日本語</span><!--]--></a></div><!--]--></div><!--]--><!--]--></div></div></div><div class="VPNavBarAppearance appearance" data-v-6aee6108 data-v-696d2565><button class="VPSwitch VPSwitchAppearance" type="button" role="switch" title aria-checked="false" data-v-696d2565 data-v-a2db82bb data-v-34d58b3a><span class="check" data-v-34d58b3a><span class="icon" data-v-34d58b3a><!--[--><span class="vpi-sun sun" data-v-a2db82bb></span><span class="vpi-moon moon" data-v-a2db82bb></span><!--]--></span></span></button></div><div class="VPSocialLinks VPNavBarSocialLinks social-links" data-v-6aee6108 data-v-8a15bdfe data-v-4736dec0><!--[--><a class="VPSocialLink no-icon" href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai" aria-label="github" target="_blank" rel="noopener" data-v-4736dec0 data-v-2c86eb22><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-4736dec0 data-v-2c86eb22><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
<span class="line"></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> decorator</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(wrapper: Callable[</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">...</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, Any]) -&gt; F:</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> @wraps</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(func)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> wrapped</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;">args: Any, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">kwargs: Any) -&gt; Any:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> wrapper(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">args, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">kwargs)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> wrapped</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> decorator</span></span></code></pre></div></details><hr><h3 id="func-async-wrap-func-f-f" tabindex="-1"><em><strong>func</strong></em> <code>async_wrap(func: F) -&gt; F</code> <a class="header-anchor" href="#func-async-wrap-func-f-f" aria-label="Permalink to &quot;***func*** `async_wrap(func: F) -&gt; F`&quot;"></a></h3><p><strong>说明</strong>: 装饰器,将同步函数包装为异步函数</p><p><strong>参数</strong>:</p><blockquote><ul><li>func (F): 函数对象</li></ul></blockquote><p><strong>返回</strong>: F: 包装后的函数对象</p><details><summary><b>源代码</b><a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/func_call/utils.py#L21" target="_blank">在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;"> async_wrap</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(func: F) -&gt; F:</span></span>
<span class="line"></span>
<span class="line"><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> @wraps</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(func)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> async</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> def</span><span style="--shiki-light:#6F42C1;--shiki-dark:#B392F0;"> wrapper</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;">args: Any, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">kwargs: Any) -&gt; Any:</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> func(</span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">*</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">args, </span><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;">**</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">kwargs)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> wrapper</span></span></code></pre></div></details><hr><h3 id="func-is-coroutine-callable-call-callable-any-bool" tabindex="-1"><em><strong>func</strong></em> <code>is_coroutine_callable(call: Callable[..., Any]) -&gt; bool</code> <a class="header-anchor" href="#func-is-coroutine-callable-call-callable-any-bool" aria-label="Permalink to &quot;***func*** `is_coroutine_callable(call: Callable[..., Any]) -&gt; bool`&quot;"></a></h3><p><strong>说明</strong>: 判断是否为async def 函数 请注意:是否为 async def 函数与该函数是否能被await调用是两个不同的概念具体取决于函数返回值是否为awaitable对象</p><p><strong>参数</strong>:</p><blockquote><ul><li>call: 可调用对象</li></ul></blockquote><p><strong>返回</strong>: bool: 是否为async def函数</p><details><summary><b>源代码</b><a href="https://github.com/LiteyukiStudio/nonebot-plugin-marshoai/tree/main/nonebot_plugin_marshoai/plugin/func_call/utils.py#L38" target="_blank">在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;"> is_coroutine_callable</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">(call: Callable[</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">...</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;">, Any]) -&gt; </span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;">bool</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;"> inspect.isroutine(call):</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> inspect.iscoroutinefunction(call)</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> if</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> inspect.isclass(call):</span></span>
<span class="line"><span style="--shiki-light:#D73A49;--shiki-dark:#F97583;"> return</span><span style="--shiki-light:#005CC5;--shiki-dark:#79B8FF;"> False</span></span>
<span class="line"><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> func_ </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;">(call, </span><span style="--shiki-light:#032F62;--shiki-dark:#9ECBFF;">&#39;__call__&#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;"> return</span><span style="--shiki-light:#24292E;--shiki-dark:#E1E4E8;"> inspect.iscoroutinefunction(func_)</span></span></code></pre></div></details></div></div></main><footer class="VPDocFooter" data-v-32bb7f8a data-v-44e7d4c7><!--[--><!--]--><div class="edit-info" data-v-44e7d4c7><div class="edit-link" data-v-44e7d4c7><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/func_call/utils.py" target="_blank" rel="noreferrer" data-v-44e7d4c7><!--[--><span class="vpi-square-pen edit-link-icon" data-v-44e7d4c7></span> 编辑此页面<!--]--></a></div><!----></div><nav class="prev-next" aria-labelledby="doc-footer-aria-label" data-v-44e7d4c7><span class="visually-hidden" id="doc-footer-aria-label" data-v-44e7d4c7>Pager</span><div class="pager" data-v-44e7d4c7><a class="VPLink link pager-link prev" href="/dev/api/plugin/func_call/params" data-v-44e7d4c7><!--[--><span class="desc" data-v-44e7d4c7>上一页</span><span class="title" data-v-44e7d4c7>params</span><!--]--></a></div><div class="pager" data-v-44e7d4c7><a class="VPLink link pager-link next" href="/dev/api/plugin/" data-v-44e7d4c7><!--[--><span class="desc" data-v-44e7d4c7>下一页</span><span class="title" data-v-44e7d4c7>index</span><!--]--></a></div></nav></footer><!--[--><!--]--></div></div></div><!--[--><!--]--></div></div><footer class="VPFooter has-sidebar" data-v-23d7ee04 data-v-d6b1477e><div class="container" data-v-d6b1477e><p class="message" data-v-d6b1477e>文档完善中,欢迎提出建议或帮助我们完善。</p><p class="copyright" data-v-d6b1477e>© 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__types.md\":\"CgOiMYMZ\",\"dev_api_azure.md\":\"DPJgwg8P\",\"dev_api_azure_onebot.md\":\"OVmcnTui\",\"dev_api_config.md\":\"BL6AjucY\",\"dev_api_constants.md\":\"K2d7ohdJ\",\"dev_api_deal_latex.md\":\"DYNtcuK_\",\"dev_api_dev.md\":\"FSvshTef\",\"dev_api_hooks.md\":\"DTgZabuU\",\"dev_api_hunyuan.md\":\"C1ztLhev\",\"dev_api_index.md\":\"B0Yjlet9\",\"dev_api_instances.md\":\"DfMepUbm\",\"dev_api_marsho.md\":\"L-LTDTep\",\"dev_api_marsho_onebot.md\":\"JI-lvr2Y\",\"dev_api_metadata.md\":\"BgfxA14H\",\"dev_api_models.md\":\"Dgl6b3ux\",\"dev_api_observer.md\":\"CslEjxMR\",\"dev_api_plugin_func_call_caller.md\":\"CV6kWP-6\",\"dev_api_plugin_func_call_index.md\":\"BQV-nBxm\",\"dev_api_plugin_func_call_models.md\":\"CCaC8tIO\",\"dev_api_plugin_func_call_params.md\":\"N15YOQUa\",\"dev_api_plugin_func_call_utils.md\":\"CxQqE_UY\",\"dev_api_plugin_index.md\":\"B5gscFMg\",\"dev_api_plugin_load.md\":\"BuTXRdYG\",\"dev_api_plugin_models.md\":\"CRg2e9mi\",\"dev_api_plugin_register.md\":\"CWy7Efmw\",\"dev_api_plugin_typing.md\":\"ED6DxNxp\",\"dev_api_plugin_utils.md\":\"CMRm7O6G\",\"dev_api_plugins_builtin_tools_chat.md\":\"Byv2Ieqq\",\"dev_api_plugins_builtin_tools_file_io.md\":\"qi0ak0S_\",\"dev_api_plugins_builtin_tools_index.md\":\"QukByUQe\",\"dev_api_plugins_builtin_tools_liteyuki.md\":\"B2dl2snu\",\"dev_api_plugins_builtin_tools_manager.md\":\"CW5zMdvA\",\"dev_api_plugins_builtin_tools_network.md\":\"BQ5u3O_-\",\"dev_api_plugins_builtin_tools_utils.md\":\"B8l7Rdq0\",\"dev_api_plugins_marshoai_bangumi_index.md\":\"Bd6lX9M1\",\"dev_api_plugins_marshoai_basic_index.md\":\"y96rWv2R\",\"dev_api_plugins_test_marshoai_basic_index.md\":\"BDwBdbmP\",\"dev_api_plugins_test_marshoai_memory_command.md\":\"Ck-8fzsk\",\"dev_api_plugins_test_marshoai_memory_config.md\":\"CYfIFd1g\",\"dev_api_plugins_test_marshoai_memory_index.md\":\"YNF8wwbB\",\"dev_api_plugins_test_random_number_generator.md\":\"Bhm_PCcb\",\"dev_api_plugins_test_snowykami_testplugin_index.md\":\"ZPIhgmyb\",\"dev_api_plugins_test_weather_demo.md\":\"Cru2Wqm2\",\"dev_api_plugins_twisuki_megakits_index.md\":\"DI9EWXBB\",\"dev_api_plugins_twisuki_megakits_mk_morse_code.md\":\"Ckf6K2zJ\",\"dev_api_plugins_twisuki_megakits_mk_nya_code.md\":\"Dg4Xk3vT\",\"dev_api_plugins_twisuki_petcat_index.md\":\"OD_VNHjo\",\"dev_api_plugins_twisuki_petcat_pc_cat.md\":\"DPsq6lkr\",\"dev_api_plugins_twisuki_petcat_pc_info.md\":\"Cid9KYlk\",\"dev_api_plugins_twisuki_petcat_pc_shop.md\":\"CeGneF_E\",\"dev_api_plugins_twisuki_petcat_pc_token.md\":\"Dl6fF-Fl\",\"dev_api_tools_marshoai_bangumi_index.md\":\"54ZNYO7i\",\"dev_api_tools_marshoai_basic_index.md\":\"D9RqUnI7\",\"dev_api_tools_marshoai_megakits_index.md\":\"C9JIo3LD\",\"dev_api_tools_marshoai_megakits_mk_common.md\":\"dbgBkVzE\",\"dev_api_tools_marshoai_megakits_mk_info.md\":\"CV2ibMr4\",\"dev_api_tools_marshoai_megakits_mk_morse_code.md\":\"C6nZUyZx\",\"dev_api_tools_marshoai_megakits_mk_nya_code.md\":\"C4AhLxOY\",\"dev_api_tools_marshoai_memory_index.md\":\"04ymiQ_Y\",\"dev_api_tools_marshoai_meogirl_index.md\":\"CQZUPWOH\",\"dev_api_tools_marshoai_meogirl_mg_info.md\":\"Cmx92fUz\",\"dev_api_tools_marshoai_meogirl_mg_introduce.md\":\"BY2MSErZ\",\"dev_api_tools_marshoai_meogirl_mg_search.md\":\"OQfOKEE-\",\"dev_api_tools_wip_marshoai_memory_index.md\":\"DLvDor_0\",\"dev_api_util.md\":\"BoVxHh2V\",\"dev_api_util_hunyuan.md\":\"bYo_q2cQ\",\"dev_extension.md\":\"Bhz7x0yK\",\"dev_index.md\":\"B2ime91x\",\"dev_project.md\":\"DTSYxirJ\",\"en_dev_api__types.md\":\"DWAbmlXN\",\"en_dev_api_azure.md\":\"BRFCz--d\",\"en_dev_api_azure_onebot.md\":\"C1azZVkH\",\"en_dev_api_config.md\":\"DzdtCZJu\",\"en_dev_api_constants.md\":\"DVu3-9PZ\",\"en_dev_api_deal_latex.md\":\"Cz8Ud9U7\",\"en_dev_api_dev.md\":\"rulEzEXH\",\"en_dev_api_hooks.md\":\"B_8Va9iz\",\"en_dev_api_hunyuan.md\":\"BiAoOoo-\",\"en_dev_api_index.md\":\"CJCOqopE\",\"en_dev_api_instances.md\":\"GECgDQdP\",\"en_dev_api_marsho.md\":\"CGng-_y2\",\"en_dev_api_marsho_onebot.md\":\"5-9v490h\",\"en_dev_api_metadata.md\":\"CxYPXPjI\",\"en_dev_api_mo
</body>
</html>