Apply v3.10.0 release changes to API docs

Author: seratch

docs/api-docs/slack_sdk/http_retry/builtin_async_handlers.html

@@ -98,7 +98,7 @@ <h1 class="title">Module <code>slack_sdk.http_retry.builtin_async_handlers</code
         if response is None:
             raise error
 
-        state.increment_current_attempt()
+        state.next_attempt_requested = True
         retry_after_header_name: Optional[str] = None
         for k in response.headers.keys():
             if k.lower() == &#34;retry-after&#34;:
@@ -113,6 +113,7 @@ <h1 class="title">Module <code>slack_sdk.http_retry.builtin_async_handlers</code
                 int(response.headers.get(retry_after_header_name)[0]) + random.random()
             )
         await asyncio.sleep(duration)
+        state.increment_current_attempt()
 
 
 def async_default_handlers() -&gt; List[AsyncRetryHandler]:
@@ -253,7 +254,7 @@ <h2 id="args">Args</h2>
         if response is None:
             raise error
 
-        state.increment_current_attempt()
+        state.next_attempt_requested = True
         retry_after_header_name: Optional[str] = None
         for k in response.headers.keys():
             if k.lower() == &#34;retry-after&#34;:
@@ -267,7 +268,8 @@ <h2 id="args">Args</h2>
             duration = (
                 int(response.headers.get(retry_after_header_name)[0]) + random.random()
             )
-        await asyncio.sleep(duration)</code></pre>
+        await asyncio.sleep(duration)
+        state.increment_current_attempt()</code></pre>
 </details>
 <h3>Ancestors</h3>
 <ul class="hlist">
@@ -306,7 +308,7 @@ <h3>Methods</h3>
     if response is None:
         raise error
 
-    state.increment_current_attempt()
+    state.next_attempt_requested = True
     retry_after_header_name: Optional[str] = None
     for k in response.headers.keys():
         if k.lower() == &#34;retry-after&#34;:
@@ -320,7 +322,8 @@ <h3>Methods</h3>
         duration = (
             int(response.headers.get(retry_after_header_name)[0]) + random.random()
         )
-    await asyncio.sleep(duration)</code></pre>
+    await asyncio.sleep(duration)
+    state.increment_current_attempt()</code></pre>
 </details>
 </dd>
 </dl>

docs/api-docs/slack_sdk/http_retry/builtin_handlers.html

@@ -67,6 +67,10 @@ <h1 class="title">Module <code>slack_sdk.http_retry.builtin_handlers</code></h1>
         if error is None:
             return False
 
+        if isinstance(error, URLError):
+            if response is not None:
+                return False  # status 40x
+
         for error_type in self.error_types_to_do_retries:
             if isinstance(error, error_type):
                 return True
@@ -97,7 +101,7 @@ <h1 class="title">Module <code>slack_sdk.http_retry.builtin_handlers</code></h1>
         if response is None:
             raise error
 
-        state.increment_current_attempt()
+        state.next_attempt_requested = True
         retry_after_header_name: Optional[str] = None
         for k in response.headers.keys():
             if k.lower() == &#34;retry-after&#34;:
@@ -111,7 +115,8 @@ <h1 class="title">Module <code>slack_sdk.http_retry.builtin_handlers</code></h1>
             duration = (
                 int(response.headers.get(retry_after_header_name)[0]) + random.random()
             )
-        time.sleep(duration)</code></pre>
+        time.sleep(duration)
+        state.increment_current_attempt()</code></pre>
 </details>
 </section>
 <section>
@@ -169,6 +174,10 @@ <h2 id="args">Args</h2>
         if error is None:
             return False
 
+        if isinstance(error, URLError):
+            if response is not None:
+                return False  # status 40x
+
         for error_type in self.error_types_to_do_retries:
             if isinstance(error, error_type):
                 return True
@@ -232,7 +241,7 @@ <h2 id="args">Args</h2>
         if response is None:
             raise error
 
-        state.increment_current_attempt()
+        state.next_attempt_requested = True
         retry_after_header_name: Optional[str] = None
         for k in response.headers.keys():
             if k.lower() == &#34;retry-after&#34;:
@@ -246,7 +255,8 @@ <h2 id="args">Args</h2>
             duration = (
                 int(response.headers.get(retry_after_header_name)[0]) + random.random()
             )
