Skip to content

Commit e5f4821

Browse files
seratchseratch
committed
Add Socket Mode adapter module documents
1 parent 11e202a commit e5f4821

File tree

22 files changed

+550
-160
lines changed

22 files changed

+550
-160
lines changed

‎README.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
[![Build Status][build-image]][build-url]
66
[![Codecov][codecov-image]][codecov-url]
77

8-
A Python framework to build Slack apps in a flash with the latest platform features. Read the [getting started guide](https://slack.dev/bolt-python/tutorial/getting-started) and look at our [code examples](https://github.com/slackapi/bolt-python/tree/main/examples) to learn how to build apps using Bolt.
8+
A Python framework to build Slack apps in a flash with the latest platform features. Read the [getting started guide](https://slack.dev/bolt-python/tutorial/getting-started) and look at our [code examples](https://github.com/slackapi/bolt-python/tree/main/examples) to learn how to build apps using Bolt. The Python module documents are available [here](https://slack.dev/bolt-python/api-docs/slack_bolt/).
99

1010
## Setup
1111

@@ -178,7 +178,7 @@ Apps can be run the same way as the syncronous example above. If you'd prefer an
178178

179179
## Getting Help
180180

181-
[The documentation](https://slack.dev/bolt-python) has more information on basic and advanced concepts for Bolt for Python.
181+
[The documentation](https://slack.dev/bolt-python) has more information on basic and advanced concepts for Bolt for Python. Also, all the Python module documents of this library are available [here](https://slack.dev/bolt-python/api-docs/slack_bolt/).
182182

183183
If you otherwise get stuck, we're here to help. The following are the best ways to get assistance working through your issue:
184184

‎docs/api-docs/slack_bolt/adapter/index.html‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -76,7 +76,7 @@ <h2 class="section-title" id="header-submodules">Sub-modules</h2>
7676
</dd>
7777
<dt><code class="name"><a title="slack_bolt.adapter.socket_mode" href="socket_mode/index.html">slack_bolt.adapter.socket_mode</a></code></dt>
7878
<dd>
79-
<div class="desc"></div>
79+
<div class="desc"><p>Socket Mode adapter package provides the following implementations. If you don't have strong reasons to use 3rd party library based adapters, we …</p></div>
8080
</dd>
8181
<dt><code class="name"><a title="slack_bolt.adapter.starlette" href="starlette/index.html">slack_bolt.adapter.starlette</a></code></dt>
8282
<dd>

‎docs/api-docs/slack_bolt/adapter/socket_mode/aiohttp/index.html‎

Lines changed: 64 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1" />
66
<meta name="generator" content="pdoc 0.9.2" />
77
<title>slack_bolt.adapter.socket_mode.aiohttp API documentation</title>
8-
<meta name="description" content="" />
8+
<meta name="description" content="[`aiohttp`](https://pypi.org/project/aiohttp/) based implementation / asyncio compatible" />
99
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/sanitize.min.css" integrity="sha256-PK9q560IAAa6WVRRh76LtCaI8pjTJ2z11v0miyNNjrs=" crossorigin>
1010
<link rel="preload stylesheet" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/11.0.1/typography.min.css" integrity="sha256-7l/o7C8jubJiy74VsKTidCy1yBkRtiUGbVkYBylBqUg=" crossorigin>
1111
<link rel="stylesheet preload" as="style" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/10.1.1/styles/github.min.css" crossorigin>
@@ -22,11 +22,13 @@
2222
<h1 class="title">Module <code>slack_bolt.adapter.socket_mode.aiohttp</code></h1>
2323
</header>
2424
<section id="section-intro">
25+
<p><a href="https://pypi.org/project/aiohttp/"><code>aiohttp</code></a> based implementation / asyncio compatible</p>
2526
<details class="source">
2627
<summary>
2728
<span>Expand source code</span>
2829
</summary>
29-
<pre><code class="python">import os
30+
<pre><code class="python">&#34;&#34;&#34;[`aiohttp`](https://pypi.org/project/aiohttp/) based implementation / asyncio compatible&#34;&#34;&#34;
31+
import os
3032
from logging import Logger
3133
from time import time
3234
from typing import Optional
@@ -60,6 +62,16 @@ <h1 class="title">Module <code>slack_bolt.adapter.socket_mode.aiohttp</code></h1
6062
proxy: Optional[str] = None,
6163
ping_interval: float = 10,
6264
):
65+
&#34;&#34;&#34;Socket Mode adapter for Bolt apps
66+
67+
Args:
68+
app: The Bolt app
69+
app_token: App-level token starting with `xapp-`
70+
logger: Custom logger
71+
web_client: custom `slack_sdk.web.WebClient` instance
72+
proxy: HTTP proxy URL
73+
ping_interval: The ping-pong internal (seconds)
74+
&#34;&#34;&#34;
6375
self.app = app
6476
self.app_token = app_token or os.environ[&#34;SLACK_APP_TOKEN&#34;]
6577
self.client = SocketModeClient(
@@ -176,31 +188,40 @@ <h3>Class variables</h3>
176188
<div class="desc"></div>
177189
</dd>
178190
</dl>
179-
<h3>Methods</h3>
180-
<dl>
181-
<dt id="slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.handle"><code class="name flex">
182-
<span>async def <span class="ident">handle</span></span>(<span>self, client: slack_sdk.socket_mode.aiohttp.SocketModeClient, req: slack_sdk.socket_mode.request.SocketModeRequest) ‑> NoneType</span>
183-
</code></dt>
184-
<dd>
185-
<div class="desc"></div>
186-
<details class="source">
187-
<summary>
188-
<span>Expand source code</span>
189-
</summary>
190-
<pre><code class="python">async def handle(self, client: SocketModeClient, req: SocketModeRequest) -&gt; None:
191-
start = time()
192-
bolt_resp: BoltResponse = await run_async_bolt_app(self.app, req)
193-
await send_async_response(client, req, bolt_resp, start)</code></pre>
194-
</details>
195-
</dd>
196-
</dl>
191+
<h3>Inherited members</h3>
192+
<ul class="hlist">
193+
<li><code><b><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler">AsyncBaseSocketModeHandler</a></b></code>:
194+
<ul class="hlist">
195+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.close_async" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.close_async">close_async</a></code></li>
196+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.connect_async" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.connect_async">connect_async</a></code></li>
197+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.disconnect_async" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.disconnect_async">disconnect_async</a></code></li>
198+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.handle" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.handle">handle</a></code></li>
199+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.start_async" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.start_async">start_async</a></code></li>
200+
</ul>
201+
</li>
202+
</ul>
197203
</dd>
198204
<dt id="slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler"><code class="flex name class">
199205
<span>class <span class="ident">SocketModeHandler</span></span>
200206
<span>(</span><span>app: <a title="slack_bolt.app.app.App" href="../../../app/app.html#slack_bolt.app.app.App">App</a>, app_token: Optional[str] = None, logger: Optional[logging.Logger] = None, web_client: Optional[slack_sdk.web.async_client.AsyncWebClient] = None, proxy: Optional[str] = None, ping_interval: float = 10)</span>
201207
</code></dt>
202208
<dd>
203-
<div class="desc"></div>
209+
<div class="desc"><p>Socket Mode adapter for Bolt apps</p>
210+
<h2 id="args">Args</h2>
211+
<dl>
212+
<dt><strong><code>app</code></strong></dt>
213+
<dd>The Bolt app</dd>
214+
<dt><strong><code>app_token</code></strong></dt>
215+
<dd>App-level token starting with <code>xapp-</code></dd>
216+
<dt><strong><code>logger</code></strong></dt>
217+
<dd>Custom logger</dd>
218+
<dt><strong><code>web_client</code></strong></dt>
219+
<dd>custom <code>slack_sdk.web.WebClient</code> instance</dd>
220+
<dt><strong><code>proxy</code></strong></dt>
221+
<dd>HTTP proxy URL</dd>
222+
<dt><strong><code>ping_interval</code></strong></dt>
223+
<dd>The ping-pong internal (seconds)</dd>
224+
</dl></div>
204225
<details class="source">
205226
<summary>
206227
<span>Expand source code</span>
@@ -219,6 +240,16 @@ <h3>Methods</h3>
219240
proxy: Optional[str] = None,
220241
ping_interval: float = 10,
221242
):
243+
&#34;&#34;&#34;Socket Mode adapter for Bolt apps
244+
245+
Args:
246+
app: The Bolt app
247+
app_token: App-level token starting with `xapp-`
248+
logger: Custom logger
249+
web_client: custom `slack_sdk.web.WebClient` instance
250+
proxy: HTTP proxy URL
251+
ping_interval: The ping-pong internal (seconds)
252+
&#34;&#34;&#34;
222253
self.app = app
223254
self.app_token = app_token or os.environ[&#34;SLACK_APP_TOKEN&#34;]
224255
self.client = SocketModeClient(
@@ -254,24 +285,18 @@ <h3>Class variables</h3>
254285
<div class="desc"></div>
255286
</dd>
256287
</dl>
257-
<h3>Methods</h3>
258-
<dl>
259-
<dt id="slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.handle"><code class="name flex">
260-
<span>async def <span class="ident">handle</span></span>(<span>self, client: slack_sdk.socket_mode.aiohttp.SocketModeClient, req: slack_sdk.socket_mode.request.SocketModeRequest) ‑> NoneType</span>
261-
</code></dt>
262-
<dd>
263-
<div class="desc"></div>
264-
<details class="source">
265-
<summary>
266-
<span>Expand source code</span>
267-
</summary>
268-
<pre><code class="python">async def handle(self, client: SocketModeClient, req: SocketModeRequest) -&gt; None:
269-
start = time()
270-
bolt_resp: BoltResponse = run_bolt_app(self.app, req)
271-
await send_async_response(client, req, bolt_resp, start)</code></pre>
272-
</details>
273-
</dd>
274-
</dl>
288+
<h3>Inherited members</h3>
289+
<ul class="hlist">
290+
<li><code><b><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler">AsyncBaseSocketModeHandler</a></b></code>:
291+
<ul class="hlist">
292+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.close_async" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.close_async">close_async</a></code></li>
293+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.connect_async" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.connect_async">connect_async</a></code></li>
294+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.disconnect_async" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.disconnect_async">disconnect_async</a></code></li>
295+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.handle" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.handle">handle</a></code></li>
296+
<li><code><a title="slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.start_async" href="../async_base_handler.html#slack_bolt.adapter.socket_mode.async_base_handler.AsyncBaseSocketModeHandler.start_async">start_async</a></code></li>
297+
</ul>
298+
</li>
299+
</ul>
275300
</dd>
276301
</dl>
277302
</section>
@@ -295,7 +320,6 @@ <h4><code><a title="slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandle
295320
<li><code><a title="slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.app" href="#slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.app">app</a></code></li>
296321
<li><code><a title="slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.app_token" href="#slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.app_token">app_token</a></code></li>
297322
<li><code><a title="slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.client" href="#slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.client">client</a></code></li>
298-
<li><code><a title="slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.handle" href="#slack_bolt.adapter.socket_mode.aiohttp.AsyncSocketModeHandler.handle">handle</a></code></li>
299323
</ul>
300324
</li>
301325
<li>
@@ -304,7 +328,6 @@ <h4><code><a title="slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler" hr
304328
<li><code><a title="slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.app" href="#slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.app">app</a></code></li>
305329
<li><code><a title="slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.app_token" href="#slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.app_token">app_token</a></code></li>
306330
<li><code><a title="slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.client" href="#slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.client">client</a></code></li>
307-
<li><code><a title="slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.handle" href="#slack_bolt.adapter.socket_mode.aiohttp.SocketModeHandler.handle">handle</a></code></li>
308331
</ul>
309332
</li>
310333
</ul>

0 commit comments

Comments
 (0)