https://nonebot.dev/assets/js/c7b05415.b32190d8.js

1"use strict";(self.webpackChunknonebot=self.webpackChunknonebot||[]).push([["1231"],{58580(e,n,s){s.r(n),s.d(n,{metadata:()=>l,default:()=>o,frontMatter:()=>c,contentTitle:()=>i,toc:()=>x,assets:()=>h});var l=JSON.parse('{"id":"api/rule","title":"nonebot.rule","description":"nonebot.rule \u6A21\u5757","source":"@site/versioned_docs/version-2.4.4/api/rule.md","sourceDirName":"api","slug":"/api/rule","permalink":"/docs/2.4.4/api/rule","draft":false,"unlisted":false,"editUrl":"https://github.com/nonebot/nonebot2/edit/master/website/versioned_docs/version-2.4.4/api/rule.md","tags":[],"version":"2.4.4","lastUpdatedBy":"StarHeart","lastUpdatedAt":1785574664000,"sidebarPosition":5,"frontMatter":{"mdx":{"format":"md"},"sidebar_position":5,"description":"nonebot.rule \u6A21\u5757"},"sidebar":"api","previous":{"title":"nonebot.params","permalink":"/docs/2.4.4/api/params"},"next":{"title":"nonebot.permission","permalink":"/docs/2.4.4/api/permission"}}'),r=s(62540),d=s(43023);let c={mdx:{format:"md"},sidebar_position:5,description:"nonebot.rule \u6A21\u5757"},i="nonebot.rule",h={},x=[{value:"<em>class</em> <code>Rule(*checkers)</code>",id:"Rule",level:2},{value:"<em>instance-var</em> <code>checkers</code>",id:"Rule-checkers",level:3},{value:"<em>async method</em> <code>__call__(bot, event, state, stack=None, dependency_cache=None)</code>",id:"Rule---call--",level:3},{value:"<em>class</em> <code>CMD_RESULT(&lt;auto&gt;)</code>",id:"CMD-RESULT",level:2},{value:"<em>class</em> <code>TRIE_VALUE(&lt;auto&gt;)</code>",id:"TRIE-VALUE",level:2},{value:"<em>class</em> <code>StartswithRule(msg, ignorecase=False)</code>",id:"StartswithRule",level:2},{value:"<em>def</em> <code>startswith(msg, ignorecase=False)</code>",id:"startswith",level:2},{value:"<em>class</em> <code>EndswithRule(msg, ignorecase=False)</code>",id:"EndswithRule",level:2},{value:"<em>def</em> <code>endswith(msg, ignorecase=False)</code>",id:"endswith",level:2},{value:"<em>class</em> <code>FullmatchRule(msg, ignorecase=False)</code>",id:"FullmatchRule",level:2},{value:"<em>def</em> <code>fullmatch(msg, ignorecase=False)</code>",id:"fullmatch",level:2},{value:"<em>class</em> <code>KeywordsRule(*keywords)</code>",id:"KeywordsRule",level:2},{value:"<em>def</em> <code>keyword(*keywords)</code>",id:"keyword",level:2},{value:"<em>class</em> <code>CommandRule(cmds, force_whitespace=None)</code>",id:"CommandRule",level:2},{value:"<em>def</em> <code>command(*cmds, force_whitespace=None)</code>",id:"command",level:2},{value:"<em>class</em> <code>ArgumentParser(&lt;auto&gt;)</code>",id:"ArgumentParser",level:2},{value:"<em>method</em> <code>parse_known_args(args=None, namespace=None)</code>",id:"ArgumentParser-parse-known-args",level:3},{value:"<em>class</em> <code>ShellCommandRule(cmds, parser)</code>",id:"ShellCommandRule",level:2},{value:"<em>def</em> <code>shell_command(*cmds, parser=None)</code>",id:"shell-command",level:2},{value:"<em>class</em> <code>RegexRule(regex, flags=0)</code>",id:"RegexRule",level:2},{value:"<em>def</em> <code>regex(regex, flags=0)</code>",id:"regex",level:2},{value:"<em>class</em> <code>ToMeRule(&lt;auto&gt;)</code>",id:"ToMeRule",level:2},{value:"<em>def</em> <code>to_me()</code>",id:"to-me",level:2},{value:"<em>class</em> <code>IsTypeRule(*types)</code>",id:"IsTypeRule",level:2},{value:"<em>def</em> <code>is_type(*types)</code>",id:"is-type",level:2}];function j(e){let n={a:"a",admonition:"admonition",code:"code",em:"em",h1:"h1",h2:"h2",h3:"h3",header:"header",li:"li",p:"p",pre:"pre",strong:"strong",ul:"ul",...(0,d.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(n.header,{children:(0,r.jsx)(n.h1,{id:"nonebotrule",children:"nonebot.rule"})}),"\n",(0,r.jsxs)(n.p,{children:["\u672C\u6A21\u5757\u662F ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/matcher#Matcher-rule",children:"Matcher.rule"})," \u7684\u7C7B\u578B\u5B9A\u4E49\u3002"]}),"\n",(0,r.jsxs)(n.p,{children:["\u6BCF\u4E2A",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/matcher#Matcher",children:"\u4E8B\u4EF6\u54CD\u5E94\u5668"}),"\u62E5\u6709\u4E00\u4E2A\n",(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"}),"\uFF0C\u5176\u4E2D\u662F ",(0,r.jsx)(n.code,{children:"RuleChecker"})," \u7684\u96C6\u5408\u3002\n\u53EA\u6709\u5F53\u6240\u6709 ",(0,r.jsx)(n.code,{children:"RuleChecker"})," \u68C0\u67E5\u7ED3\u679C\u4E3A ",(0,r.jsx)(n.code,{children:"True"})," \u65F6\u7EE7\u7EED\u8FD0\u884C\u3002"]}),"\n",(0,r.jsxs)(n.h2,{id:"Rule",children:[(0,r.jsx)(n.em,{children:"class"}

1)," ",(0,r.jsx)(n.code,{children:"Rule(*checkers)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8BF4\u660E"})}),"\n",(0,r.jsx)(n.p,{children:"\u89C4\u5219\u7C7B\u3002"}),"\n",(0,r.jsxs)(n.p,{children:["\u5F53\u4E8B\u4EF6\u4F20\u9012\u65F6\uFF0C\u5728 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/matcher#Matcher",children:"Matcher"})," \u8FD0\u884C\u524D\u8FDB\u884C\u68C0\u67E5\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"*checkers"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/typing#T-RuleChecker",children:"T_RuleChecker"})," | ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/dependencies/#Dependent",children:"Dependent"}),"[bool]): RuleChecker"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u7528\u6CD5"})}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-python",children:"Rule(async_function) & sync_function\n# \u7B49\u4EF7\u4E8E\nRule(async_function, sync_function)\n"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Rule-checkers",children:[(0,r.jsx)(n.em,{children:"instance-var"})," ",(0,r.jsx)(n.code,{children:"checkers"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u7C7B\u578B:"})," set[",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/dependencies/#Dependent",children:"Dependent"}),"[bool]]"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u5B58\u50A8 ",(0,r.jsx)(n.code,{children:"RuleChecker"})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"Rule---call--",children:[(0,r.jsx)(n.em,{children:"async method"})," ",(0,r.jsx)(n.code,{children:"__call__(bot, event, state, stack=None, dependency_cache=None)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u662F\u5426\u7B26\u5408\u6240\u6709\u89C4\u5219"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"bot"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#Bot",children:"Bot"}),"): Bot \u5BF9\u8C61"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"event"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#Event",children:"Event"}),"): Event \u5BF9\u8C61"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"state"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/typing#T-State",children:"T_State"}),"): \u5F53\u524D State"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"stack"})," (AsyncExitStack | None): \u5F02\u6B65\u4E0A\u4E0B\u6587\u6808"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"dependency_cache"})," (",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/typing#T-DependencyCache",children:"T_DependencyCache"})," | None): \u4F9D\u8D56\u7F13\u5B58"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:"bool"}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"CMD-RESULT",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"CMD_RESULT(<auto>)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsx)(n.p,{children:"auto"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"TRIE-VALUE",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"TRIE_VALUE(<auto>)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," TRIE_VALUE(command_start, command)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsx)(n.p,{children:"auto"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"StartswithRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"StartswithRule(msg, ignorecase=False)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u6D88\u606F\u7EAF\u6587\u672C\u662F\u5426\u4EE5\u6307\u5B9A\u5B57\u7B26\u4E32\u5F00\u5934\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"msg"})," (tuple[str, ...]): \u6307\u5B9A\u6D88\u606F\u5F00\u5934\u5B57\u7B26\u4E32\u5143\u7EC4"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ignorecase"})," (bool): \u662F\u5426\u5FFD\u7565\u5927\u5C0F\u5199"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"startswith",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"startswith(msg, ignorecase=False)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u5339\u914D\u6D88\u606F\u7EAF\u6587\u672C\u5F00\u5934\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"msg"})," (str | tuple[str, ...]): \u6307\u5B9A\u6D88\u606F\u5F00\u5934\u5B57\u7B26\u4E32\u5143\u7EC4"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ignorecase"})," (bool): \u662F\u5426\u5FFD\u7565\u5927\u5C0F\u5199"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"EndswithRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"EndswithRule(msg, ignorecase=False)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u6D88\u606F\u7EAF\u6587\u672C\u662F\u5426\u4EE5\u6307\u5B9A\u5B57\u7B26\u4E32\u7ED3\u5C3E\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"msg"})," (tuple[str, ...]): \u6307\u5B9A\u6D88\u606F\u7ED3\u5C3E\u5B57\u7B26\u4E32\u5143\u7EC4"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ignorecase"})," (bool): \u662F\u5426\u5FFD\u7565\u5927\u5C0F\u5199"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"endswith",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"endswith(msg, ignorecase=False)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u5339\u914D\u6D88\u606F\u7EAF\u6587\u672C\u7ED3\u5C3E\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"msg"})," (str | tuple[str, ...]): \u6307\u5B9A\u6D88\u606F\u5F00\u5934\u5B57\u7B26\u4E32\u5143\u7EC4"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ignorecase"})," (bool): \u662F\u5426\u5FFD\u7565\u5927\u5C0F\u5199"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"FullmatchRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"FullmatchRule(msg, ignorecase=False)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u6D88\u606F\u7EAF\u6587\u672C\u662F\u5426\u4E0E\u6307\u5B9A\u5B57\u7B26\u4E32\u5168\u5339\u914D\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"msg"})," (tuple[str, ...]): \u6307\u5B9A\u6D88\u606F\u5168\u5339\u914D\u5B57\u7B26\u4E32\u5143\u7EC4"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ignorecase"})," (bool): \u662F\u5426\u5FFD\u7565\u5927\u5C0F\u5199"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"fullmatch",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"fullmatch(msg, ignorecase=False)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u5B8C\u5168\u5339\u914D\u6D88\u606F\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"msg"})," (str | tuple[str, ...]): \u6307\u5B9A\u6D88\u606F\u5168\u5339\u914D\u5B57\u7B26\u4E32\u5143\u7EC4"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"ignorecase"})," (bool): \u662F\u5426\u5FFD\u7565\u5927\u5C0F\u5199"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"KeywordsRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"KeywordsRule(*keywords)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u6D88\u606F\u7EAF\u6587\u672C\u662F\u5426\u5305\u542B\u6307\u5B9A\u5173\u952E\u5B57\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"*keywords"})," (str): \u6307\u5B9A\u5173\u952E\u5B57\u5143\u7EC4"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"keyword",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"keyword(*keywords)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u5339\u914D\u6D88\u606F\u7EAF\u6587\u672C\u5173\u952E\u8BCD\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"*keywords"})," (str): \u6307\u5B9A\u5173\u952E\u5B57\u5143\u7EC4"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"CommandRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"CommandRule(cmds, force_whitespace=None)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u6D88\u606F\u662F\u5426\u4E3A\u6307\u5B9A\u547D\u4EE4\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"cmds"})," (list[tuple[str, ...]]): \u6307\u5B9A\u547D\u4EE4\u5143\u7EC4\u5217\u8868"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"force_whitespace"})," (str | bool | None): \u662F\u5426\u5F3A\u5236\u547D\u4EE4\u540E\u5FC5\u987B\u6709\u6307\u5B9A\u7A7A\u767D\u7B26"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"command",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"command(*cmds, force_whitespace=None)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8BF4\u660E"})}),"\n",(0,r.jsx)(n.p,{children:"\u5339\u914D\u6D88\u606F\u547D\u4EE4\u3002"}),"\n",(0,r.jsxs)(n.p,{children:["\u6839\u636E\u914D\u7F6E\u91CC\u63D0\u4F9B\u7684 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/config#Config-command-start",children:(0,r.jsx)(n.code,{children:"command_start"})}),",\n",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/config#Config-command-sep",children:(0,r.jsx)(n.code,{children:"command_sep"})})," \u5224\u65AD\u6D88\u606F\u662F\u5426\u4E3A\u547D\u4EE4\u3002"]}),"\n",(0,r.jsxs)(n.p,{children:["\u53EF\u4EE5\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#Command",children:"Command"})," \u83B7\u53D6\u5339\u914D\u6210\u529F\u7684\u547D\u4EE4\uFF08\u4F8B: ",(0,r.jsx)(n.code,{children:'("test",)'}),"\uFF09\uFF0C\n\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#RawCommand",children:"RawCommand"})," \u83B7\u53D6\u5339\u914D\u6210\u529F\u7684\u539F\u59CB\u547D\u4EE4\u6587\u672C\uFF08\u4F8B: ",(0,r.jsx)(n.code,{children:'"/test"'}),"\uFF09\uFF0C\n\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#CommandArg",children:"CommandArg"})," \u83B7\u53D6\u5339\u914D\u6210\u529F\u7684\u547D\u4EE4\u53C2\u6570\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"*cmds"})," (str | tuple[str, ...]): \u547D\u4EE4\u6587\u672C\u6216\u547D\u4EE4\u5143\u7EC4"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"force_whitespace"})," (str | bool | None): \u662F\u5426\u5F3A\u5236\u547D\u4EE4\u540E\u5FC5\u987B\u6709\u6307\u5B9A\u7A7A\u767D\u7B26"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u7528\u6CD5"})}),"\n",(0,r.jsxs)(n.p,{children:["\u4F7F\u7528\u9ED8\u8BA4 ",(0,r.jsx)(n.code,{children:"command_start"}),", ",(0,r.jsx)(n.code,{children:"command_sep"})," \u914D\u7F6E\u60C5\u51B5\u4E0B\uFF1A"]}),"\n",(0,r.jsxs)(n.p,{children:["\u547D\u4EE4 ",(0,r.jsx)(n.code,{children:'("test",)'})," \u53EF\u4EE5\u5339\u914D: ",(0,r.jsx)(n.code,{children:"/test"})," \u5F00\u5934\u7684\u6D88\u606F\n\u547D\u4EE4 ",(0,r.jsx)(n.code,{children:'("test", "sub")'})," \u53EF\u4EE5\u5339\u914D: ",(0,r.jsx)(n.code,{children:"/test.sub"})," \u5F00\u5934\u7684\u6D88\u606F"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.admonition,{title:"\u63D0\u793A",type:"tip",children:(0,r.

