https://nonebot.dev/assets/js/14f5c6aa.42106df9.js

1"use strict";(self.webpackChunknonebot=self.webpackChunknonebot||[]).push([["3939"],{39782(n,e,s){s.r(e),s.d(e,{metadata:()=>l,default:()=>o,frontMatter:()=>d,contentTitle:()=>r,toc:()=>x,assets:()=>h});var l=JSON.parse('{"id":"api/utils","title":"nonebot.utils","description":"nonebot.utils \u6A21\u5757","source":"@site/docs/api/utils.md","sourceDirName":"api","slug":"/api/utils","permalink":"/docs/next/api/utils","draft":false,"unlisted":false,"editUrl":"https://github.com/nonebot/nonebot2/edit/master/website/docs/api/utils.md","tags":[],"version":"current","lastUpdatedBy":"yanyongyu","lastUpdatedAt":1638386230000,"sidebarPosition":8,"frontMatter":{"mdx":{"format":"md"},"sidebar_position":8,"description":"nonebot.utils \u6A21\u5757"},"sidebar":"api","previous":{"title":"nonebot.log","permalink":"/docs/next/api/log"},"next":{"title":"nonebot.consts","permalink":"/docs/next/api/consts"}}'),c=s(62540),i=s(43023);let d={mdx:{format:"md"},sidebar_position:8,description:"nonebot.utils \u6A21\u5757"},r="nonebot.utils",h={},x=[{value:"<em>enum</em> <code>Unset</code>

1",id:"Unset",level:2},{value:"<em>def</em> <code>exclude_unset(data)</code>",id:"exclude-unset",level:2},{value:"<em>def</em> <code>escape_tag(s)</code>",id:"escape-tag",level:2},{value:"<em>def</em> <code>deep_update(mapping, *updating_mappings)</code>",id:"deep-update",level:2},{value:"<em>def</em> <code>lenient_issubclass(cls, class_or_tuple)</code>",id:"lenient-issubclass",level:2},{value:"<em>def</em> <code>generic_check_issubclass(cls, class_or_tuple)</code>",id:"generic-check-issubclass",level:2},{value:"<em>def</em> <code>type_is_complex(type_)</code>",id:"type-is-complex",level:2},{value:"<em>def</em> <code>is_coroutine_callable(call)</code>",id:"is-coroutine-callable",level:2},{value:"<em>def</em> <code>is_gen_callable(call)</code>",id:"is-gen-callable",level:2},{value:"<em>def</em> <code>is_async_gen_callable(call)</code>",id:"is-async-gen-callable",level:2},{value:"<em>def</em> <code>run_sync(call)</code>",id:"run-sync",level:2},{value:"<em>def</em> <code>run_sync_ctx_manager(cm)</code>",id:"run-sync-ctx-manager",level:2},{value:"<em>async def</em> <code>run_coro_with_catch(coro, exc, return_on_err=None)</code>",id:"run-coro-with-catch",level:2},{value:"<em>async def</em> <code>run_coro_with_shield(coro)</code>",id:"run-coro-with-shield",level:2},{value:"<em>def</em> <code>flatten_exception_group(exc_group)</code>",id:"flatten-exception-group",level:2},{value:"<em>def</em> <code>get_name(obj)</code>",id:"get-name",level:2},{value:"<em>def</em> <code>path_to_module_name(path)</code>",id:"path-to-module-name",level:2},{value:"<em>def</em> <code>resolve_dot_notation(obj_str, default_attr, default_prefix=None)</code>",id:"resolve-dot-notation",level:2},{value:"<em>class</em> <code>classproperty(func)</code>",id:"classproperty",level:2},{value:"<em>class</em> <code>DataclassEncoder(&lt;auto&gt;)</code>",id:"DataclassEncoder",level:2},{value:"<em>method</em> <code>default(o)</code>",id:"DataclassEncoder-default",level:3},{value:"<em>def</em> <code>logger_wrapper(logger_name)</code>",id:"logger-wrapper",level:2}];function j(n){let e={a:"a",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",strong:"strong",ul:"ul",...(0,i.R)(),...n.components};return(0,c.jsxs)(c.Fragment,{children:[(0,c.jsx)(e.header,{children:(0,c.jsx)(e.h1,{id:"nonebotutils",children:"nonebot.utils"})}),"\n",(0,c.jsx)(e.p,{children:"\u672C\u6A21\u5757\u5305\u542B\u4E86 NoneBot \u7684\u4E00\u4E9B\u5DE5\u5177\u51FD\u6570"}),"\n",(0,c.jsxs)(e.h2,{id:"Unset",children:[(0,c.jsx)(e.em,{children:"enum"})," ",(0,c.jsx)(e.code,{children:"Unset"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsx)(e.p,{children:"auto"}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"exclude-unset",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"exclude_unset(data)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"data"})," (Any)"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"Any"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"escape-tag",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"escape_tag(s)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8BF4\u660E"})}),"\n",(0,c.jsxs)(e.p,{children:["\u7528\u4E8E\u8BB0\u5F55\u5E26\u989C\u8272\u65E5\u5FD7\u65F6\u8F6C\u4E49 ",(0,c.jsx)(e.code,{children:"<tag>"})," \u7C7B\u578B\u7279\u6B8A\u6807\u7B7E"]}),"\n",(0,c.jsxs)(e.p,{children:["\u53C2\u8003: ",(0,c.jsx)(e.a,{href:"https://loguru.readthedocs.io/en/stable/api/logger.html#color",children:"loguru color \u6807\u7B7E"})]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"s"})," (str): \u9700\u8981\u8F6C\u4E49\u7684\u5B57\u7B26\u4E32"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"str"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"deep-update",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"deep_update(mapping, *updating_mappings)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u6DF1\u5EA6\u66F4\u65B0\u5408\u5E76\u5B57\u5178"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"mapping"})," (dict[K, Any])"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"*updating_mappings"})," (dict[K, Any])"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"dict[K, Any]"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"lenient-issubclass",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"lenient_issubclass(cls, class_or_tuple)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5 cls \u662F\u5426\u662F class_or_tuple \u4E2D\u7684\u4E00\u4E2A\u7C7B\u578B\u5B50\u7C7B\u5E76\u5FFD\u7565\u7C7B\u578B\u9519\u8BEF\u3002"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"cls"})," (Any)"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"class_or_tuple"})," (type[Any] | tuple[type[Any], ...])"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"bool"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"generic-check-issubclass",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"generic_check_issubclass(cls, class_or_tuple)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8BF4\u660E"})}),"\n",(0,c.jsx)(e.p,{children:"\u68C0\u67E5 cls \u662F\u5426\u662F class_or_tuple \u4E2D\u7684\u4E00\u4E2A\u7C7B\u578B\u5B50\u7C7B\u3002"}),"\n",(0,c.jsx)(e.p,{children:"\u7279\u522B\u7684\uFF1A"}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\u5982\u679C cls \u662F ",(0,c.jsx)(e.code,{children:"typing.TypeVar"})," \u7C7B\u578B\uFF0C\n\u5219\u4F1A\u68C0\u67E5\u5176 ",(0,c.jsx)(e.code,{children:"__bound__"})," \u6216 ",(0,c.jsx)(e.code,{children:"__constraints__"}),"\n\u662F\u5426\u662F class_or_tuple \u4E2D\u4E00\u4E2A\u7C7B\u578B\u7684\u5B50\u7C7B\u6216 None\u3002"]}),"\n",(0,c.jsxs)(e.li,{children:["\u5982\u679C cls \u662F ",(0,c.jsx)(e.code,{children:"typing.Union"})," \u6216 ",(0,c.jsx)(e.code,{children:"types.UnionType"})," \u7C7B\u578B\uFF0C\n\u5219\u4F1A\u68C0\u67E5\u5176\u4E2D\u7684\u6240\u6709\u7C7B\u578B\u662F\u5426\u662F class_or_tuple \u4E2D\u4E00\u4E2A\u7C7B\u578B\u7684\u5B50\u7C7B\u6216 None\u3002"]}),"\n",(0,c.jsxs)(e.li,{children:["\u5982\u679C cls \u662F ",(0,c.jsx)(e.code,{children:"typing.Literal"})," \u7C7B\u578B\uFF0C\n\u5219\u4F1A\u68C0\u67E5\u5176\u4E2D\u7684\u6240\u6709\u503C\u662F\u5426\u662F class_or_tuple \u4E2D\u4E00\u4E2A\u7C7B\u578B\u7684\u5B9E\u4F8B\u3002"]}),"\n",(0,c.jsxs)(e.li,{children:["\u5982\u679C cls \u662F ",(0,c.jsx)(e.code,{children:"typing.List"}),"\u3001",(0,c.jsx)(e.code,{children:"typing.Dict"})," \u7B49\u6CDB\u578B\u7C7B\u578B\uFF0C\n\u5219\u4F1A\u68C0\u67E5\u5176\u539F\u59CB\u7C7B\u578B\u662F\u5426\u662F class_or_tuple \u4E2D\u4E00\u4E2A\u7C7B\u578B\u7684\u5B50\u7C7B\u3002"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"cls"})," (Any)"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"class_or_tuple"})," (type[Any] | tuple[type[Any], ...])"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"bool"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"type-is-complex",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"type_is_complex(type_)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5 type_ \u662F\u5426\u662F\u590D\u6742\u7C7B\u578B"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"type_"})," (type[Any])"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"bool"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"is-coroutine-callable",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"is_coroutine_callable(call)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"}

1)," \u68C0\u67E5 call \u662F\u5426\u662F\u4E00\u4E2A callable \u534F\u7A0B\u51FD\u6570"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"call"})," ((...) -> Any)"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"bool"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"is-gen-callable",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"is_gen_callable(call)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5 call \u662F\u5426\u662F\u4E00\u4E2A\u751F\u6210\u5668\u51FD\u6570"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"call"})," ((...) -> Any)"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"bool"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"is-async-gen-callable",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"is_async_gen_callable(call)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5 call \u662F\u5426\u662F\u4E00\u4E2A\u5F02\u6B65\u751F\u6210\u5668\u51FD\u6570"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"call"})," ((...) -> Any)"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"bool"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"run-sync",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"run_sync(call)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u4E00\u4E2A\u7528\u4E8E\u5305\u88C5 sync function \u4E3A async function \u7684\u88C5\u9970\u5668"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"call"})," ((P) -> R): \u88AB\u88C5\u9970\u7684\u540C\u6B65\u51FD\u6570"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"(P) -> Coroutine[None, None, R]"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"run-sync-ctx-manager",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"run_sync_ctx_manager(cm)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u4E00\u4E2A\u7528\u4E8E\u5305\u88C5 sync context manager \u4E3A async context manager \u7684\u6267\u884C\u51FD\u6570"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"cm"})," (AbstractContextManager[T])"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"AsyncGenerator[T, None]"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"run-coro-with-catch",children:[(0,c.jsx)(e.em,{children:"async def"})," ",(0,c.jsx)(e.code,{children:"run_coro_with_catch(coro, exc, return_on_err=None)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u8FD0\u884C\u534F\u7A0B\u5E76\u5F53\u9047\u5230\u6307\u5B9A\u5F02\u5E38\u65F6\u8FD4\u56DE\u6307\u5B9A\u503C\u3002"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u91CD\u8F7D"})}),"\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"1."})," ",(0,c.jsx)(e.code,{children:"(coro, exc, return_on_err=None) -> T | None"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"coro"})," (Coroutine[Any, Any, T])"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"exc"})," (tuple[type[Exception], ...])"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"return_on_err"})," (None)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"T | None"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"2."})," ",(0,c.jsx)(e.code,{children:"(coro, exc, return_on_err) -> T | R"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"coro"})," (Coroutine[Any, Any, T])"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"exc"})," (tuple[type[Exception], ...])"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"return_on_err"})," (R)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"T | R"}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"coro"}),": \u8981\u8FD0\u884C\u7684\u534F\u7A0B"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"exc"}),": \u8981\u6355\u83B7\u7684\u5F02\u5E38"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"return_on_err"}),": \u5F53\u53D1\u751F\u5F02\u5E38\u65F6\u8FD4\u56DE\u7684\u503C"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsx)(e.p,{children:"\u534F\u7A0B\u7684\u8FD4\u56DE\u503C\u6216\u53D1\u751F\u5F02\u5E38\u65F6\u7684\u6307\u5B9A\u503C"}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"run-coro-with-shield",children:[(0,c.jsx)(e.em,{children:"async def"}

1)," ",(0,c.jsx)(e.code,{children:"run_coro_with_shield(coro)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u8FD0\u884C\u534F\u7A0B\u5E76\u5728\u53D6\u6D88\u65F6\u5C4F\u853D\u53D6\u6D88\u5F02\u5E38\u3002"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"coro"})," (Coroutine[Any, Any, T]): \u8981\u8FD0\u884C\u7684\u534F\u7A0B"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"T: \u534F\u7A0B\u7684\u8FD4\u56DE\u503C"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"flatten-exception-group",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"flatten_exception_group(exc_group)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"exc_group"})," (BaseExceptionGroup[E])"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"Generator[E, None, None]"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"get-name",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"get_name(obj)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u83B7\u53D6\u5BF9\u8C61\u7684\u540D\u79F0"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"obj"})," (Any)"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"str"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"path-to-module-name",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"path_to_module_name(path)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u8F6C\u6362\u8DEF\u5F84\u4E3A\u6A21\u5757\u540D"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"path"})," (Path)"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"str"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"resolve-dot-notation",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"resolve_dot_notation(obj_str, default_attr, default_prefix=None)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u89E3\u6790\u5E76\u5BFC\u5165\u70B9\u5206\u8868\u793A\u6CD5\u7684\u5BF9\u8C61"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"obj_str"})," (str)"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"default_attr"})," (str)"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.code,{children:"default_prefix"})," (str | None)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"Any"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"classproperty",children:[(0,c.jsx)(e.em,{children:"class"})," ",(0,c.jsx)(e.code,{children:"classproperty(func)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u7C7B\u5C5E\u6027\u88C5\u9970\u5668"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"func"})," ((Any) -> T)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"DataclassEncoder",children:[(0,c.jsx)(e.em,{children:"class"})," ",(0,c.jsx)(e.code,{children:"DataclassEncoder(<auto>)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u53EF\u4EE5\u5E8F\u5217\u5316 ",(0,c.jsx)(e.a,{href:"/docs/next/api/adapter

1s/#Message",children:"Message"}),"(List[Dataclass]) \u7684 ",(0,c.jsx)(e.code,{children:"JSONEncoder"})]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsx)(e.p,{children:"auto"}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h3,{id:"DataclassEncoder-default",children:[(0,c.jsx)(e.em,{children:"method"})," ",(0,c.jsx)(e.code,{children:"default(o)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:(0,c.jsx)(e.code,{children:"o"})}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"untyped"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.h2,{id:"logger-wrapper",children:[(0,c.jsx)(e.em,{children:"def"})," ",(0,c.jsx)(e.code,{children:"logger_wrapper(logger_name)"})]}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsxs)(e.p,{children:[(0,c.jsx)(e.strong,{children:"\u8BF4\u660E:"})," \u7528\u4E8E\u6253\u5370 adapter \u7684\u65E5\u5FD7\u3002"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u53C2\u6570"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:[(0,c.jsx)(e.code,{children:"logger_name"})," (str): adapter \u7684\u540D\u79F0"]}),"\n"]}),"\n"]}),"\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:(0,c.jsx)(e.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsxs)(e.li,{children:["\n",(0,c.jsx)(e.p,{children:"untyped: \u65E5\u5FD7\u8BB0\u5F55\u51FD\u6570"}),"\n",(0,c.jsx)(e.p,{children:"\u65E5\u5FD7\u8BB0\u5F55\u51FD\u6570\u7684\u53C2\u6570:"}),"\n",(0,c.jsxs)(e.ul,{children:["\n",(0,c.jsx)(e.li,{children:"level: \u65E5\u5FD7\u7B49\u7EA7"}),"\n",(0,c.jsx)(e.li,{children:"message: \u65E5\u5FD7\u4FE1\u606F"}),"\n",(0,c.jsx)(e.li,{children:"exception: \u5F02\u5E38\u4FE1\u606F"}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]})]})}function o(n={}){let{wrapper:e}={...(0,i.R)(),...n.components};return e?(0,c.jsx)(e,{...n,children:(0,c.jsx)(j,{...n})}):j(n)}},43023(n,e,s){s.d(e,{R:()=>d,x:()=>r});var l=s(63696);let c={},i=l.createContext(c);function d(n){let e=l.useContext(i);return l.useMemo(function(){return"function"==typeof n?n(e):{...e,...n}},[e,n])}function r(n){let e;return e=n.disableParentContext?"function"==typeof n.components?n.components(c):n.components||c:d(n.components),l.createElement(i.Provider,{value:e},n.children)}}}]);