Update docs.

Meloland · Mar 29, 2024 · bab1619 · bab1619
1 parent 70763d1
commit bab1619
Showing 51 changed files with 1,490 additions and 299 deletions.
diff --git a/.buildinfo b/.buildinfo
@@ -1,4 +1,4 @@
 # Sphinx build info version 1
 # This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
-config: e8a73d4e7571c039e311dfb043fdab87
+config: d606eebf036f6e434f9db7d78a4c9e18
 tags: 645f666f9bcd5a90fca523b33c5a78b7
diff --git a/_modules/index.html b/_modules/index.html
@@ -6,7 +6,7 @@
         <link rel="canonical" href="/melobot/_modules/index.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>概览：模块代码 - MeloBot 2.5.6</title>
+        <title>概览：模块代码 - MeloBot 2.5.7</title>
       <link rel="stylesheet" type="text/css" href="../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../_static/copybutton.css?v=76b2166b" />
@@ -124,7 +124,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../index.html"><div class="brand">MeloBot 2.5.6</div></a>
+      <a href="../index.html"><div class="brand">MeloBot 2.5.7</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -150,7 +150,7 @@
     <img class="sidebar-logo" src="../_static/logo.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">MeloBot 2.5.6</span>
+  <span class="sidebar-brand-text">MeloBot 2.5.7</span>
 
 </a><form class="sidebar-search-container" method="get" action="../search.html" role="search">
   <input class="sidebar-search" placeholder="搜索" name="q" aria-label="搜索">
@@ -229,6 +229,8 @@ <h1>代码可用的所有模块</h1>
 <li><a href="melobot/context/action.html">melobot.context.action</a></li>
 <li><a href="melobot/context/session.html">melobot.context.session</a></li>
 <li><a href="melobot/io/forward_ws.html">melobot.io.forward_ws</a></li>
+<li><a href="melobot/io/full_duplex_http.html">melobot.io.full_duplex_http</a></li>
+<li><a href="melobot/io/reverse_ws.html">melobot.io.reverse_ws</a></li>
 <li><a href="melobot/meta.html">melobot.meta</a></li>
 <li><a href="melobot/models/cq.html">melobot.models.cq</a></li>
 <li><a href="melobot/models/event.html">melobot.models.event</a></li>
@@ -277,7 +279,7 @@ <h1>代码可用的所有模块</h1>
 
     </aside>
   </div>
-</div><script src="../_static/documentation_options.js?v=50123eb5"></script>
+</div><script src="../_static/documentation_options.js?v=42d402af"></script>
     <script src="../_static/doctools.js?v=888ff710"></script>
     <script src="../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/_modules/melobot/base/abc.html b/_modules/melobot/base/abc.html
@@ -6,7 +6,7 @@
         <link rel="canonical" href="/melobot/_modules/melobot/base/abc.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>melobot.base.abc - MeloBot 2.5.6</title>
+        <title>melobot.base.abc - MeloBot 2.5.7</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" />
@@ -124,7 +124,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">MeloBot 2.5.6</div></a>
+      <a href="../../../index.html"><div class="brand">MeloBot 2.5.7</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -150,7 +150,7 @@
     <img class="sidebar-logo" src="../../../_static/logo.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">MeloBot 2.5.6</span>
+  <span class="sidebar-brand-text">MeloBot 2.5.7</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="搜索" name="q" aria-label="搜索">
@@ -226,7 +226,13 @@ <h1>melobot.base.abc 源代码</h1><div class="highlight"><pre>
 <span class="kn">from</span> <span class="nn">abc</span> <span class="kn">import</span> <span class="n">ABC</span><span class="p">,</span> <span class="n">abstractmethod</span><span class="p">,</span> <span class="n">abstractproperty</span>
 <span class="kn">from</span> <span class="nn">copy</span> <span class="kn">import</span> <span class="n">deepcopy</span>
 
