Skip to content

Commit ddffefc

Browse files
seratchseratch
committed
Update the documents
1 parent 92f2ad2 commit ddffefc

File tree

92 files changed

+2105
-5844
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

92 files changed

+2105
-5844
lines changed

‎docs/.buildinfo‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,4 @@
11
# Sphinx build info version 1
22
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
3-
config: 2028c7514a2495d4a303c389eaf023c5
3+
config: 63236e700a8b879338135cc5819717ea
44
tags: 645f666f9bcd5a90fca523b33c5a78b7

‎docs/api-docs/slack_sdk/aiohttp_version_checker.html‎

Lines changed: 2 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -45,9 +45,7 @@ <h1 class="title">Module <code>slack_sdk.aiohttp_version_checker</code></h1>
4545
if len(elements) &gt;= 3:
4646
# patch version can be a non-numeric value
4747
major, minor, patch = int(elements[0]), int(elements[1]), elements[2]
48-
if major &lt;= 2 or (
49-
major == 3 and (minor == 6 or (minor == 7 and patch == &#34;0&#34;))
50-
):
48+
if major &lt;= 2 or (major == 3 and (minor == 6 or (minor == 7 and patch == &#34;0&#34;))):
5149
print_warning(
5250
&#34;We highly recommend upgrading aiohttp to 3.7.3 or higher versions.&#34;
5351
&#34;An older version of the library may not work with the Slack server-side in the future.&#34;
@@ -79,9 +77,7 @@ <h2 class="section-title" id="header-functions">Functions</h2>
7977
if len(elements) &gt;= 3:
8078
# patch version can be a non-numeric value
8179
major, minor, patch = int(elements[0]), int(elements[1]), elements[2]
82-
if major &lt;= 2 or (
83-
major == 3 and (minor == 6 or (minor == 7 and patch == &#34;0&#34;))
84-
):
80+
if major &lt;= 2 or (major == 3 and (minor == 6 or (minor == 7 and patch == &#34;0&#34;))):
8581
print_warning(
8682
&#34;We highly recommend upgrading aiohttp to 3.7.3 or higher versions.&#34;
8783
&#34;An older version of the library may not work with the Slack server-side in the future.&#34;

‎docs/api-docs/slack_sdk/audit_logs/async_client.html‎

Lines changed: 6 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -140,13 +140,9 @@ <h2 id="args">Args</h2>
140140
self.trust_env_in_session = trust_env_in_session
141141
self.auth = auth
142142
self.default_headers = default_headers if default_headers else {}
143-
self.default_headers[&#34;User-Agent&#34;] = get_user_agent(
144-
user_agent_prefix, user_agent_suffix
145-
)
143+
self.default_headers[&#34;User-Agent&#34;] = get_user_agent(user_agent_prefix, user_agent_suffix)
146144
self.logger = logger if logger is not None else logging.getLogger(__name__)
147-
self.retry_handlers = (
148-
retry_handlers if retry_handlers is not None else async_default_handlers()
149-
)
145+
self.retry_handlers = retry_handlers if retry_handlers is not None else async_default_handlers()
150146

151147
if self.proxy is None or len(self.proxy.strip()) == 0:
152148
env_variable = load_http_proxy_from_env(self.logger)
@@ -327,8 +323,7 @@ <h2 id="args">Args</h2>
327323

328324
if self.logger.level &lt;= logging.DEBUG:
329325
headers_for_logging = {
330-
k: &#34;(redacted)&#34; if k.lower() == &#34;authorization&#34; else v
331-
for k, v in headers.items()
326+
k: &#34;(redacted)&#34; if k.lower() == &#34;authorization&#34; else v for k, v in headers.items()
332327
}
333328
self.logger.debug(
334329
f&#34;Sending a request - &#34;
@@ -345,14 +340,10 @@ <h2 id="args">Args</h2>
345340
retry_response = RetryHttpResponse(
346341
status_code=res.status,
347342
headers=res.headers,
348-
data=response_body.encode(&#34;utf-8&#34;)
349-
if response_body is not None
350-
else None,
343+
data=response_body.encode(&#34;utf-8&#34;) if response_body is not None else None,
351344
)
352345
except aiohttp.ContentTypeError:
353-
self.logger.debug(
354-
f&#34;No response data returned from the following API call: {url}.&#34;
355-
)
346+
self.logger.debug(f&#34;No response data returned from the following API call: {url}.&#34;)
356347
except json.decoder.JSONDecodeError as e:
357348
message = f&#34;Failed to parse the response body: {str(e)}&#34;
358349
raise SlackApiError(message, res)
@@ -397,8 +388,7 @@ <h2 id="args">Args</h2>
397388
):
398389
if self.logger.level &lt;= logging.DEBUG:
399390
self.logger.info(
400-
f&#34;A retry handler found: {type(handler).__name__} &#34;
401-
f&#34;for {http_verb} {url} - {e}&#34;
391+
f&#34;A retry handler found: {type(handler).__name__} &#34; f&#34;for {http_verb} {url} - {e}&#34;
402392
)
403393
await handler.prepare_for_next_attempt_async(
404394
state=retry_state,

‎docs/api-docs/slack_sdk/audit_logs/index.html‎

Lines changed: 13 additions & 44 deletions
Original file line numberDiff line numberDiff line change
@@ -141,13 +141,9 @@ <h2 id="args">Args</h2>
141141
self.proxy = proxy
142142
self.base_url = base_url
143143
self.default_headers = default_headers if default_headers else {}
144-
self.default_headers[&#34;User-Agent&#34;] = get_user_agent(
145-
user_agent_prefix, user_agent_suffix
146-
)
144+
self.default_headers[&#34;User-Agent&#34;] = get_user_agent(user_agent_prefix, user_agent_suffix)
147145
self.logger = logger if logger is not None else logging.getLogger(__name__)
148-
self.retry_handlers = (
149-
retry_handlers if retry_handlers is not None else default_retry_handlers()
150-
)
146+
self.retry_handlers = retry_handlers if retry_handlers is not None else default_retry_handlers()
151147

152148
if self.proxy is None or len(self.proxy.strip()) == 0:
153149
env_variable = load_http_proxy_from_env(self.logger)
@@ -293,13 +289,8 @@ <h2 id="args">Args</h2>
293289
headers[&#34;Content-Type&#34;] = &#34;application/json;charset=utf-8&#34;
294290

295291
if self.logger.level &lt;= logging.DEBUG:
296-
headers_for_logging = {
297-
k: &#34;(redacted)&#34; if k.lower() == &#34;authorization&#34; else v
298-
for k, v in headers.items()
299-
}
300-
self.logger.debug(
301-
f&#34;Sending a request - url: {url}, body: {body}, headers: {headers_for_logging}&#34;
302-
)
292+
headers_for_logging = {k: &#34;(redacted)&#34; if k.lower() == &#34;authorization&#34; else v for k, v in headers.items()}
293+
self.logger.debug(f&#34;Sending a request - url: {url}, body: {body}, headers: {headers_for_logging}&#34;)
303294

304295
# NOTE: Intentionally ignore the `http_verb` here
305296
# Slack APIs accepts any API method requests with POST methods
@@ -338,15 +329,9 @@ <h2 id="args">Args</h2>
338329
)
339330
if e.code == 429:
340331
# for backward-compatibility with WebClient (v.2.5.0 or older)
341-
if (
342-
&#34;retry-after&#34; not in resp.headers
343-
and &#34;Retry-After&#34; in resp.headers
344-
):
332+
if &#34;retry-after&#34; not in resp.headers and &#34;Retry-After&#34; in resp.headers:
345333
resp.headers[&#34;retry-after&#34;] = resp.headers[&#34;Retry-After&#34;]
346-
if (
347-
&#34;Retry-After&#34; not in resp.headers
348-
and &#34;retry-after&#34; in resp.headers
349-
):
334+
if &#34;Retry-After&#34; not in resp.headers and &#34;retry-after&#34; in resp.headers:
350335
resp.headers[&#34;Retry-After&#34;] = resp.headers[&#34;retry-after&#34;]
351336
_debug_log_response(self.logger, resp)
352337

@@ -355,9 +340,7 @@ <h2 id="args">Args</h2>
355340
retry_response = RetryHttpResponse(
356341
status_code=e.code,
357342
headers={k: [v] for k, v in e.headers.items()},
358-
data=response_body.encode(&#34;utf-8&#34;)
359-
if response_body is not None
360-
else None,
343+
data=response_body.encode(&#34;utf-8&#34;) if response_body is not None else None,
361344
)
362345
for handler in self.retry_handlers:
363346
if handler.can_retry(
@@ -383,9 +366,7 @@ <h2 id="args">Args</h2>
383366

384367
except Exception as err:
385368
last_error = err
386-
self.logger.error(
387-
f&#34;Failed to send a request to Slack API server: {err}&#34;
388-
)
369+
self.logger.error(f&#34;Failed to send a request to Slack API server: {err}&#34;)
389370

390371
# Try to find a retry handler for this error
391372
retry_request = RetryHttpRequest.from_urllib_http_request(req)
@@ -406,9 +387,7 @@ <h2 id="args">Args</h2>
406387
response=None,
407388
error=err,
408389
)
409-
self.logger.info(
410-
f&#34;Going to retry the same request: {req.method} {req.full_url}&#34;
411-
)
390+
self.logger.info(f&#34;Going to retry the same request: {req.method} {req.full_url}&#34;)
412391
break
413392

414393
if retry_state.next_attempt_requested is False:
@@ -418,9 +397,7 @@ <h2 id="args">Args</h2>
418397
return resp
419398
raise last_error
420399

421-
def _perform_http_request_internal(
422-
self, url: str, req: Request
423-
) -&gt; AuditLogsResponse:
400+
def _perform_http_request_internal(self, url: str, req: Request) -&gt; AuditLogsResponse:
424401
opener: Optional[OpenerDirector] = None
425402
# for security (BAN-B310)
426403
if url.lower().startswith(&#34;http&#34;):
@@ -431,9 +408,7 @@ <h2 id="args">Args</h2>
431408
HTTPSHandler(context=self.ssl),
432409
)
433410
else:
434-
raise SlackRequestError(
435-
f&#34;Invalid proxy detected: {self.proxy} must be a str value&#34;
436-
)
411+
raise SlackRequestError(f&#34;Invalid proxy detected: {self.proxy} must be a str value&#34;)
437412
else:
438413
raise SlackRequestError(f&#34;Invalid URL detected: {url}&#34;)
439414

@@ -442,9 +417,7 @@ <h2 id="args">Args</h2>
442417
if opener:
443418
http_resp = opener.open(req, timeout=self.timeout) # skipcq: BAN-B310
444419
else:
445-
http_resp = urlopen( # skipcq: BAN-B310
446-
req, context=self.ssl, timeout=self.timeout
447-
)
420+
http_resp = urlopen(req, context=self.ssl, timeout=self.timeout) # skipcq: BAN-B310
448421
charset: str = http_resp.headers.get_content_charset() or &#34;utf-8&#34;
449422
response_body: str = http_resp.read().decode(charset)
450423
resp = AuditLogsResponse(
@@ -753,11 +726,7 @@ <h2 id="returns">Returns</h2>
753726
self.status_code = status_code
754727
self.headers = headers
755728
self.raw_body = raw_body
756-
self.body = (
757-
json.loads(raw_body)
758-
if raw_body is not None and raw_body.startswith(&#34;{&#34;)
759-
else None
760-
)</code></pre>
729+
self.body = json.loads(raw_body) if raw_body is not None and raw_body.startswith(&#34;{&#34;) else None</code></pre>
761730
</details>
762731
<h3>Class variables</h3>
763732
<dl>

‎docs/api-docs/slack_sdk/audit_logs/v1/async_client.html‎

Lines changed: 12 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -114,13 +114,9 @@ <h1 class="title">Module <code>slack_sdk.audit_logs.v1.async_client</code></h1>
114114
self.trust_env_in_session = trust_env_in_session
115115
self.auth = auth
116116
self.default_headers = default_headers if default_headers else {}
117-
self.default_headers[&#34;User-Agent&#34;] = get_user_agent(
118-
user_agent_prefix, user_agent_suffix
119-
)
117+
self.default_headers[&#34;User-Agent&#34;] = get_user_agent(user_agent_prefix, user_agent_suffix)
120118
self.logger = logger if logger is not None else logging.getLogger(__name__)
121-
self.retry_handlers = (
122-
retry_handlers if retry_handlers is not None else async_default_handlers()
123-
)
119+
self.retry_handlers = retry_handlers if retry_handlers is not None else async_default_handlers()
124120

125121
if self.proxy is None or len(self.proxy.strip()) == 0:
126122
env_variable = load_http_proxy_from_env(self.logger)
@@ -301,8 +297,7 @@ <h1 class="title">Module <code>slack_sdk.audit_logs.v1.async_client</code></h1>
301297

302298
if self.logger.level &lt;= logging.DEBUG:
303299
headers_for_logging = {
304-
k: &#34;(redacted)&#34; if k.lower() == &#34;authorization&#34; else v
305-
for k, v in headers.items()
300+
k: &#34;(redacted)&#34; if k.lower() == &#34;authorization&#34; else v for k, v in headers.items()
306301
}
307302
self.logger.debug(
308303
f&#34;Sending a request - &#34;
@@ -319,14 +314,10 @@ <h1 class="title">Module <code>slack_sdk.audit_logs.v1.async_client</code></h1>
319314
retry_response = RetryHttpResponse(
320315
status_code=res.status,
321316
headers=res.headers,
322-
data=response_body.encode(&#34;utf-8&#34;)
323-
if response_body is not None
324-
else None,
317+
data=response_body.encode(&#34;utf-8&#34;) if response_body is not None else None,
325318
)
326319
except aiohttp.ContentTypeError:
327-
self.logger.debug(
328-
f&#34;No response data returned from the following API call: {url}.&#34;
329-
)
320+
self.logger.debug(f&#34;No response data returned from the following API call: {url}.&#34;)
330321
except json.decoder.JSONDecodeError as e:
331322
message = f&#34;Failed to parse the response body: {str(e)}&#34;
332323
raise SlackApiError(message, res)
@@ -371,8 +362,7 @@ <h1 class="title">Module <code>slack_sdk.audit_logs.v1.async_client</code></h1>
371362
):
372363
if self.logger.level &lt;= logging.DEBUG:
373364
self.logger.info(
374-
f&#34;A retry handler found: {type(handler).__name__} &#34;
375-
f&#34;for {http_verb} {url} - {e}&#34;
365+
f&#34;A retry handler found: {type(handler).__name__} &#34; f&#34;for {http_verb} {url} - {e}&#34;
376366
)
377367
await handler.prepare_for_next_attempt_async(
378368
state=retry_state,
@@ -503,13 +493,9 @@ <h2 id="args">Args</h2>
503493
self.trust_env_in_session = trust_env_in_session
504494
self.auth = auth
505495
self.default_headers = default_headers if default_headers else {}
506-
self.default_headers[&#34;User-Agent&#34;] = get_user_agent(
507-
user_agent_prefix, user_agent_suffix
508-
)
496+
self.default_headers[&#34;User-Agent&#34;] = get_user_agent(user_agent_prefix, user_agent_suffix)
509497
self.logger = logger if logger is not None else logging.getLogger(__name__)
510-
self.retry_handlers = (
511-
retry_handlers if retry_handlers is not None else async_default_handlers()
512-
)
498+
self.retry_handlers = retry_handlers if retry_handlers is not None else async_default_handlers()
513499

514500
if self.proxy is None or len(self.proxy.strip()) == 0:
515501
env_variable = load_http_proxy_from_env(self.logger)
@@ -690,8 +676,7 @@ <h2 id="args">Args</h2>
690676

691677
if self.logger.level &lt;= logging.DEBUG:
692678
headers_for_logging = {
693-
k: &#34;(redacted)&#34; if k.lower() == &#34;authorization&#34; else v
694-
for k, v in headers.items()
679+
k: &#34;(redacted)&#34; if k.lower() == &#34;authorization&#34; else v for k, v in headers.items()
695680
}
696681
self.logger.debug(
697682
f&#34;Sending a request - &#34;
@@ -708,14 +693,10 @@ <h2 id="args">Args</h2>
708693
retry_response = RetryHttpResponse(
709694
status_code=res.status,
710695
headers=res.headers,
711-
data=response_body.encode(&#34;utf-8&#34;)
712-
if response_body is not None
713-
else None,
696+
data=response_body.encode(&#34;utf-8&#34;) if response_body is not None else None,
714697
)
715698
except aiohttp.ContentTypeError:
716-
self.logger.debug(
717-
f&#34;No response data returned from the following API call: {url}.&#34;
718-
)
699+
self.logger.debug(f&#34;No response data returned from the following API call: {url}.&#34;)
719700
except json.decoder.JSONDecodeError as e:
720701
message = f&#34;Failed to parse the response body: {str(e)}&#34;
721702
raise SlackApiError(message, res)
@@ -760,8 +741,7 @@ <h2 id="args">Args</h2>
760741
):
761742
if self.logger.level &lt;= logging.DEBUG:
762743
self.logger.info(
763-
f&#34;A retry handler found: {type(handler).__name__} &#34;
764-
f&#34;for {http_verb} {url} - {e}&#34;
744+
f&#34;A retry handler found: {type(handler).__name__} &#34; f&#34;for {http_verb} {url} - {e}&#34;
765745
)
766746
await handler.prepare_for_next_attempt_async(
767747
state=retry_state,

0 commit comments

Comments
 (0)