Update #1087 to have more relevant RetryHandler code

Author: seratch

docs-src/audit-logs/index.rst

@@ -96,7 +96,13 @@ Creating your own ones is also quite simple. Defining a new class that inherits
 
     client = AuditLogsClient(
         token=os.environ["SLACK_ORG_ADMIN_USER_TOKEN"],
-        retry_handlers=[MyRetryHandler()],
+        retry_handlers=[MyRetryHandler(
+            max_retry_count=1,
+            interval_calculator=BackoffRetryIntervalCalculator(
+                backoff_factor=0.5,
+                jitter=RandomJitter(),
+            ),
+        )],
     )
 
 For asyncio apps, ``Async`` prefixed corresponding modules are available. All the methods in those methods are async/await compatible. Check `the source code <https://github.com/slackapi/python-slack-sdk/blob/main/slack_sdk/http_retry/async_handler.py>`_ and `tests <https://github.com/slackapi/python-slack-sdk/blob/main/tests/slack_sdk_async/web/test_async_web_client_http_retry.py>`_ for more details.

docs-src/scim/index.rst

@@ -144,7 +144,13 @@ Creating your own ones is also quite simple. Defining a new class that inherits
 
     client = SCIMClient(
         token=os.environ["SLACK_ORG_ADMIN_USER_TOKEN"],
-        retry_handlers=[MyRetryHandler()],
+        retry_handlers=[MyRetryHandler(
+            max_retry_count=1,
+            interval_calculator=BackoffRetryIntervalCalculator(
+                backoff_factor=0.5,
+                jitter=RandomJitter(),
+            ),
+        )],
     )
 
 For asyncio apps, ``Async`` prefixed corresponding modules are available. All the methods in those methods are async/await compatible. Check `the source code <https://github.com/slackapi/python-slack-sdk/blob/main/slack_sdk/http_retry/async_handler.py>`_ and `tests <https://github.com/slackapi/python-slack-sdk/blob/main/tests/slack_sdk_async/web/test_async_web_client_http_retry.py>`_ for more details.

docs-src/web/index.rst

@@ -698,7 +698,13 @@ Creating your own ones is also quite simple. Defining a new class that inherits
 
     client = WebClient(
         token=os.environ["SLACK_BOT_TOKEN"],
-        retry_handlers=[MyRetryHandler()],
+        retry_handlers=[MyRetryHandler(
+            max_retry_count=1,
+            interval_calculator=BackoffRetryIntervalCalculator(
+                backoff_factor=0.5,
+                jitter=RandomJitter(),
+            ),
+        )],
     )
 
 For asyncio apps, ``Async`` prefixed corresponding modules are available. All the methods in those methods are async/await compatible. Check `the source code <https://github.com/slackapi/python-slack-sdk/blob/main/slack_sdk/http_retry/async_handler.py>`_ and `tests <https://github.com/slackapi/python-slack-sdk/blob/main/tests/slack_sdk_async/web/test_async_web_client_http_retry.py>`_ for more details.

docs-src/webhook/index.rst

@@ -153,7 +153,13 @@ Creating your own ones is also quite simple. Defining a new class that inherits
 
     webhook = WebhookClient(
         url=url,
-        retry_handlers=[MyRetryHandler()],
+        retry_handlers=[MyRetryHandler(
+            max_retry_count=1,
+            interval_calculator=BackoffRetryIntervalCalculator(
+                backoff_factor=0.5,
+                jitter=RandomJitter(),
+            ),
+        )],
     )
 
 For asyncio apps, ``Async`` prefixed corresponding modules are available. All the methods in those methods are async/await compatible. Check `the source code <https://github.com/slackapi/python-slack-sdk/blob/main/slack_sdk/http_retry/async_handler.py>`_ and `tests <https://github.com/slackapi/python-slack-sdk/blob/main/tests/slack_sdk_async/web/test_async_web_client_http_retry.py>`_ for more details.

docs/audit-logs/index.html

@@ -285,7 +285,13 @@ <h2>RetryHandler<a class="headerlink" href="#retryhandler" title="Permalink to t
 
 <span class="n">client</span> <span class="o">=</span> <span class="n">AuditLogsClient</span><span class="p">(</span>
     <span class="n">token</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;SLACK_ORG_ADMIN_USER_TOKEN&quot;</span><span class="p">],</span>