-<span class="kn">from</span> <span class="nn">.exceptions</span> <span class="kn">import</span> <span class="n">BotActionError</span><span class="p">,</span> <span class="n">BotCheckerError</span><span class="p">,</span> <span class="n">BotMatcherError</span><span class="p">,</span> <span class="n">TryFlagFailed</span>
+<span class="kn">from</span> <span class="nn">.exceptions</span> <span class="kn">import</span> <span class="p">(</span>
+    <span class="n">BotActionError</span><span class="p">,</span>
+    <span class="n">BotCheckerError</span><span class="p">,</span>
+    <span class="n">BotMatcherError</span><span class="p">,</span>
+    <span class="n">TryFlagFailed</span><span class="p">,</span>
+    <span class="n">get_better_exc</span><span class="p">,</span>
+<span class="p">)</span>
 <span class="kn">from</span> <span class="nn">.typing</span> <span class="kn">import</span> <span class="p">(</span>
     <span class="n">TYPE_CHECKING</span><span class="p">,</span>
     <span class="n">Any</span><span class="p">,</span>
@@ -264,24 +270,21 @@ <h1>melobot.base.abc 源代码</h1><div class="highlight"><pre>
 <span class="sd">       一般无需手动实例化该类，多数情况会直接使用本类对象，或将本类用作类型注解。</span>
 <span class="sd">    &quot;&quot;&quot;</span>
 
-    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span>
-        <span class="bp">self</span><span class="p">,</span>
-        <span class="n">max_retry</span><span class="p">:</span> <span class="nb">int</span><span class="p">,</span>
-        <span class="n">retry_delay</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
-        <span class="n">cd_time</span><span class="p">:</span> <span class="nb">float</span><span class="p">,</span>
-    <span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
+    <span class="k">def</span> <span class="fm">__init__</span><span class="p">(</span><span class="bp">self</span><span class="p">,</span> <span class="n">cd_time</span><span class="p">:</span> <span class="nb">float</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="nb">super</span><span class="p">()</span><span class="o">.</span><span class="fm">__init__</span><span class="p">()</span>
+        <span class="c1">#: 连接器的日志器</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="p">:</span> <span class="s2">&quot;Logger&quot;</span>
         <span class="c1">#: 是否在 slack 状态</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">slack</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
-        <span class="c1">#: 连接失败最大重试次数</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">max_retry</span><span class="p">:</span> <span class="nb">int</span> <span class="o">=</span> <span class="n">max_retry</span>
-        <span class="c1">#: 连接失败重试间隔</span>
-        <span class="bp">self</span><span class="o">.</span><span class="n">retry_delay</span><span class="p">:</span> <span class="nb">float</span> <span class="o">=</span> <span class="n">retry_delay</span> <span class="k">if</span> <span class="n">retry_delay</span> <span class="o">&gt;</span> <span class="mi">0</span> <span class="k">else</span> <span class="mi">0</span>
         <span class="c1">#: 连接器发送行为操作的冷却时间</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">cd_time</span> <span class="o">=</span> <span class="n">cd_time</span>
 
         <span class="bp">self</span><span class="o">.</span><span class="n">_ref_flag</span><span class="p">:</span> <span class="nb">bool</span> <span class="o">=</span> <span class="kc">False</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_ready_signal</span> <span class="o">=</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">Event</span><span class="p">()</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_event_builder</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="s2">&quot;BotEventBuilder&quot;</span><span class="p">]</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_bot_bus</span><span class="p">:</span> <span class="s2">&quot;BotHookBus&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_common_dispatcher</span><span class="p">:</span> <span class="s2">&quot;BotDispatcher&quot;</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_resp_dispatcher</span><span class="p">:</span> <span class="s2">&quot;BotResponder&quot;</span>
 
     <span class="nd">@abstractmethod</span>
     <span class="k">async</span> <span class="k">def</span> <span class="fm">__aenter__</span><span class="p">(</span><span class="bp">self</span><span class="p">):</span>
@@ -291,12 +294,17 @@ <h1>melobot.base.abc 源代码</h1><div class="highlight"><pre>
     <span class="k">async</span> <span class="k">def</span> <span class="fm">__aexit__</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span> <span class="n">exc_type</span><span class="p">:</span> <span class="n">Type</span><span class="p">[</span><span class="ne">Exception</span><span class="p">],</span> <span class="n">exc_val</span><span class="p">:</span> <span class="ne">Exception</span><span class="p">,</span> <span class="n">exc_tb</span><span class="p">:</span> <span class="n">ModuleType</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">bool</span><span class="p">:</span>
-        <span class="k">pass</span>
+        <span class="k">if</span> <span class="n">exc_type</span> <span class="ow">is</span> <span class="kc">None</span><span class="p">:</span>
+            <span class="k">return</span> <span class="kc">True</span>
+        <span class="k">elif</span> <span class="n">exc_type</span> <span class="o">==</span> <span class="n">asyncio</span><span class="o">.</span><span class="n">CancelledError</span><span class="p">:</span>
+            <span class="k">return</span> <span class="kc">True</span>
+        <span class="k">else</span><span class="p">:</span>
+            <span class="bp">self</span><span class="o">.</span><span class="n">logger</span><span class="o">.</span><span class="n">error</span><span class="p">(</span><span class="s2">&quot;连接器出现预期外的异常：</span><span class="se">\n</span><span class="s2">&quot;</span> <span class="o">+</span> <span class="n">get_better_exc</span><span class="p">(</span><span class="n">exc_val</span><span class="p">))</span>
+            <span class="k">return</span> <span class="kc">False</span>
 
     <span class="k">def</span> <span class="nf">_set_ready</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
         <span class="bp">self</span><span class="o">.</span><span class="n">_ready_signal</span><span class="o">.</span><span class="n">set</span><span class="p">()</span>
 
-    <span class="nd">@abstractmethod</span>
     <span class="k">def</span> <span class="nf">_bind</span><span class="p">(</span>
         <span class="bp">self</span><span class="p">,</span>
         <span class="n">dispatcher</span><span class="p">:</span> <span class="s2">&quot;BotDispatcher&quot;</span><span class="p">,</span>
@@ -305,10 +313,14 @@ <h1>melobot.base.abc 源代码</h1><div class="highlight"><pre>
         <span class="n">bot_bus</span><span class="p">:</span> <span class="s2">&quot;BotHookBus&quot;</span><span class="p">,</span>
         <span class="n">logger</span><span class="p">:</span> <span class="s2">&quot;Logger&quot;</span><span class="p">,</span>
     <span class="p">)</span> <span class="o">-&gt;</span> <span class="kc">None</span><span class="p">:</span>
-        <span class="k">pass</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_event_builder</span> <span class="o">=</span> <span class="n">event_builder</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_bot_bus</span> <span class="o">=</span> <span class="n">bot_bus</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">logger</span> <span class="o">=</span> <span class="n">logger</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_common_dispatcher</span> <span class="o">=</span> <span class="n">dispatcher</span>
+        <span class="bp">self</span><span class="o">.</span><span class="n">_resp_dispatcher</span> <span class="o">=</span> <span class="n">responder</span>
 
     <span class="nd">@abstractmethod</span>
-    <span class="k">async</span> <span class="k">def</span> <span class="nf">_start_tasks</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">]:</span>
+    <span class="k">async</span> <span class="k">def</span> <span class="nf">_alive_tasks</span><span class="p">(</span><span class="bp">self</span><span class="p">)</span> <span class="o">-&gt;</span> <span class="nb">list</span><span class="p">[</span><span class="n">asyncio</span><span class="o">.</span><span class="n">Task</span><span class="p">]:</span>
         <span class="k">pass</span>
 
     <span class="nd">@abstractmethod</span>
@@ -853,7 +865,7 @@ <h1>melobot.base.abc 源代码</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=50123eb5"></script>
+</div><script src="../../../_static/documentation_options.js?v=42d402af"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/_modules/melobot/base/exceptions.html b/_modules/melobot/base/exceptions.html
@@ -6,7 +6,7 @@
         <link rel="canonical" href="/melobot/_modules/melobot/base/exceptions.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>melobot.base.exceptions - MeloBot 2.5.6</title>
+        <title>melobot.base.exceptions - MeloBot 2.5.7</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" />
@@ -124,7 +124,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">MeloBot 2.5.6</div></a>
+      <a href="../../../index.html"><div class="brand">MeloBot 2.5.7</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -150,7 +150,7 @@
     <img class="sidebar-logo" src="../../../_static/logo.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">MeloBot 2.5.6</span>
+  <span class="sidebar-brand-text">MeloBot 2.5.7</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="搜索" name="q" aria-label="搜索">
@@ -401,7 +401,7 @@ <h1>melobot.base.exceptions 源代码</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=50123eb5"></script>
+</div><script src="../../../_static/documentation_options.js?v=42d402af"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=32e29ea5"></script>

diff --git a/_modules/melobot/base/tools.html b/_modules/melobot/base/tools.html
@@ -6,7 +6,7 @@
         <link rel="canonical" href="/melobot/_modules/melobot/base/tools.html" />
 
     <!-- Generated with Sphinx 7.2.6 and Furo 2024.01.29 -->
-        <title>melobot.base.tools - MeloBot 2.5.6</title>
+        <title>melobot.base.tools - MeloBot 2.5.7</title>
       <link rel="stylesheet" type="text/css" href="../../../_static/pygments.css?v=a746c00c" />
     <link rel="stylesheet" type="text/css" href="../../../_static/styles/furo.css?v=135e06be" />
     <link rel="stylesheet" type="text/css" href="../../../_static/copybutton.css?v=76b2166b" />
@@ -124,7 +124,7 @@
       </label>
     </div>
     <div class="header-center">
-      <a href="../../../index.html"><div class="brand">MeloBot 2.5.6</div></a>
+      <a href="../../../index.html"><div class="brand">MeloBot 2.5.7</div></a>
     </div>
     <div class="header-right">
       <div class="theme-toggle-container theme-toggle-header">
@@ -150,7 +150,7 @@
     <img class="sidebar-logo" src="../../../_static/logo.png" alt="Logo"/>
   </div>
 
-  <span class="sidebar-brand-text">MeloBot 2.5.6</span>
+  <span class="sidebar-brand-text">MeloBot 2.5.7</span>
 
 </a><form class="sidebar-search-container" method="get" action="../../../search.html" role="search">
   <input class="sidebar-search" placeholder="搜索" name="q" aria-label="搜索">
@@ -912,7 +912,7 @@ <h1>melobot.base.tools 源代码</h1><div class="highlight"><pre>
 
     </aside>
   </div>
-</div><script src="../../../_static/documentation_options.js?v=50123eb5"></script>
+</div><script src="../../../_static/documentation_options.js?v=42d402af"></script>
     <script src="../../../_static/doctools.js?v=888ff710"></script>
     <script src="../../../_static/sphinx_highlight.js?v=dc90522c"></script>
     <script src="../../../_static/scripts/furo.js?v=32e29ea5"></script>