-
Notifications
You must be signed in to change notification settings - Fork 288
Expand file tree
/
Copy pathmessages.html
More file actions
611 lines (611 loc) · 33 KB
/
messages.html
File metadata and controls
611 lines (611 loc) · 33 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1">
<meta name="generator" content="pdoc3 0.11.5">
<title>slack_bolt.logger.messages API documentation</title>
<meta name="description" content="">
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/sanitize.min.css" integrity="sha512-y1dtMcuvtTMJc1yPgEqF0ZjQbhnc/bFhyvIyVNb9Zk5mIGtqVaAB1Ttl28su8AvFMOY0EwRbAe+HCLqj6W7/KA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/10up-sanitize.css/13.0.0/typography.min.css" integrity="sha512-Y1DYSb995BAfxobCkKepB1BqJJTPrOp3zPL74AWFugHHmmdcvO+C48WLrUOlhGMc0QG7AE3f7gmvvcrmX2fDoA==" crossorigin>
<link rel="stylesheet" href="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/styles/default.min.css" crossorigin>
<style>:root{--highlight-color:#fe9}.flex{display:flex !important}body{line-height:1.5em}#content{padding:20px}#sidebar{padding:1.5em;overflow:hidden}#sidebar > *:last-child{margin-bottom:2cm}.http-server-breadcrumbs{font-size:130%;margin:0 0 15px 0}#footer{font-size:.75em;padding:5px 30px;border-top:1px solid #ddd;text-align:right}#footer p{margin:0 0 0 1em;display:inline-block}#footer p:last-child{margin-right:30px}h1,h2,h3,h4,h5{font-weight:300}h1{font-size:2.5em;line-height:1.1em}h2{font-size:1.75em;margin:2em 0 .50em 0}h3{font-size:1.4em;margin:1.6em 0 .7em 0}h4{margin:0;font-size:105%}h1:target,h2:target,h3:target,h4:target,h5:target,h6:target{background:var(--highlight-color);padding:.2em 0}a{color:#058;text-decoration:none;transition:color .2s ease-in-out}a:visited{color:#503}a:hover{color:#b62}.title code{font-weight:bold}h2[id^="header-"]{margin-top:2em}.ident{color:#900;font-weight:bold}pre code{font-size:.8em;line-height:1.4em;padding:1em;display:block}code{background:#f3f3f3;font-family:"DejaVu Sans Mono",monospace;padding:1px 4px;overflow-wrap:break-word}h1 code{background:transparent}pre{border-top:1px solid #ccc;border-bottom:1px solid #ccc;margin:1em 0}#http-server-module-list{display:flex;flex-flow:column}#http-server-module-list div{display:flex}#http-server-module-list dt{min-width:10%}#http-server-module-list p{margin-top:0}.toc ul,#index{list-style-type:none;margin:0;padding:0}#index code{background:transparent}#index h3{border-bottom:1px solid #ddd}#index ul{padding:0}#index h4{margin-top:.6em;font-weight:bold}@media (min-width:200ex){#index .two-column{column-count:2}}@media (min-width:300ex){#index .two-column{column-count:3}}dl{margin-bottom:2em}dl dl:last-child{margin-bottom:4em}dd{margin:0 0 1em 3em}#header-classes + dl > dd{margin-bottom:3em}dd dd{margin-left:2em}dd p{margin:10px 0}.name{background:#eee;font-size:.85em;padding:5px 10px;display:inline-block;min-width:40%}.name:hover{background:#e0e0e0}dt:target .name{background:var(--highlight-color)}.name > span:first-child{white-space:nowrap}.name.class > span:nth-child(2){margin-left:.4em}.inherited{color:#999;border-left:5px solid #eee;padding-left:1em}.inheritance em{font-style:normal;font-weight:bold}.desc h2{font-weight:400;font-size:1.25em}.desc h3{font-size:1em}.desc dt code{background:inherit}.source > summary,.git-link-div{color:#666;text-align:right;font-weight:400;font-size:.8em;text-transform:uppercase}.source summary > *{white-space:nowrap;cursor:pointer}.git-link{color:inherit;margin-left:1em}.source pre{max-height:500px;overflow:auto;margin:0}.source pre code{font-size:12px;overflow:visible;min-width:max-content}.hlist{list-style:none}.hlist li{display:inline}.hlist li:after{content:',\2002'}.hlist li:last-child:after{content:none}.hlist .hlist{display:inline;padding-left:1em}img{max-width:100%}td{padding:0 .5em}.admonition{padding:.1em 1em;margin:1em 0}.admonition-title{font-weight:bold}.admonition.note,.admonition.info,.admonition.important{background:#aef}.admonition.todo,.admonition.versionadded,.admonition.tip,.admonition.hint{background:#dfd}.admonition.warning,.admonition.versionchanged,.admonition.deprecated{background:#fd4}.admonition.error,.admonition.danger,.admonition.caution{background:lightpink}</style>
<style media="screen and (min-width: 700px)">@media screen and (min-width:700px){#sidebar{width:30%;height:100vh;overflow:auto;position:sticky;top:0}#content{width:70%;max-width:100ch;padding:3em 4em;border-left:1px solid #ddd}pre code{font-size:1em}.name{font-size:1em}main{display:flex;flex-direction:row-reverse;justify-content:flex-end}.toc ul ul,#index ul ul{padding-left:1em}.toc > ul > li{margin-top:.5em}}</style>
<style media="print">@media print{#sidebar h1{page-break-before:always}.source{display:none}}@media print{*{background:transparent !important;color:#000 !important;box-shadow:none !important;text-shadow:none !important}a[href]:after{content:" (" attr(href) ")";font-size:90%}a[href][title]:after{content:none}abbr[title]:after{content:" (" attr(title) ")"}.ir a:after,a[href^="javascript:"]:after,a[href^="#"]:after{content:""}pre,blockquote{border:1px solid #999;page-break-inside:avoid}thead{display:table-header-group}tr,img{page-break-inside:avoid}img{max-width:100% !important}@page{margin:0.5cm}p,h2,h3{orphans:3;widows:3}h1,h2,h3,h4,h5,h6{page-break-after:avoid}}</style>
<script defer src="https://cdnjs.cloudflare.com/ajax/libs/highlight.js/11.9.0/highlight.min.js" integrity="sha512-D9gUyxqja7hBtkWpPWGt9wfbfaMGVt9gnyCvYa+jojwwPHLCzUm5i8rpk7vD7wNee9bA35eYIjobYPaQuKS1MQ==" crossorigin></script>
<script>window.addEventListener('DOMContentLoaded', () => {
hljs.configure({languages: ['bash', 'css', 'diff', 'graphql', 'ini', 'javascript', 'json', 'plaintext', 'python', 'python-repl', 'rust', 'shell', 'sql', 'typescript', 'xml', 'yaml']});
hljs.highlightAll();
/* Collapse source docstrings */
setTimeout(() => {
[...document.querySelectorAll('.hljs.language-python > .hljs-string')]
.filter(el => el.innerHTML.length > 200 && ['"""', "'''"].includes(el.innerHTML.substring(0, 3)))
.forEach(el => {
let d = document.createElement('details');
d.classList.add('hljs-string');
d.innerHTML = '<summary>"""</summary>' + el.innerHTML.substring(3);
el.replaceWith(d);
});
}, 100);
})</script>
</head>
<body>
<main>
<article id="content">
<header>
<h1 class="title">Module <code>slack_bolt.logger.messages</code></h1>
</header>
<section id="section-intro">
</section>
<section>
</section>
<section>
</section>
<section>
<h2 class="section-title" id="header-functions">Functions</h2>
<dl>
<dt id="slack_bolt.logger.messages.debug_applying_middleware"><code class="name flex">
<span>def <span class="ident">debug_applying_middleware</span></span>(<span>middleware_name: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def debug_applying_middleware(middleware_name: str) -> str:
return f"Applying {middleware_name}"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.debug_checking_listener"><code class="name flex">
<span>def <span class="ident">debug_checking_listener</span></span>(<span>listener_name: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def debug_checking_listener(listener_name: str) -> str:
return f"Checking listener: {listener_name} ..."</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.debug_responding"><code class="name flex">
<span>def <span class="ident">debug_responding</span></span>(<span>status: int, body: str, millis: int) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def debug_responding(status: int, body: str, millis: int) -> str:
return f'Responding with status: {status} body: "{body}" ({millis} millis)'</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.debug_return_listener_middleware_response"><code class="name flex">
<span>def <span class="ident">debug_return_listener_middleware_response</span></span>(<span>listener_name: str, status: int, body: str, starting_time: float) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def debug_return_listener_middleware_response(listener_name: str, status: int, body: str, starting_time: float) -> str:
millis = int((time.time() - starting_time) * 1000)
return (
"Responding with listener middleware's response - "
f"listener: {listener_name}, status: {status}, body: {body} ({millis} millis)"
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.debug_running_lazy_listener"><code class="name flex">
<span>def <span class="ident">debug_running_lazy_listener</span></span>(<span>func_name: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def debug_running_lazy_listener(func_name: str) -> str:
return f"Running lazy listener: {func_name} ..."</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.debug_running_listener"><code class="name flex">
<span>def <span class="ident">debug_running_listener</span></span>(<span>listener_name: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def debug_running_listener(listener_name: str) -> str:
return f"Running listener: {listener_name} ..."</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_auth_test_failure"><code class="name flex">
<span>def <span class="ident">error_auth_test_failure</span></span>(<span>error_response: slack_sdk.web.slack_response.SlackResponse) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_auth_test_failure(error_response: SlackResponse) -> str:
return f"`token` is invalid (auth.test result: {error_response})"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_authorize_conflicts"><code class="name flex">
<span>def <span class="ident">error_authorize_conflicts</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_authorize_conflicts() -> str:
return "`authorize` in the top-level arguments is not allowed when you pass either `oauth_settings` or `oauth_flow`"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_client_invalid_type"><code class="name flex">
<span>def <span class="ident">error_client_invalid_type</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_client_invalid_type() -> str:
return "`client` must be a slack_sdk.web.WebClient"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_client_invalid_type_async"><code class="name flex">
<span>def <span class="ident">error_client_invalid_type_async</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_client_invalid_type_async() -> str:
return "`client` must be a slack_sdk.web.async_client.AsyncWebClient"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_installation_store_required_for_builtin_listeners"><code class="name flex">
<span>def <span class="ident">error_installation_store_required_for_builtin_listeners</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_installation_store_required_for_builtin_listeners() -> str:
return (
"To use the event listeners for token revocation handling, "
"setting a valid `installation_store` to `App`/`AsyncApp` is required."
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_listener_function_must_be_coro_func"><code class="name flex">
<span>def <span class="ident">error_listener_function_must_be_coro_func</span></span>(<span>func_name: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_listener_function_must_be_coro_func(func_name: str) -> str:
return f"The listener function ({func_name}) is not a coroutine function."</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_message_event_type"><code class="name flex">
<span>def <span class="ident">error_message_event_type</span></span>(<span>event_type: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_message_event_type(event_type: str) -> str:
return (
f'Although the document mentions "{event_type}", '
'it is not a valid event type. Use "message" instead. '
"If you want to filter message events, you can use `event.channel_type` for it."
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_oauth_flow_invalid_type_async"><code class="name flex">
<span>def <span class="ident">error_oauth_flow_invalid_type_async</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_oauth_flow_invalid_type_async() -> str:
return "`oauth_flow` must be a slack_bolt.oauth.async_oauth_flow.AsyncOAuthFlow"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_oauth_flow_or_authorize_required"><code class="name flex">
<span>def <span class="ident">error_oauth_flow_or_authorize_required</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_oauth_flow_or_authorize_required() -> str:
return "`oauth_flow` or `authorize` must be configured to make a Bolt app"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_oauth_settings_invalid_type_async"><code class="name flex">
<span>def <span class="ident">error_oauth_settings_invalid_type_async</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_oauth_settings_invalid_type_async() -> str:
return "`oauth_settings` must be a slack_bolt.oauth.async_oauth_settings.AsyncOAuthSettings"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_token_required"><code class="name flex">
<span>def <span class="ident">error_token_required</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_token_required() -> str:
return "Either an env variable `SLACK_BOT_TOKEN` " "or `token` argument in the constructor is required."</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.error_unexpected_listener_middleware"><code class="name flex">
<span>def <span class="ident">error_unexpected_listener_middleware</span></span>(<span>middleware_type) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def error_unexpected_listener_middleware(middleware_type) -> str:
return f"Unexpected value for a listener middleware: {middleware_type}"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.info_default_oauth_settings_loaded"><code class="name flex">
<span>def <span class="ident">info_default_oauth_settings_loaded</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def info_default_oauth_settings_loaded() -> str:
return (
"As you've set SLACK_CLIENT_ID and SLACK_CLIENT_SECRET env variables, "
"Bolt has enabled the file-based InstallationStore/OAuthStateStore for you. "
"Note that these file-based stores are for local development. "
"If you'd like to use a different data store, set the oauth_settings argument in the App constructor. "
"Please refer to https://slack.dev/bolt-python/concepts#authenticating-oauth for more details."
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.warning_bot_only_conflicts"><code class="name flex">
<span>def <span class="ident">warning_bot_only_conflicts</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def warning_bot_only_conflicts() -> str:
return (
"installation_store_bot_only exists in both App and OAuthFlow.settings. "
"The one passed in App constructor is used."
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.warning_client_prioritized_and_token_skipped"><code class="name flex">
<span>def <span class="ident">warning_client_prioritized_and_token_skipped</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def warning_client_prioritized_and_token_skipped() -> str:
return "As you gave `client` as well, `token` will be unused."</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.warning_did_not_call_ack"><code class="name flex">
<span>def <span class="ident">warning_did_not_call_ack</span></span>(<span>listener_name: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def warning_did_not_call_ack(listener_name: str) -> str:
return f"{listener_name} didn't call ack()"</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.warning_installation_store_conflicts"><code class="name flex">
<span>def <span class="ident">warning_installation_store_conflicts</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def warning_installation_store_conflicts() -> str:
return "As you gave both `installation_store` and `oauth_settings`/`auth_flow`, the top level one is unused."</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.warning_skip_uncommon_arg_name"><code class="name flex">
<span>def <span class="ident">warning_skip_uncommon_arg_name</span></span>(<span>arg_name: str) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def warning_skip_uncommon_arg_name(arg_name: str) -> str:
return (
f"Bolt skips injecting a value to the first keyword argument ({arg_name}). "
"If it is self/cls of a method, we recommend using the common names."
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.warning_token_skipped"><code class="name flex">
<span>def <span class="ident">warning_token_skipped</span></span>(<span>) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def warning_token_skipped() -> str:
return (
"As `installation_store` or `authorize` has been used, " "`token` (or SLACK_BOT_TOKEN env variable) will be ignored."
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.warning_unhandled_by_global_middleware"><code class="name flex">
<span>def <span class="ident">warning_unhandled_by_global_middleware</span></span>(<span>name: str,<br>req: <a title="slack_bolt.request.request.BoltRequest" href="../request/request.html#slack_bolt.request.request.BoltRequest">BoltRequest</a> | ForwardRef('AsyncBoltRequest')) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def warning_unhandled_by_global_middleware(
name: str, req: Union[BoltRequest, "AsyncBoltRequest"] # type: ignore[name-defined]
) -> str:
return (
f"A global middleware ({name}) skipped calling either `next()` or `next_()` "
f"without providing a response for the request ({req.body})"
)</code></pre>
</details>
<div class="desc"></div>
</dd>
<dt id="slack_bolt.logger.messages.warning_unhandled_request"><code class="name flex">
<span>def <span class="ident">warning_unhandled_request</span></span>(<span>req: <a title="slack_bolt.request.request.BoltRequest" href="../request/request.html#slack_bolt.request.request.BoltRequest">BoltRequest</a> | ForwardRef('AsyncBoltRequest')) ‑> str</span>
</code></dt>
<dd>
<details class="source">
<summary>
<span>Expand source code</span>
</summary>
<pre><code class="python">def warning_unhandled_request(
req: Union[BoltRequest, "AsyncBoltRequest"], # type: ignore[name-defined]
) -> str:
filtered_body = _build_filtered_body(req.body)
default_message = f"Unhandled request ({filtered_body})"
is_async = not isinstance(req, BoltRequest)
if is_workflow_step_edit(req.body) or is_workflow_step_save(req.body) or is_workflow_step_execute(req.body):
# @app.step
callback_id = (
filtered_body.get("callback_id") or filtered_body.get("view", {}).get("callback_id") or "your-callback-id"
)
return _build_unhandled_request_suggestion(
default_message,
f"""
from slack_bolt.workflows.step{'.async_step' if is_async else ''} import {'Async' if is_async else ''}WorkflowStep
ws = {'Async' if is_async else ''}WorkflowStep(
callback_id="{callback_id}",
edit=edit,
save=save,
execute=execute,
)
# Pass Step to set up listeners
app.step(ws)
""",
)
if is_action(req.body):
# @app.action
action_id_or_callback_id = req.body.get("callback_id")
if req.body.get("type") == "block_actions":
action_id_or_callback_id = req.body["actions"][0].get("action_id")
return _build_unhandled_request_suggestion(
default_message,
f"""
@app.action("{action_id_or_callback_id}")
{'async ' if is_async else ''}def handle_some_action(ack, body, logger):
{'await ' if is_async else ''}ack()
logger.info(body)
""",
)
if is_options(req.body):
# @app.options
constraints = '"action-id"'
if req.body.get("action_id") is not None:
constraints = '"' + req.body["action_id"] + '"'
elif req.body.get("type") == "dialog_suggestion":
constraints = f"""{{"type": "dialog_suggestion", "callback_id": "{req.body.get('callback_id')}"}}"""
return _build_unhandled_request_suggestion(
default_message,
f"""
@app.options({constraints})
{'async ' if is_async else ''}def handle_some_options(ack):
{'await ' if is_async else ''}ack(options=[ ... ])
""",
)
if is_shortcut(req.body):
# @app.shortcut
id = req.body.get("action_id") or req.body.get("callback_id")
return _build_unhandled_request_suggestion(
default_message,
f"""
@app.shortcut("{id}")
{'async ' if is_async else ''}def handle_shortcuts(ack, body, logger):
{'await ' if is_async else ''}ack()
logger.info(body)
""",
)
if is_view_submission(req.body):
# @app.view
return _build_unhandled_request_suggestion(
default_message,
f"""
@app.view("{req.body.get('view', {}).get('callback_id', 'modal-view-id')}")
{'async ' if is_async else ''}def handle_view_submission_events(ack, body, logger):
{'await ' if is_async else ''}ack()
logger.info(body)
""",
)
if is_view_closed(req.body):
# @app.view
return _build_unhandled_request_suggestion(
default_message,
f"""
@app.view_closed("{req.body.get('view', {}).get('callback_id', 'modal-view-id')}")
{'async ' if is_async else ''}def handle_view_closed_events(ack, body, logger):
{'await ' if is_async else ''}ack()
logger.info(body)
""",
)
if is_event(req.body):
# @app.event
event = req.body.get("event", {})
event_type = event.get("type")
if is_function(req.body):
# @app.function
callback_id = event.get("function", {}).get("callback_id", "function_id")
return _build_unhandled_request_suggestion(
default_message,
f"""
@app.function("{callback_id}")
{'async ' if is_async else ''}def handle_some_function(ack, body, complete, fail, logger):
{'await ' if is_async else ''}ack()
logger.info(body)
try:
# TODO: do something here
outputs = {{}}
{'await ' if is_async else ''}complete(outputs=outputs)
except Exception as e:
error = f"Failed to handle a function request (error: {{e}})"
{'await ' if is_async else ''}fail(error=error)
""",
)
return _build_unhandled_request_suggestion(
default_message,
f"""
@app.event("{event_type}")
{'async ' if is_async else ''}def handle_{event_type}_events(body, logger):
logger.info(body)
""",
)
if is_slash_command(req.body):
# @app.command
command = req.body.get("command", "/your-command")
return _build_unhandled_request_suggestion(
default_message,
f"""
@app.command("{command}")
{'async ' if is_async else ''}def handle_some_command(ack, body, logger):
{'await ' if is_async else ''}ack()
logger.info(body)
""",
)
return default_message</code></pre>
</details>
<div class="desc"></div>
</dd>
</dl>
</section>
<section>
</section>
</article>
<nav id="sidebar">
<div class="toc">
<ul></ul>
</div>
<ul id="index">
<li><h3>Super-module</h3>
<ul>
<li><code><a title="slack_bolt.logger" href="index.html">slack_bolt.logger</a></code></li>
</ul>
</li>
<li><h3><a href="#header-functions">Functions</a></h3>
<ul class="">
<li><code><a title="slack_bolt.logger.messages.debug_applying_middleware" href="#slack_bolt.logger.messages.debug_applying_middleware">debug_applying_middleware</a></code></li>
<li><code><a title="slack_bolt.logger.messages.debug_checking_listener" href="#slack_bolt.logger.messages.debug_checking_listener">debug_checking_listener</a></code></li>
<li><code><a title="slack_bolt.logger.messages.debug_responding" href="#slack_bolt.logger.messages.debug_responding">debug_responding</a></code></li>
<li><code><a title="slack_bolt.logger.messages.debug_return_listener_middleware_response" href="#slack_bolt.logger.messages.debug_return_listener_middleware_response">debug_return_listener_middleware_response</a></code></li>
<li><code><a title="slack_bolt.logger.messages.debug_running_lazy_listener" href="#slack_bolt.logger.messages.debug_running_lazy_listener">debug_running_lazy_listener</a></code></li>
<li><code><a title="slack_bolt.logger.messages.debug_running_listener" href="#slack_bolt.logger.messages.debug_running_listener">debug_running_listener</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_auth_test_failure" href="#slack_bolt.logger.messages.error_auth_test_failure">error_auth_test_failure</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_authorize_conflicts" href="#slack_bolt.logger.messages.error_authorize_conflicts">error_authorize_conflicts</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_client_invalid_type" href="#slack_bolt.logger.messages.error_client_invalid_type">error_client_invalid_type</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_client_invalid_type_async" href="#slack_bolt.logger.messages.error_client_invalid_type_async">error_client_invalid_type_async</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_installation_store_required_for_builtin_listeners" href="#slack_bolt.logger.messages.error_installation_store_required_for_builtin_listeners">error_installation_store_required_for_builtin_listeners</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_listener_function_must_be_coro_func" href="#slack_bolt.logger.messages.error_listener_function_must_be_coro_func">error_listener_function_must_be_coro_func</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_message_event_type" href="#slack_bolt.logger.messages.error_message_event_type">error_message_event_type</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_oauth_flow_invalid_type_async" href="#slack_bolt.logger.messages.error_oauth_flow_invalid_type_async">error_oauth_flow_invalid_type_async</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_oauth_flow_or_authorize_required" href="#slack_bolt.logger.messages.error_oauth_flow_or_authorize_required">error_oauth_flow_or_authorize_required</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_oauth_settings_invalid_type_async" href="#slack_bolt.logger.messages.error_oauth_settings_invalid_type_async">error_oauth_settings_invalid_type_async</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_token_required" href="#slack_bolt.logger.messages.error_token_required">error_token_required</a></code></li>
<li><code><a title="slack_bolt.logger.messages.error_unexpected_listener_middleware" href="#slack_bolt.logger.messages.error_unexpected_listener_middleware">error_unexpected_listener_middleware</a></code></li>
<li><code><a title="slack_bolt.logger.messages.info_default_oauth_settings_loaded" href="#slack_bolt.logger.messages.info_default_oauth_settings_loaded">info_default_oauth_settings_loaded</a></code></li>
<li><code><a title="slack_bolt.logger.messages.warning_bot_only_conflicts" href="#slack_bolt.logger.messages.warning_bot_only_conflicts">warning_bot_only_conflicts</a></code></li>
<li><code><a title="slack_bolt.logger.messages.warning_client_prioritized_and_token_skipped" href="#slack_bolt.logger.messages.warning_client_prioritized_and_token_skipped">warning_client_prioritized_and_token_skipped</a></code></li>
<li><code><a title="slack_bolt.logger.messages.warning_did_not_call_ack" href="#slack_bolt.logger.messages.warning_did_not_call_ack">warning_did_not_call_ack</a></code></li>
<li><code><a title="slack_bolt.logger.messages.warning_installation_store_conflicts" href="#slack_bolt.logger.messages.warning_installation_store_conflicts">warning_installation_store_conflicts</a></code></li>
<li><code><a title="slack_bolt.logger.messages.warning_skip_uncommon_arg_name" href="#slack_bolt.logger.messages.warning_skip_uncommon_arg_name">warning_skip_uncommon_arg_name</a></code></li>
<li><code><a title="slack_bolt.logger.messages.warning_token_skipped" href="#slack_bolt.logger.messages.warning_token_skipped">warning_token_skipped</a></code></li>
<li><code><a title="slack_bolt.logger.messages.warning_unhandled_by_global_middleware" href="#slack_bolt.logger.messages.warning_unhandled_by_global_middleware">warning_unhandled_by_global_middleware</a></code></li>
<li><code><a title="slack_bolt.logger.messages.warning_unhandled_request" href="#slack_bolt.logger.messages.warning_unhandled_request">warning_unhandled_request</a></code></li>
</ul>
</li>
</ul>
</nav>
</main>
<footer id="footer">
<p>Generated by <a href="https://pdoc3.github.io/pdoc" title="pdoc: Python API documentation generator"><cite>pdoc</cite> 0.11.5</a>.</p>
</footer>
</body>
</html>