version 1.21.2

slackapi · Oct 25, 2024 · 9de07b1 · 9de07b1
1 parent 38167c4
commit 9de07b1
Show file tree

Hide file tree

Showing 5 changed files with 57 additions and 18 deletions.
diff --git a/docs/static/api-docs/slack_bolt/context/assistant/assistant_utilities.html b/docs/static/api-docs/slack_bolt/context/assistant/assistant_utilities.html
@@ -93,14 +93,17 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 
     @property
     def say(self) -&gt; Say:
+        def build_metadata() -&gt; Optional[dict]:
+            thread_context = self.get_thread_context()
+            if thread_context is not None:
+                return {&#34;event_type&#34;: &#34;assistant_thread_context&#34;, &#34;event_payload&#34;: thread_context}
+            return None
+
         return Say(
             self.client,
             channel=self.channel_id,
             thread_ts=self.thread_ts,
-            metadata={
-                &#34;event_type&#34;: &#34;assistant_thread_context&#34;,
-                &#34;event_payload&#34;: self.get_thread_context(),
-            },
+            build_metadata=build_metadata,
         )
 
     @property
@@ -169,14 +172,17 @@ <h3>Instance variables</h3>
 </summary>
 <pre><code class="python">@property
 def say(self) -&gt; Say:
+    def build_metadata() -&gt; Optional[dict]:
+        thread_context = self.get_thread_context()
+        if thread_context is not None:
+            return {&#34;event_type&#34;: &#34;assistant_thread_context&#34;, &#34;event_payload&#34;: thread_context}
+        return None
+
     return Say(
         self.client,
         channel=self.channel_id,
         thread_ts=self.thread_ts,
-        metadata={
-            &#34;event_type&#34;: &#34;assistant_thread_context&#34;,
-            &#34;event_payload&#34;: self.get_thread_context(),
-        },
+        build_metadata=build_metadata,
     )</code></pre>
 </details>
 </dd>

diff --git a/docs/static/api-docs/slack_bolt/context/say/index.html b/docs/static/api-docs/slack_bolt/context/say/index.html
@@ -52,7 +52,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="slack_bolt.context.say.Say"><code class="flex name class">
 <span>class <span class="ident">Say</span></span>
-<span>(</span><span>client: Optional[slack_sdk.web.client.WebClient], channel: Optional[str], thread_ts: Optional[str] = None, metadata: Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)] = None)</span>
+<span>(</span><span>client: Optional[slack_sdk.web.client.WebClient], channel: Optional[str], thread_ts: Optional[str] = None, metadata: Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)] = None, build_metadata: Optional[Callable[[], Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)]]] = None)</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -65,18 +65,21 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     channel: Optional[str]
     thread_ts: Optional[str]
     metadata: Optional[Union[Dict, Metadata]]
+    build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]]
 
     def __init__(
         self,
         client: Optional[WebClient],
         channel: Optional[str],
         thread_ts: Optional[str] = None,
         metadata: Optional[Union[Dict, Metadata]] = None,
+        build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]] = None,
     ):
         self.client = client
         self.channel = channel
         self.thread_ts = thread_ts
         self.metadata = metadata