-    <span class="n">retry_handlers</span><span class="o">=</span><span class="p">[</span><span class="n">MyRetryHandler</span><span class="p">()],</span>
+    <span class="n">retry_handlers</span><span class="o">=</span><span class="p">[</span><span class="n">MyRetryHandler</span><span class="p">(</span>
+        <span class="n">max_retry_count</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+        <span class="n">interval_calculator</span><span class="o">=</span><span class="n">BackoffRetryIntervalCalculator</span><span class="p">(</span>
+            <span class="n">backoff_factor</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span>
+            <span class="n">jitter</span><span class="o">=</span><span class="n">RandomJitter</span><span class="p">(),</span>
+        <span class="p">),</span>
+    <span class="p">)],</span>
 <span class="p">)</span>
 </pre></div>
 </div>

docs/scim/index.html

@@ -332,7 +332,13 @@ <h2>RetryHandler<a class="headerlink" href="#retryhandler" title="Permalink to t
 
 <span class="n">client</span> <span class="o">=</span> <span class="n">SCIMClient</span><span class="p">(</span>
     <span class="n">token</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;SLACK_ORG_ADMIN_USER_TOKEN&quot;</span><span class="p">],</span>
-    <span class="n">retry_handlers</span><span class="o">=</span><span class="p">[</span><span class="n">MyRetryHandler</span><span class="p">()],</span>
+    <span class="n">retry_handlers</span><span class="o">=</span><span class="p">[</span><span class="n">MyRetryHandler</span><span class="p">(</span>
+        <span class="n">max_retry_count</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+        <span class="n">interval_calculator</span><span class="o">=</span><span class="n">BackoffRetryIntervalCalculator</span><span class="p">(</span>
+            <span class="n">backoff_factor</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span>
+            <span class="n">jitter</span><span class="o">=</span><span class="n">RandomJitter</span><span class="p">(),</span>
+        <span class="p">),</span>
+    <span class="p">)],</span>
 <span class="p">)</span>
 </pre></div>
 </div>

docs/searchindex.js

@@ -779,7 +779,13 @@ <h2>RetryHandler<a class="headerlink" href="#retryhandler" title="Permalink to t
 
 <span class="n">client</span> <span class="o">=</span> <span class="n">WebClient</span><span class="p">(</span>
     <span class="n">token</span><span class="o">=</span><span class="n">os</span><span class="o">.</span><span class="n">environ</span><span class="p">[</span><span class="s2">&quot;SLACK_BOT_TOKEN&quot;</span><span class="p">],</span>
-    <span class="n">retry_handlers</span><span class="o">=</span><span class="p">[</span><span class="n">MyRetryHandler</span><span class="p">()],</span>
+    <span class="n">retry_handlers</span><span class="o">=</span><span class="p">[</span><span class="n">MyRetryHandler</span><span class="p">(</span>
+        <span class="n">max_retry_count</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+        <span class="n">interval_calculator</span><span class="o">=</span><span class="n">BackoffRetryIntervalCalculator</span><span class="p">(</span>
+            <span class="n">backoff_factor</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span>
+            <span class="n">jitter</span><span class="o">=</span><span class="n">RandomJitter</span><span class="p">(),</span>
+        <span class="p">),</span>
+    <span class="p">)],</span>
 <span class="p">)</span>
 </pre></div>
 </div>

docs/web/index.html

@@ -343,7 +343,13 @@ <h2>RetryHandler<a class="headerlink" href="#retryhandler" title="Permalink to t
 
 <span class="n">webhook</span> <span class="o">=</span> <span class="n">WebhookClient</span><span class="p">(</span>
     <span class="n">url</span><span class="o">=</span><span class="n">url</span><span class="p">,</span>
-    <span class="n">retry_handlers</span><span class="o">=</span><span class="p">[</span><span class="n">MyRetryHandler</span><span class="p">()],</span>
+    <span class="n">retry_handlers</span><span class="o">=</span><span class="p">[</span><span class="n">MyRetryHandler</span><span class="p">(</span>
+        <span class="n">max_retry_count</span><span class="o">=</span><span class="mi">1</span><span class="p">,</span>
+        <span class="n">interval_calculator</span><span class="o">=</span><span class="n">BackoffRetryIntervalCalculator</span><span class="p">(</span>
+            <span class="n">backoff_factor</span><span class="o">=</span><span class="mf">0.5</span><span class="p">,</span>
+            <span class="n">jitter</span><span class="o">=</span><span class="n">RandomJitter</span><span class="p">(),</span>
+        <span class="p">),</span>
+    <span class="p">)],</span>
 <span class="p">)</span>
 </pre></div>
 </div>