1
0
forked from bot/app
LiteyukiBot/en/dev/api/utils.html

48 lines
32 KiB
HTML
Raw Normal View History

<!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/utils.html"><meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/en/dev/api/utils.html"><meta property="og:site_name" content="LiteyukiBot"><meta property="og:title" content="liteyuki.utils"><meta property="og:description" content="def is_coroutine_callable(call: Callable[..., Any]) -> bool 判断是否为协程可调用对象 Args: Returns: def run_coroutine() -> None 运行协程 Args: Returns: def path_to_module_name(path: Path) -> st..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:locale:alternate" content="zh-CN"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"liteyuki.utils","image":[""],"dateModified":null,"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.utils | LiteyukiBot</title><meta name="description" content="def is_coroutine_callable(call: Callable[..., Any]) -> bool 判断是否为协程可调用对象 Args: Returns: def run_coroutine() -> None 运行协程 Args: Returns: def path_to_module_name(path: Path) -> st...">
<link rel="preload" href="/assets/style-CSEr-Ojo.css" as="style"><link rel="stylesheet" href="/assets/style-CSEr-Ojo.css">
<link rel="modulepreload" href="/assets/app-Bs1PeMf0.js"><link rel="modulepreload" href="/assets/utils.html-kScX1Uhd.js">
<link rel="prefetch" href="/assets/index.html-CXXO6xcH.js" as="script"><link rel="prefetch" href="/assets/index.html-DrSFzvRf.js" as="script"><link rel="prefetch" href="/assets/config.html-jXXfcHdL.js" as="script"><link rel="prefetch" href="/assets/fandq.html-CZwFx6EP.js" as="script"><link rel="prefetch" href="/assets/install.html-Byj8VUg-.js" as="script"><link rel="prefetch" href="/assets/index.html-ljg_PI1R.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-DH1VjFpJ.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-RUDtzk1B.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-Dzb4NNEu.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-CT4UraRi.js" as="script"><link rel="prefetch" href="/assets/index.html-BG-OTJ01.js" as="script"><link rel="prefetch" href="/assets/index.html-DayvyYmV.js" as="script"><link rel="prefetch" href="/assets/plugin.html-DYl5C-yG.js" as="script"><link rel="prefetch" href="/assets/resource.html-w4v4-ls4.js" as="script"><link rel="prefetch" href="/assets/index.html-C-5_z4Ql.js" as="script"><link rel="prefetch" href="/assets/agreement.html-DTrW--oO.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-CLFR4-SL.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-ByptD_MK.js" as="script"><link rel="prefetch" href="/assets/index.html-X4AQiuCY.js" as="script"><link rel="prefetch" href="/assets/config.html-x2DggEEz.js" as="script"><link rel="prefetch" href="/assets/exception.html-BnPs2xtp.js" as="script"><link rel="prefetch" href="/assets/log.html-B6ne9LQi.js" as="script"><link rel="prefetch" href="/assets/mkdoc.html-DvuxL8et.js" as="script"><link rel="prefetch" href="/assets/utils.html-DIGgwcLa.js" as="script"><link rel="prefetch" href="/assets/index.html-DSmJ2m9V.js" as="script"><link rel="prefetch" href="/assets/config.html-JHrVObO1.js" as="script"><link rel="prefetch" href="/assets/fandq.html-DwSlEl9h.js" as="script"><link rel="prefetch" href="/assets/install.html-T5JrtwZR.js" as="script"><link rel="prefetch" href="/assets/index.html-CcKUYTsl.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-Dffo7Ipz.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-C1z3XK3f.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-CwQDqgqg.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-hzjN8h_W.js" as="script"><link rel="prefetch" href="/assets/index.html-CydeTHZa.js" as="script"><link rel="prefetch" href="/assets/plugin.html-OrnCCBoS.js" as="script"><link rel="prefetch" href="/assets/resource.html-B-5sMHx4.js" as="script"><link rel="prefetch" href="/assets/index.html-jXobCw6I.js" as="script"><link rel="prefetch" href="/assets/agreement.html-DgwwyIXl.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-Djt1jsoL.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-CqZWearh.js" as="script"><link rel="prefetch" href="/assets/index.html-BNS6aWZs.js" as="script"><link rel="prefetch" href="/assets/lifespan.html-BThnlarw.js" as="script"><link rel="prefetch" href="/assets/index.html-D9A3PrLB.js" as="script"><link rel="prefetch" href="/assets/channel.html-CJlHQUyq.js" as="script"><link rel="prefetch" href="/assets/event.html-CYw2tPLX.js" as="script"><link rel="prefetch" href="/assets/storage.html-C3Od2hbX.js" as="script"><link rel="prefetch" href="/assets/index.html-Bom3tjBi.js" as="script"><link rel="prefetch" href="/assets/manager.html-BV5ldr2L.js" as="script"><link rel="prefetch" href="/assets/index.html-LtkmrGu9.js" as="script"><link rel="prefetch" href="/assets/observer.html-C7rFMFl-.js" as="script"><link rel="prefetch" href="/assets/plugin.html-BBrieOL3.js" as="script"><link rel="prefetch" href="/assets/index.html-JDKOSGWq.js" as="script"><link rel="prefetch" href="/assets/event.html-ChvlMQKp.js" as="script"><link rel="prefetch" href="/assets/matcher.html-BlyTwki1.js" as="script"><link rel="prefetch" href="/assets/on.html-BsRFg2Z3.js" as="script"><link rel="prefetch" href="/assets/rule.html-zZdLdX_D.js" as="s
</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/utils.html" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link active" href="/en/dev/api/utils.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 728.747 1002
</code></pre><p>Returns:</p><pre><code>bool: 是否为协程可调用对象
</code></pre><h3 id="def-run-coroutine-none" tabindex="-1"><a class="header-anchor" href="#def-run-coroutine-none"><span><em><strong>def</strong></em> <code>run_coroutine() -&gt; None</code></span></a></h3><p>运行协程</p><p>Args:</p><pre><code>coro:
</code></pre><p>Returns:</p><h3 id="def-path-to-module-name-path-path-str" tabindex="-1"><a class="header-anchor" href="#def-path-to-module-name-path-path-str"><span><em><strong>def</strong></em> <code>path_to_module_name(path: Path) -&gt; str</code></span></a></h3><p>转换路径为模块名</p><p>Args:</p><pre><code>path: 路径a/b/c/d -&gt; a.b.c.d
</code></pre><p>Returns:</p><pre><code>str: 模块名
</code></pre><h3 id="def-async-wrapper-func-callable-any-callable-coroutine" tabindex="-1"><a class="header-anchor" href="#def-async-wrapper-func-callable-any-callable-coroutine"><span><em><strong>def</strong></em> <code>async_wrapper(func: Callable[..., Any]) -&gt; Callable[..., Coroutine]</code></span></a></h3><p>异步包装器</p><p>Args:</p><pre><code>func: Sync Callable
</code></pre><p>Returns:</p><pre><code>Coroutine: Asynchronous Callable
</code></pre><h3 id="async-def-wrapper-none" tabindex="-1"><a class="header-anchor" href="#async-def-wrapper-none"><span><em><strong>async def</strong></em> <code>wrapper() -&gt; None</code></span></a></h3><h3 id="var-is-main-process-multiprocessing-current-process-name-mainprocess" tabindex="-1"><a class="header-anchor" href="#var-is-main-process-multiprocessing-current-process-name-mainprocess"><span><em><strong>var</strong></em> <code>IS_MAIN_PROCESS = multiprocessing.current_process().name == &#39;MainProcess&#39;</code></span></a></h3><h3 id="var-func-getattr-call-call-none" tabindex="-1"><a class="header-anchor" href="#var-func-getattr-call-call-none"><span><em><strong>var</strong></em> <code>func_ = getattr(call, &#39;__call__&#39;, None)</code></span></a></h3><h3 id="var-rel-path-path-resolve-relative-to-path-cwd-resolve" tabindex="-1"><a class="header-anchor" href="#var-rel-path-path-resolve-relative-to-path-cwd-resolve"><span><em><strong>var</strong></em> <code>rel_path = path.resolve().relative_to(Path.cwd().resolve())</code></span></a></h3><h3 id="var-loop-asyncio-get-event-loop" tabindex="-1"><a class="header-anchor" href="#var-loop-asyncio-get-event-loop"><span><em><strong>var</strong></em> <code>loop = asyncio.get_event_loop()</code></span></a></h3><h3 id="var-loop-asyncio-new-event-loop" tabindex="-1"><a class="header-anchor" href="#var-loop-asyncio-new-event-loop"><span><em><strong>var</strong></em> <code>loop = asyncio.new_event_loop()</code></span></a></h3></div><!--[--><!----><!--]--><footer class="page-meta"><div class="meta-item edit-link"><a href="https://github.com/LiteyukiStudio/LiteyukiBot/edit/main/docs/en/dev/api/utils.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></footer><nav class="vp-page-nav"><a class="route-link nav-link prev" href="/en/dev/api/mkdoc.html" aria-label="liteyuki.mkdoc"><div class="hint"><span class="arrow start"></span>Prev</div><div class="link"><span class="font-icon icon fa-fw fa-sm fas fa-laptop-code" style=""></span>liteyuki.mkdoc</div></a><!----></nav><div id="vp-comment" class="giscus-wrapper input-top" style="display:block;"><svg xmlns="http://www.w3.org/2000/svg" width="32" height="32" preserveAspectRatio="xMidYMid" viewBox="0 0 100 100"><circle cx="28" cy="75" r="11" fill="currentColor"><animate attributeName="fill-opacity" begin="0s" dur="1s" keyTimes="0;0.2;1" repeatCount="indefinite" values="0;1;1"></animate></circle><path fill="none" stroke="#88baf0" stroke-width="10" d="M28 47a28 28 0 0 1 28 28"><animate attributeName="stroke-opacity" begin="0.1s" dur="1s" keyTimes="0;0.2;1" repeatCount="indefinite" values
<script type="module" src="/assets/app-Bs1PeMf0.js" defer></script>
</body>
</html>