+        self.build_metadata = build_metadata
 
     def __call__(
         self,
@@ -102,6 +105,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             text_or_whole_response: Union[str, dict] = text
             if isinstance(text_or_whole_response, str):
                 text = text_or_whole_response
+                if metadata is None:
+                    metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
                 return self.client.chat_postMessage(  # type: ignore[union-attr]
                     channel=channel or self.channel,  # type: ignore[arg-type]
                     text=text,
@@ -118,7 +123,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                     mrkdwn=mrkdwn,
                     link_names=link_names,
                     parse=parse,
-                    metadata=metadata or self.metadata,
+                    metadata=metadata,
                     **kwargs,
                 )
             elif isinstance(text_or_whole_response, dict):
@@ -128,7 +133,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 if &#34;thread_ts&#34; not in message:
                     message[&#34;thread_ts&#34;] = thread_ts or self.thread_ts
                 if &#34;metadata&#34; not in message:
-                    message[&#34;metadata&#34;] = metadata or self.metadata
+                    metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
+                    message[&#34;metadata&#34;] = metadata
                 return self.client.chat_postMessage(**message)  # type: ignore[union-attr]
             else:
                 raise ValueError(f&#34;The arg is unexpected type ({type(text_or_whole_response)})&#34;)
@@ -137,6 +143,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 </details>
 <h3>Class variables</h3>
 <dl>
+<dt id="slack_bolt.context.say.Say.build_metadata"><code class="name">var <span class="ident">build_metadata</span> : Optional[Callable[[], Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)]]]</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="slack_bolt.context.say.Say.channel"><code class="name">var <span class="ident">channel</span> : Optional[str]</code></dt>
 <dd>
 <div class="desc"></div>
@@ -180,6 +190,7 @@ <h3>Class variables</h3>
 <li>
 <h4><code><a title="slack_bolt.context.say.Say" href="#slack_bolt.context.say.Say">Say</a></code></h4>
 <ul class="">
+<li><code><a title="slack_bolt.context.say.Say.build_metadata" href="#slack_bolt.context.say.Say.build_metadata">build_metadata</a></code></li>
 <li><code><a title="slack_bolt.context.say.Say.channel" href="#slack_bolt.context.say.Say.channel">channel</a></code></li>
 <li><code><a title="slack_bolt.context.say.Say.client" href="#slack_bolt.context.say.Say.client">client</a></code></li>
 <li><code><a title="slack_bolt.context.say.Say.metadata" href="#slack_bolt.context.say.Say.metadata">metadata</a></code></li>

diff --git a/docs/static/api-docs/slack_bolt/context/say/say.html b/docs/static/api-docs/slack_bolt/context/say/say.html
@@ -37,7 +37,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 <dl>
 <dt id="slack_bolt.context.say.say.Say"><code class="flex name class">
 <span>class <span class="ident">Say</span></span>
-<span>(</span><span>client: Optional[slack_sdk.web.client.WebClient], channel: Optional[str], thread_ts: Optional[str] = None, metadata: Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)] = None)</span>
+<span>(</span><span>client: Optional[slack_sdk.web.client.WebClient], channel: Optional[str], thread_ts: Optional[str] = None, metadata: Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)] = None, build_metadata: Optional[Callable[[], Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)]]] = None)</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -50,18 +50,21 @@ <h2 class="section-title" id="header-classes">Classes</h2>
     channel: Optional[str]
     thread_ts: Optional[str]
     metadata: Optional[Union[Dict, Metadata]]
+    build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]]
 
     def __init__(
         self,
         client: Optional[WebClient],
         channel: Optional[str],
         thread_ts: Optional[str] = None,
         metadata: Optional[Union[Dict, Metadata]] = None,
+        build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]] = None,
     ):
         self.client = client
         self.channel = channel
         self.thread_ts = thread_ts
         self.metadata = metadata
+        self.build_metadata = build_metadata
 
     def __call__(
         self,
@@ -87,6 +90,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
             text_or_whole_response: Union[str, dict] = text
             if isinstance(text_or_whole_response, str):
                 text = text_or_whole_response
+                if metadata is None:
+                    metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
                 return self.client.chat_postMessage(  # type: ignore[union-attr]
                     channel=channel or self.channel,  # type: ignore[arg-type]
                     text=text,
@@ -103,7 +108,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                     mrkdwn=mrkdwn,
                     link_names=link_names,
                     parse=parse,
-                    metadata=metadata or self.metadata,
+                    metadata=metadata,
                     **kwargs,
                 )
             elif isinstance(text_or_whole_response, dict):
@@ -113,7 +118,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
                 if &#34;thread_ts&#34; not in message:
                     message[&#34;thread_ts&#34;] = thread_ts or self.thread_ts
                 if &#34;metadata&#34; not in message:
-                    message[&#34;metadata&#34;] = metadata or self.metadata
+                    metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
+                    message[&#34;metadata&#34;] = metadata
                 return self.client.chat_postMessage(**message)  # type: ignore[union-attr]
             else:
                 raise ValueError(f&#34;The arg is unexpected type ({type(text_or_whole_response)})&#34;)
@@ -122,6 +128,10 @@ <h2 class="section-title" id="header-classes">Classes</h2>
 </details>
 <h3>Class variables</h3>
 <dl>
+<dt id="slack_bolt.context.say.say.Say.build_metadata"><code class="name">var <span class="ident">build_metadata</span> : Optional[Callable[[], Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)]]]</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="slack_bolt.context.say.say.Say.channel"><code class="name">var <span class="ident">channel</span> : Optional[str]</code></dt>
 <dd>
 <div class="desc"></div>
@@ -158,6 +168,7 @@ <h3>Class variables</h3>
 <li>
 <h4><code><a title="slack_bolt.context.say.say.Say" href="#slack_bolt.context.say.say.Say">Say</a></code></h4>
 <ul class="">
+<li><code><a title="slack_bolt.context.say.say.Say.build_metadata" href="#slack_bolt.context.say.say.Say.build_metadata">build_metadata</a></code></li>
 <li><code><a title="slack_bolt.context.say.say.Say.channel" href="#slack_bolt.context.say.say.Say.channel">channel</a></code></li>
 <li><code><a title="slack_bolt.context.say.say.Say.client" href="#slack_bolt.context.say.say.Say.client">client</a></code></li>
 <li><code><a title="slack_bolt.context.say.say.Say.metadata" href="#slack_bolt.context.say.say.Say.metadata">metadata</a></code></li>

diff --git a/docs/static/api-docs/slack_bolt/index.html b/docs/static/api-docs/slack_bolt/index.html
@@ -4300,7 +4300,7 @@ <h3>Class variables</h3>
 </dd>
 <dt id="slack_bolt.Say"><code class="flex name class">
 <span>class <span class="ident">Say</span></span>
-<span>(</span><span>client: Optional[slack_sdk.web.client.WebClient], channel: Optional[str], thread_ts: Optional[str] = None, metadata: Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)] = None)</span>
+<span>(</span><span>client: Optional[slack_sdk.web.client.WebClient], channel: Optional[str], thread_ts: Optional[str] = None, metadata: Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)] = None, build_metadata: Optional[Callable[[], Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)]]] = None)</span>
 </code></dt>
 <dd>
 <div class="desc"></div>