1jsx)(n.p,{children:"\u547D\u4EE4\u5185\u5BB9\u4E0E\u540E\u7EED\u6D88\u606F\u95F4\u65E0\u9700\u7A7A\u683C!"})}),"\n",(0,r.jsxs)(n.h2,{id:"ArgumentParser",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"ArgumentParser(<auto>)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8BF4\u660E"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"shell_like"})," \u547D\u4EE4\u53C2\u6570\u89E3\u6790\u5668\uFF0C\u89E3\u6790\u51FA\u9519\u65F6\u4E0D\u4F1A\u9000\u51FA\u7A0B\u5E8F\u3002"]}),"\n",(0,r.jsxs)(n.p,{children:["\u652F\u6301 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#Message",children:"Message"})," \u5BCC\u6587\u672C\u89E3\u6790\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsx)(n.p,{children:"auto"}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u7528\u6CD5"})}),"\n",(0,r.jsxs)(n.p,{children:["\u7528\u6CD5\u4E0E ",(0,r.jsx)(n.code,{children:"argparse.ArgumentParser"})," \u76F8\u540C\uFF0C\n\u53C2\u8003\u6587\u6863: ",(0,r.jsx)(n.a,{href:"https://docs.python.org/3/library/argparse.html",children:"argparse"})]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h3,{id:"ArgumentParser-parse-known-args",children:[(0,r.jsx)(n.em,{children:"method"})," ",(0,r.jsx)(n.code,{children:"parse_known_args(args=None, namespace=None)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u91CD\u8F7D"})}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"1."})," ",(0,r.jsx)(n.code,{children:"(args=None, namespace=None) -> tuple[Namespace, list[str | MessageSegment]]"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"args"})," (Sequence[str | ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#MessageSegment",children:"MessageSegment"}),"] | None)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"namespace"})," (None)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["tuple[Namespace, list[str | ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#MessageSegment",children:"MessageSegment"}),"]]"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"2."})," ",(0,r.jsx)(n.code,{children:"(args, namespace) -> tuple[T, list[str | MessageSegment]]"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"args"})," (Sequence[str | ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#MessageSegment",children:"MessageSegment"}),"] | None)"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"namespace"})," (T)"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["tuple[T, list[str | ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#MessageSegment",children:"MessageSegment"}),"]]"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"3."})," ",(0,r.jsx)(n.code,{children:"(*, namespace) -> tuple[T, list[str | MessageSegment]]"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"namespace"})," (T)"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["tuple[T, list[str | ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapter

1s/#MessageSegment",children:"MessageSegment"}),"]]"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"ShellCommandRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"ShellCommandRule(cmds, parser)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u6D88\u606F\u662F\u5426\u4E3A\u6307\u5B9A shell \u547D\u4EE4\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"cmds"})," (list[tuple[str, ...]]): \u6307\u5B9A\u547D\u4EE4\u5143\u7EC4\u5217\u8868"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"parser"})," (ArgumentParser | None): \u53EF\u9009\u53C2\u6570\u89E3\u6790\u5668"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"shell-command",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"shell_command(*cmds, parser=None)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8BF4\u660E"})}),"\n",(0,r.jsxs)(n.p,{children:["\u5339\u914D ",(0,r.jsx)(n.code,{children:"shell_like"})," \u5F62\u5F0F\u7684\u6D88\u606F\u547D\u4EE4\u3002"]}),"\n",(0,r.jsxs)(n.p,{children:["\u6839\u636E\u914D\u7F6E\u91CC\u63D0\u4F9B\u7684 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/config#Config-command-start",children:(0,r.jsx)(n.code,{children:"command_start"})}),",\n",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/config#Config-command-sep",children:(0,r.jsx)(n.code,{children:"command_sep"})})," \u5224\u65AD\u6D88\u606F\u662F\u5426\u4E3A\u547D\u4EE4\u3002"]}),"\n",(0,r.jsxs)(n.p,{children:["\u53EF\u4EE5\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#Command",children:"Command"})," \u83B7\u53D6\u5339\u914D\u6210\u529F\u7684\u547D\u4EE4\n\uFF08\u4F8B: ",(0,r.jsx)(n.code,{children:'("test",)'}),"\uFF09\uFF0C\n\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#RawCommand",children:"RawCommand"})," \u83B7\u53D6\u5339\u914D\u6210\u529F\u7684\u539F\u59CB\u547D\u4EE4\u6587\u672C\n\uFF08\u4F8B: ",(0,r.jsx)(n.code,{children:'"/test"'}),"\uFF09\uFF0C\n\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#ShellCommandArgv",children:"ShellCommandArgv"})," \u83B7\u53D6\u89E3\u6790\u524D\u7684\u53C2\u6570\u5217\u8868\n\uFF08\u4F8B: ",(0,r.jsx)(n.code,{children:'["arg", "-h"]'}),"\uFF09\uFF0C\n\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#ShellCommandArgs",children:"ShellCommandArgs"})," \u83B7\u53D6\u89E3\u6790\u540E\u7684\u53C2\u6570\u5B57\u5178\n\uFF08\u4F8B: ",(0,r.jsx)(n.code,{children:'{"arg": "arg", "h": True}'}),"\uFF09\u3002"]}),"\n",(0,r.jsx)(n.admonition,{title:"\u8B66\u544A",type:"warning",children:(0,r.jsxs)(n.p,{children:["\u5982\u679C\u53C2\u6570\u89E3\u6790\u5931\u8D25\uFF0C\u5219\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#ShellCommandArgs",children:"ShellCommandArgs"}),"\n\u83B7\u53D6\u7684\u5C06\u662F ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/exception#ParserExit",children:"ParserExit"})," \u5F02\u5E38\u3002"]})}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"*cmds"})," (str | tuple[str, ...]): \u547D\u4EE4\u6587\u672C\u6216\u547D\u4EE4\u5143\u7EC4"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"parser"})," (ArgumentParser | None): ",(0,r.jsx)(n.a,{href:"#ArgumentParser",children:"ArgumentParser"})," \u5BF9\u8C61"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u7528\u6CD5"})}),"\n",(0,r.jsxs)(n.p,{children:["\u4F7F\u7528\u9ED8\u8BA4 ",(0,r.jsx)(n.code,{children:"command_start"}),", ",(0,r.jsx)(n.code,{children:"command_sep"})," \u914D\u7F6E\uFF0C\u66F4\u591A\u793A\u4F8B\u53C2\u8003\n",(0,r.jsx)(n.a,{href:"https://docs.python.org/3/library/argparse.html",children:"argparse"})," \u6807\u51C6\u5E93\u6587\u6863\u3002"]}),"\n",(0,r.jsx)(n.pre,{children:(0,r.jsx)(n.code,{className:"language-python",children:'from nonebot.rule import ArgumentParser\n\nparser = ArgumentParser()\nparser.add_argument("-a", action="store_true")\n\nrule = shell_command("ls", parser=parser)\n'})}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.admonition,{title:"\u63D0\u793A",type:"tip",children:(0,r.jsx)(n.p,{children:"\u547D\u4EE4\u5185\u5BB9\u4E0E\u540E\u7EED\u6D88\u606F\u95F4\u65E0\u9700\u7A7A\u683C!"})}),"\n",(0,r.jsxs)(n.h2,{id:"RegexRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"RegexRule(regex, flags=0)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u6D88\u606F\u5B57\u7B26\u4E32\u662F\u5426\u7B26\u5408\u6307\u5B9A\u6B63\u5219\u8868\u8FBE\u5F0F\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"regex"})," (str): \u6B63\u5219\u8868\u8FBE\u5F0F"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"flags"})," (int): \u6B63\u5219\u8868\u8FBE\u5F0F\u6807\u8BB0"]}),"\n"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"regex",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"regex(regex, flags=0)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8BF4\u660E"})}),"\n",(0,r.jsx)(n.p,{children:"\u5339\u914D\u7B26\u5408\u6B63\u5219\u8868\u8FBE\u5F0F\u7684\u6D88\u606F\u5B57\u7B26\u4E32\u3002"}),"\n",(0,r.jsxs)(n.p,{children:["\u53EF\u4EE5\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#RegexStr",children:"RegexStr"})," \u83B7\u53D6\u5339\u914D\u6210\u529F\u7684\u5B57\u7B26\u4E32\uFF0C\n\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#RegexGroup",children:"RegexGroup"})," \u83B7\u53D6\u5339\u914D\u6210\u529F\u7684 group \u5143\u7EC4\uFF0C\n\u901A\u8FC7 ",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/params#RegexDict",children:"RegexDict"})," \u83B7\u53D6\u5339\u914D\u6210\u529F\u7684 group \u5B57\u5178\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"regex"})," (str): \u6B63\u5219\u8868\u8FBE\u5F0F"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.code,{children:"flags"})," (int | re.RegexFlag): \u6B63\u5219\u8868\u8FBE\u5F0F\u6807\u8BB0"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsx)(n.admonition,{title:"\u63D0\u793A",type:"tip",children:(0,r.jsxs)(n.p,{children:["\u6B63\u5219\u8868\u8FBE\u5F0F\u5339\u914D\u4F7F\u7528 search \u800C\u975E match\uFF0C\u5982\u9700\u4ECE\u5934\u5339\u914D\u8BF7\u4F7F\u7528 ",(0,r.jsx)(n.code,{children:'r"^xxx"'})," \u6765\u786E\u4FDD\u5339\u914D\u5F00\u5934"]})}),"\n",(0,r.jsx)(n.admonition,{title:"\u63D0\u793A",type:"tip",children:(0,r.jsxs)(n.p,{children:["\u6B63\u5219\u8868\u8FBE\u5F0F\u5339\u914D\u4F7F\u7528 ",(0,r.jsx)(n.code,{children:"EventMessage"})," \u7684 ",(0,r.jsx)(n.code,{children:"str"})," \u5B57\u7B26\u4E32\uFF0C\n\u800C\u975E ",(0,r.jsx)(n.code,{children:"EventMessage"})," \u7684 ",(0,r.jsx)(n.code,{children:"PlainText"})," \u7EAF\u6587\u672C\u5B57\u7B26\u4E32"]})}),"\n",(0,r.jsxs)(n.h2,{id:"ToMeRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"ToMeRule(<auto>)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u4E8B\u4EF6\u662F\u5426\u4E0E\u673A\u5668\u4EBA\u6709\u5173\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsx)(n.p,{children:"auto"}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"to-me",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"to_me()"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u5339\u914D\u4E0E\u673A\u5668\u4EBA\u6709\u5173\u7684\u4E8B\u4EF6\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsx)(n.p,{children:"empty"}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"IsTypeRule",children:[(0,r.jsx)(n.em,{children:"class"})," ",(0,r.jsx)(n.code,{children:"IsTypeRule(*types)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u68C0\u67E5\u4E8B\u4EF6\u7C7B\u578B\u662F\u5426\u4E3A\u6307\u5B9A\u7C7B\u578B\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"*types"}

1)," (type[",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#Event",children:"Event"}),"])"]}),"\n"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.h2,{id:"is-type",children:[(0,r.jsx)(n.em,{children:"def"})," ",(0,r.jsx)(n.code,{children:"is_type(*types)"})]}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsxs)(n.p,{children:[(0,r.jsx)(n.strong,{children:"\u8BF4\u660E:"})," \u5339\u914D\u4E8B\u4EF6\u7C7B\u578B\u3002"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u53C2\u6570"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsxs)(n.li,{children:[(0,r.jsx)(n.code,{children:"*types"})," (type[",(0,r.jsx)(n.a,{href:"/docs/2.4.4/api/adapters/#Event",children:"Event"}),"]): \u4E8B\u4EF6\u7C7B\u578B"]}),"\n"]}),"\n"]}),"\n",(0,r.jsxs)(n.li,{children:["\n",(0,r.jsx)(n.p,{children:(0,r.jsx)(n.strong,{children:"\u8FD4\u56DE"})}),"\n",(0,r.jsxs)(n.ul,{children:["\n",(0,r.jsx)(n.li,{children:(0,r.jsx)(n.a,{href:"#Rule",children:"Rule"})}),"\n"]}),"\n"]}),"\n"]})]})}function o(e={}){let{wrapper:n}={...(0,d.R)(),...e.components};return n?(0,r.jsx)(n,{...e,children:(0,r.jsx)(j,{...e})}):j(e)}},43023(e,n,s){s.d(n,{R:()=>c,x:()=>i});var l=s(63696);let r={},d=l.createContext(r);function c(e){let n=l.useContext(d);return l.useMemo(function(){return"function"==typeof e?e(n):{...n,...e}},[n,e])}function i(e){let n;return n=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:c(e.components),l.createElement(d.Provider,{value:n},e.children)}}}]);