-        time.sleep(duration)</code></pre>
+        time.sleep(duration)
+        state.increment_current_attempt()</code></pre>
 </details>
 <h3>Ancestors</h3>
 <ul class="hlist">
@@ -285,7 +295,7 @@ <h3>Methods</h3>
     if response is None:
         raise error
 
-    state.increment_current_attempt()
+    state.next_attempt_requested = True
     retry_after_header_name: Optional[str] = None
     for k in response.headers.keys():
         if k.lower() == &#34;retry-after&#34;:
@@ -299,7 +309,8 @@ <h3>Methods</h3>
         duration = (
             int(response.headers.get(retry_after_header_name)[0]) + random.random()
         )
-    time.sleep(duration)</code></pre>
+    time.sleep(duration)
+    state.increment_current_attempt()</code></pre>
 </details>
 </dd>
 </dl>

docs/api-docs/slack_sdk/http_retry/response.html

@@ -40,12 +40,12 @@ <h1 class="title">Module <code>slack_sdk.http_retry.response</code></h1>
     def __init__(
         self,
         *,
-        status_code: int,
+        status_code: Union[int, str],
         headers: Dict[str, Union[str, List[str]]],
         body: Optional[Dict[str, Any]] = None,
         data: Optional[bytes] = None,
     ):
-        self.status_code = status_code
+        self.status_code = int(status_code)
         self.headers = {
             k: v if isinstance(v, list) else [v] for k, v in headers.items()
         }
@@ -64,7 +64,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="slack_sdk.http_retry.response.HttpResponse"><code class="flex name class">
 <span>class <span class="ident">HttpResponse</span></span>
-<span>(</span><span>*, status_code: int, headers: Dict[str, Union[str, List[str]]], body: Optional[Dict[str, Any]] = None, data: Optional[bytes] = None)</span>
+<span>(</span><span>*, status_code: Union[int, str], headers: Dict[str, Union[str, List[str]]], body: Optional[Dict[str, Any]] = None, data: Optional[bytes] = None)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>HTTP response representation</p></div>
@@ -83,12 +83,12 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     def __init__(
         self,
         *,
-        status_code: int,
+        status_code: Union[int, str],
         headers: Dict[str, Union[str, List[str]]],
         body: Optional[Dict[str, Any]] = None,
         data: Optional[bytes] = None,
     ):
-        self.status_code = status_code
+        self.status_code = int(status_code)
         self.headers = {
             k: v if isinstance(v, list) else [v] for k, v in headers.items()
         }

docs/api-docs/slack_sdk/models/blocks/basic_components.html

@@ -221,7 +221,12 @@ <h1 class="title">Module <code>slack_sdk.models.blocks.basic_components</code></
                 dialogs.
         &#34;&#34;&#34;
         if text:
-            self._text: Optional[TextObject] = TextObject.parse(text)
+            # For better compatibility with Block Kit (&#34;mrkdwn&#34; does not work for it),
+            # we&#39;ve changed the default text object type to plain_text since version 3.10.0
+            self._text: Optional[TextObject] = TextObject.parse(
+                text=text,  # &#34;text&#34; here can be either a str or a TextObject
+                default_type=PlainTextObject.type,
+            )
             self._label: Optional[str] = None
         else:
             self._text: Optional[TextObject] = None
@@ -1140,7 +1145,12 @@ <h2 id="args">Args</h2>
                 dialogs.
         &#34;&#34;&#34;
         if text:
-            self._text: Optional[TextObject] = TextObject.parse(text)
+            # For better compatibility with Block Kit (&#34;mrkdwn&#34; does not work for it),
+            # we&#39;ve changed the default text object type to plain_text since version 3.10.0
+            self._text: Optional[TextObject] = TextObject.parse(
+                text=text,  # &#34;text&#34; here can be either a str or a TextObject
+                default_type=PlainTextObject.type,
+            )
             self._label: Optional[str] = None
         else:
             self._text: Optional[TextObject] = None

docs/api-docs/slack_sdk/models/blocks/blocks.html

@@ -40,6 +40,7 @@ <h1 class="title">Module <code>slack_sdk.models.blocks.blocks</code></h1>
 from .basic_components import PlainTextObject
 from .basic_components import TextObject
 from .block_elements import BlockElement