@@ -4313,18 +4313,21 @@ <h3>Class variables</h3>
     channel: Optional[str]
     thread_ts: Optional[str]
     metadata: Optional[Union[Dict, Metadata]]
+    build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]]
 
     def __init__(
         self,
         client: Optional[WebClient],
         channel: Optional[str],
         thread_ts: Optional[str] = None,
         metadata: Optional[Union[Dict, Metadata]] = None,
+        build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]] = None,
     ):
         self.client = client
         self.channel = channel
         self.thread_ts = thread_ts
         self.metadata = metadata
+        self.build_metadata = build_metadata
 
     def __call__(
         self,
@@ -4350,6 +4353,8 @@ <h3>Class variables</h3>
             text_or_whole_response: Union[str, dict] = text
             if isinstance(text_or_whole_response, str):
                 text = text_or_whole_response
+                if metadata is None:
+                    metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
                 return self.client.chat_postMessage(  # type: ignore[union-attr]
                     channel=channel or self.channel,  # type: ignore[arg-type]
                     text=text,
@@ -4366,7 +4371,7 @@ <h3>Class variables</h3>
                     mrkdwn=mrkdwn,
                     link_names=link_names,
                     parse=parse,
-                    metadata=metadata or self.metadata,
+                    metadata=metadata,
                     **kwargs,
                 )
             elif isinstance(text_or_whole_response, dict):
@@ -4376,7 +4381,8 @@ <h3>Class variables</h3>
                 if &#34;thread_ts&#34; not in message:
                     message[&#34;thread_ts&#34;] = thread_ts or self.thread_ts
                 if &#34;metadata&#34; not in message:
-                    message[&#34;metadata&#34;] = metadata or self.metadata
+                    metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
+                    message[&#34;metadata&#34;] = metadata
                 return self.client.chat_postMessage(**message)  # type: ignore[union-attr]
             else:
                 raise ValueError(f&#34;The arg is unexpected type ({type(text_or_whole_response)})&#34;)
@@ -4385,6 +4391,10 @@ <h3>Class variables</h3>
 </details>
 <h3>Class variables</h3>
 <dl>
+<dt id="slack_bolt.Say.build_metadata"><code class="name">var <span class="ident">build_metadata</span> : Optional[Callable[[], Union[Dict, slack_sdk.models.metadata.Metadata, ForwardRef(None)]]]</code></dt>
+<dd>
+<div class="desc"></div>
+</dd>
 <dt id="slack_bolt.Say.channel"><code class="name">var <span class="ident">channel</span> : Optional[str]</code></dt>
 <dd>
 <div class="desc"></div>
@@ -4799,6 +4809,7 @@ <h4><code><a title="slack_bolt.SaveThreadContext" href="#slack_bolt.SaveThreadCo
 <li>
 <h4><code><a title="slack_bolt.Say" href="#slack_bolt.Say">Say</a></code></h4>
 <ul class="">
+<li><code><a title="slack_bolt.Say.build_metadata" href="#slack_bolt.Say.build_metadata">build_metadata</a></code></li>
 <li><code><a title="slack_bolt.Say.channel" href="#slack_bolt.Say.channel">channel</a></code></li>
 <li><code><a title="slack_bolt.Say.client" href="#slack_bolt.Say.client">client</a></code></li>
 <li><code><a title="slack_bolt.Say.metadata" href="#slack_bolt.Say.metadata">metadata</a></code></li>

diff --git a/slack_bolt/version.py b/slack_bolt/version.py
@@ -1,3 +1,3 @@
 """Check the latest version at https://pypi.org/project/slack-bolt/"""
 
-__version__ = "1.21.1"
+__version__ = "1.21.2"