2024-08-19 09:56:38 +08:00
|
|
|
<!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>
|
|
|
|
|
<meta property="og:url" content="https://vuepress-theme-hope-docs-demo.netlify.app/en/dev/api/liteyuki/config.html"><meta property="og:site_name" content="LiteyukiBot"><meta property="og:title" content="liteyuki.config"><meta property="og:description" content="def flat_config(config: dict[str, Any]) -> dict[str, Any] 扁平化配置文件 {a:{b:{c:1}}} -> Args: Returns: def load_from_yaml(file: str) -> dict[str, Any] Load config from yaml file def ..."><meta property="og:type" content="article"><meta property="og:locale" content="en-US"><meta property="og:updated_time" content="2024-08-19T01:55:47.000Z"><meta property="article:modified_time" content="2024-08-19T01:55:47.000Z"><script type="application/ld+json">{"@context":"https://schema.org","@type":"Article","headline":"liteyuki.config","image":[""],"dateModified":"2024-08-19T01:55:47.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.config | LiteyukiBot</title><meta name="description" content="def flat_config(config: dict[str, Any]) -> dict[str, Any] 扁平化配置文件 {a:{b:{c:1}}} -> Args: Returns: def load_from_yaml(file: str) -> dict[str, Any] Load config from yaml file def ...">
|
|
|
|
|
<link rel="preload" href="/assets/style-CSEr-Ojo.css" as="style"><link rel="stylesheet" href="/assets/style-CSEr-Ojo.css">
|
2024-08-19 10:10:27 +08:00
|
|
|
<link rel="modulepreload" href="/assets/app-CKfb26EU.js"><link rel="modulepreload" href="/assets/config.html-wCqV07ev.js">
|
|
|
|
|
<link rel="prefetch" href="/assets/index.html-BubZg9Uv.js" as="script"><link rel="prefetch" href="/assets/index.html-CxhEpHkw.js" as="script"><link rel="prefetch" href="/assets/config.html-BEXN5_VJ.js" as="script"><link rel="prefetch" href="/assets/fandq.html-COOjylR7.js" as="script"><link rel="prefetch" href="/assets/install.html-B6_SbCRZ.js" as="script"><link rel="prefetch" href="/assets/index.html-CMfRySL3.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-Bryqn3EW.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-DSgy4WVU.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-DTlmmvMs.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-DLd1bzt8.js" as="script"><link rel="prefetch" href="/assets/index.html-ZLc-PO3T.js" as="script"><link rel="prefetch" href="/assets/index.html-B_GHxPs1.js" as="script"><link rel="prefetch" href="/assets/plugin.html-zYA-h964.js" as="script"><link rel="prefetch" href="/assets/resource.html-BOEbkahM.js" as="script"><link rel="prefetch" href="/assets/index.html-BYmhlSs5.js" as="script"><link rel="prefetch" href="/assets/agreement.html-7mg-WluZ.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-B0_OzP82.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-RzmoBUf_.js" as="script"><link rel="prefetch" href="/assets/index.html-mAgAhuA6.js" as="script"><link rel="prefetch" href="/assets/config.html-C8thXtDn.js" as="script"><link rel="prefetch" href="/assets/exception.html-BujEMV4G.js" as="script"><link rel="prefetch" href="/assets/log.html-BGGq3Euq.js" as="script"><link rel="prefetch" href="/assets/utils.html-D5nklI1o.js" as="script"><link rel="prefetch" href="/assets/index.html-CllnfXbH.js" as="script"><link rel="prefetch" href="/assets/config.html-Cia_ovVr.js" as="script"><link rel="prefetch" href="/assets/fandq.html-BMaLTvgQ.js" as="script"><link rel="prefetch" href="/assets/install.html-BPXldHt2.js" as="script"><link rel="prefetch" href="/assets/index.html-DcZ2XVAY.js" as="script"><link rel="prefetch" href="/assets/dev_comm.html-CBcSfbzC.js" as="script"><link rel="prefetch" href="/assets/dev_lyfunc.html-C0NgF9YT.js" as="script"><link rel="prefetch" href="/assets/dev_lyplugin.html-Cupwp2ZC.js" as="script"><link rel="prefetch" href="/assets/dev_resource_pack.html-0555n3Kg.js" as="script"><link rel="prefetch" href="/assets/index.html-DvCjcYjR.js" as="script"><link rel="prefetch" href="/assets/plugin.html-DF8gp5Lg.js" as="script"><link rel="prefetch" href="/assets/resource.html-CIZe4BXQ.js" as="script"><link rel="prefetch" href="/assets/index.html-BUWxuZne.js" as="script"><link rel="prefetch" href="/assets/agreement.html-DbB7vqww.js" as="script"><link rel="prefetch" href="/assets/basic_command.html-BSRfasGb.js" as="script"><link rel="prefetch" href="/assets/extra_command.html-D0pXmCeX.js" as="script"><link rel="prefetch" href="/assets/index.html-pXXCvvRC.js" as="script"><link rel="prefetch" href="/assets/lifespan.html-BjIKK5Jo.js" as="script"><link rel="prefetch" href="/assets/index.html-D2TaZ2qc.js" as="script"><link rel="prefetch" href="/assets/channel.html-BeTc40jc.js" as="script"><link rel="prefetch" href="/assets/event.html-mN8xLaJI.js" as="script"><link rel="prefetch" href="/assets/storage.html-BWAAZZ6R.js" as="script"><link rel="prefetch" href="/assets/index.html-DLxnQnwq.js" as="script"><link rel="prefetch" href="/assets/manager.html-mTlFEiq-.js" as="script"><link rel="prefetch" href="/assets/index.html-BalTgel7.js" as="script"><link rel="prefetch" href="/assets/observer.html-DSQdNcjw.js" as="script"><link rel="prefetch" href="/assets/plugin.html-ebBsLHrD.js" as="script"><link rel="prefetch" href="/assets/index.html-NKwUrl7h.js" as="script"><link rel="prefetch" href="/assets/load.html-Bsm00RJQ.js" as="script"><link rel="prefetch" href="/assets/manager.html-BPr2cqwL.js" as="script"><link rel="prefetch" href="/assets/model.html-BpT1UodT.js" as="script"><link rel="prefetch" href="/assets/index.html-C8HSMtN6.js" as="script"><link rel="prefetch" href="/assets/exception.html-Bbj2jnzu.js
|
2024-08-19 09:56:38 +08:00
|
|
|
</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="/" aria-label="简体中文"><!---->简体中文<!----></a></li><li class="dropdown-item"><a class="route-link nav-link active" href="/en/dev/api/liteyuki/config.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.667 512
|
|
|
|
|
</code></pre><p>Returns:</p><pre><code>扁平化后的配置文件，但也包含原有的键值对
|
|
|
|
|
</code></pre><h3 id="def-load-from-yaml-file-str-dict-str-any" tabindex="-1"><a class="header-anchor" href="#def-load-from-yaml-file-str-dict-str-any"><span><em><strong>def</strong></em> <code>load_from_yaml(file: str) -> dict[str, Any]</code></span></a></h3><p>Load config from yaml file</p><h3 id="def-load-from-json-file-str-dict-str-any" tabindex="-1"><a class="header-anchor" href="#def-load-from-json-file-str-dict-str-any"><span><em><strong>def</strong></em> <code>load_from_json(file: str) -> dict[str, Any]</code></span></a></h3><p>Load config from json file</p><h3 id="def-load-from-toml-file-str-dict-str-any" tabindex="-1"><a class="header-anchor" href="#def-load-from-toml-file-str-dict-str-any"><span><em><strong>def</strong></em> <code>load_from_toml(file: str) -> dict[str, Any]</code></span></a></h3><p>Load config from toml file</p><h3 id="def-load-from-files-dict-str-any" tabindex="-1"><a class="header-anchor" href="#def-load-from-files-dict-str-any"><span><em><strong>def</strong></em> <code>load_from_files() -> dict[str, Any]</code></span></a></h3><p>从指定文件加载配置项，会自动识别文件格式</p><p>默认执行扁平化选项</p><h3 id="def-load-configs-from-dirs-dict-str-any" tabindex="-1"><a class="header-anchor" href="#def-load-configs-from-dirs-dict-str-any"><span><em><strong>def</strong></em> <code>load_configs_from_dirs() -> dict[str, Any]</code></span></a></h3><p>从目录下加载配置文件，不递归</p><p>按照读取文件的优先级反向覆盖</p><p>默认执行扁平化选项</p><h3 id="def-load-config-in-default-no-waring-bool-dict-str-any" tabindex="-1"><a class="header-anchor" href="#def-load-config-in-default-no-waring-bool-dict-str-any"><span><em><strong>def</strong></em> <code>load_config_in_default(no_waring: bool) -> dict[str, Any]</code></span></a></h3><p>从一个标准的轻雪项目加载配置文件</p><p>项目目录下的config.*和config目录下的所有配置文件</p><p>项目目录下的配置文件优先</p><h3 id="class-satorinodeconfig-basemodel" tabindex="-1"><a class="header-anchor" href="#class-satorinodeconfig-basemodel"><span><em><strong>class</strong></em> <code>SatoriNodeConfig(BaseModel)</code></span></a></h3><h3 id="class-satoriconfig-basemodel" tabindex="-1"><a class="header-anchor" href="#class-satoriconfig-basemodel"><span><em><strong>class</strong></em> <code>SatoriConfig(BaseModel)</code></span></a></h3><h3 id="class-basicconfig-basemodel" tabindex="-1"><a class="header-anchor" href="#class-basicconfig-basemodel"><span><em><strong>class</strong></em> <code>BasicConfig(BaseModel)</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/liteyuki/config.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="currentCol
|
2024-08-19 10:10:27 +08:00
|
|
|
<script type="module" src="/assets/app-CKfb26EU.js" defer></script>
|
2024-08-19 09:56:38 +08:00
|
|
|
</body>
|
|
|
|
|
</html>
|