+from .block_elements import ImageElement
 from .block_elements import InputInteractiveElement
 from .block_elements import InteractiveElement
 
@@ -292,7 +293,7 @@ <h1 class="title">Module <code>slack_sdk.models.blocks.blocks</code></h1>
     def __init__(
         self,
         *,
-        elements: Sequence[Union[dict, ImageBlock, TextObject]],
+        elements: Sequence[Union[dict, ImageElement, TextObject]],
         block_id: Optional[str] = None,
         **others: dict,
     ):
@@ -841,7 +842,7 @@ <h3>Inherited members</h3>
 </dd>
 <dt id="slack_sdk.models.blocks.blocks.ContextBlock"><code class="flex name class">
 <span>class <span class="ident">ContextBlock</span></span>
-<span>(</span><span>*, elements: Sequence[Union[dict, <a title="slack_sdk.models.blocks.blocks.ImageBlock" href="#slack_sdk.models.blocks.blocks.ImageBlock">ImageBlock</a>, <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>]], block_id: Optional[str] = None, **others: dict)</span>
+<span>(</span><span>*, elements: Sequence[Union[dict, <a title="slack_sdk.models.blocks.block_elements.ImageElement" href="block_elements.html#slack_sdk.models.blocks.block_elements.ImageElement">ImageElement</a>, <a title="slack_sdk.models.blocks.basic_components.TextObject" href="basic_components.html#slack_sdk.models.blocks.basic_components.TextObject">TextObject</a>]], block_id: Optional[str] = None, **others: dict)</span>
 </code></dt>
 <dd>
 <div class="desc"><p>Blocks are a series of components that can be combined
@@ -864,7 +865,7 @@ <h3>Inherited members</h3>
     def __init__(
         self,
         *,
-        elements: Sequence[Union[dict, ImageBlock, TextObject]],
+        elements: Sequence[Union[dict, ImageElement, TextObject]],
         block_id: Optional[str] = None,
         **others: dict,
     ):

docs/api-docs/slack_sdk/proxy_env_variable_loader.html

@@ -42,10 +42,16 @@ <h1 class="title">Module <code>slack_sdk.proxy_env_variable_loader</code></h1>
         or os.environ.get(&#34;HTTP_PROXY&#34;)
         or os.environ.get(&#34;http_proxy&#34;)
     )
-    if proxy_url is not None:
+    if proxy_url is None:
+        return None
+    if len(proxy_url.strip()) == 0:
+        # If the value is an empty string, the intention should be unsetting it
         logger.debug(
-            f&#34;HTTP proxy URL has been loaded from an env variable: {proxy_url}&#34;
+            &#34;The Slack SDK ignored the proxy env variable as an empty value is set.&#34;
         )
+        return None
+
+    logger.debug(f&#34;HTTP proxy URL has been loaded from an env variable: {proxy_url}&#34;)
     return proxy_url</code></pre>
 </details>
 </section>
@@ -72,10 +78,16 @@ <h2 class="section-title" id="header-functions">Functions</h2>
         or os.environ.get(&#34;HTTP_PROXY&#34;)
         or os.environ.get(&#34;http_proxy&#34;)
     )
-    if proxy_url is not None:
+    if proxy_url is None:
+        return None
+    if len(proxy_url.strip()) == 0:
+        # If the value is an empty string, the intention should be unsetting it
         logger.debug(
-            f&#34;HTTP proxy URL has been loaded from an env variable: {proxy_url}&#34;
+            &#34;The Slack SDK ignored the proxy env variable as an empty value is set.&#34;
         )
+        return None
+
+    logger.debug(f&#34;HTTP proxy URL has been loaded from an env variable: {proxy_url}&#34;)
     return proxy_url</code></pre>
 </details>
 </dd>

docs/api-docs/slack_sdk/version.html

@@ -28,7 +28,7 @@ <h1 class="title">Module <code>slack_sdk.version</code></h1>
 <span>Expand source code</span>
 </summary>
 <pre><code class="python">&#34;&#34;&#34;Check the latest version at https://pypi.org/project/slack-sdk/&#34;&#34;&#34;
-__version__ = &#34;3.9.0&#34;</code></pre>
+__version__ = &#34;3.10.0&#34;</code></pre>
 </details>
 </section>
 <section>