Skip to content

Commit 9de07b1

Browse files
committedOct 25, 2024·
version 1.21.2
1 parent 38167c4 commit 9de07b1

File tree

5 files changed

+57
-18
lines changed

5 files changed

+57
-18
lines changed
 

‎docs/static/api-docs/slack_bolt/context/assistant/assistant_utilities.html

+14-8
Original file line numberDiff line numberDiff line change
@@ -93,14 +93,17 @@ <h2 class="section-title" id="header-classes">Classes</h2>
9393

9494
@property
9595
def say(self) -&gt; Say:
96+
def build_metadata() -&gt; Optional[dict]:
97+
thread_context = self.get_thread_context()
98+
if thread_context is not None:
99+
return {&#34;event_type&#34;: &#34;assistant_thread_context&#34;, &#34;event_payload&#34;: thread_context}
100+
return None
101+
96102
return Say(
97103
self.client,
98104
channel=self.channel_id,
99105
thread_ts=self.thread_ts,
100-
metadata={
101-
&#34;event_type&#34;: &#34;assistant_thread_context&#34;,
102-
&#34;event_payload&#34;: self.get_thread_context(),
103-
},
106+
build_metadata=build_metadata,
104107
)
105108

106109
@property
@@ -169,14 +172,17 @@ <h3>Instance variables</h3>
169172
</summary>
170173
<pre><code class="python">@property
171174
def say(self) -&gt; Say:
175+
def build_metadata() -&gt; Optional[dict]:
176+
thread_context = self.get_thread_context()
177+
if thread_context is not None:
178+
return {&#34;event_type&#34;: &#34;assistant_thread_context&#34;, &#34;event_payload&#34;: thread_context}
179+
return None
180+
172181
return Say(
173182
self.client,
174183
channel=self.channel_id,
175184
thread_ts=self.thread_ts,
176-
metadata={
177-
&#34;event_type&#34;: &#34;assistant_thread_context&#34;,
178-
&#34;event_payload&#34;: self.get_thread_context(),
179-
},
185+
build_metadata=build_metadata,
180186
)</code></pre>
181187
</details>
182188
</dd>

‎docs/static/api-docs/slack_bolt/context/say/index.html

+14-3
Original file line numberDiff line numberDiff line change
@@ -52,7 +52,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
5252
<dl>
5353
<dt id="slack_bolt.context.say.Say"><code class="flex name class">
5454
<span>class <span class="ident">Say</span></span>
55-
<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>
55+
<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>
5656
</code></dt>
5757
<dd>
5858
<div class="desc"></div>
@@ -65,18 +65,21 @@ <h2 class="section-title" id="header-classes">Classes</h2>
6565
channel: Optional[str]
6666
thread_ts: Optional[str]
6767
metadata: Optional[Union[Dict, Metadata]]
68+
build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]]
6869

6970
def __init__(
7071
self,
7172
client: Optional[WebClient],
7273
channel: Optional[str],
7374
thread_ts: Optional[str] = None,
7475
metadata: Optional[Union[Dict, Metadata]] = None,
76+
build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]] = None,
7577
):
7678
self.client = client
7779
self.channel = channel
7880
self.thread_ts = thread_ts
7981
self.metadata = metadata
82+
self.build_metadata = build_metadata
8083

8184
def __call__(
8285
self,
@@ -102,6 +105,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
102105
text_or_whole_response: Union[str, dict] = text
103106
if isinstance(text_or_whole_response, str):
104107
text = text_or_whole_response
108+
if metadata is None:
109+
metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
105110
return self.client.chat_postMessage( # type: ignore[union-attr]
106111
channel=channel or self.channel, # type: ignore[arg-type]
107112
text=text,
@@ -118,7 +123,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
118123
mrkdwn=mrkdwn,
119124
link_names=link_names,
120125
parse=parse,
121-
metadata=metadata or self.metadata,
126+
metadata=metadata,
122127
**kwargs,
123128
)
124129
elif isinstance(text_or_whole_response, dict):
@@ -128,7 +133,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
128133
if &#34;thread_ts&#34; not in message:
129134
message[&#34;thread_ts&#34;] = thread_ts or self.thread_ts
130135
if &#34;metadata&#34; not in message:
131-
message[&#34;metadata&#34;] = metadata or self.metadata
136+
metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
137+
message[&#34;metadata&#34;] = metadata
132138
return self.client.chat_postMessage(**message) # type: ignore[union-attr]
133139
else:
134140
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>
137143
</details>
138144
<h3>Class variables</h3>
139145
<dl>
146+
<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>
147+
<dd>
148+
<div class="desc"></div>
149+
</dd>
140150
<dt id="slack_bolt.context.say.Say.channel"><code class="name">var <span class="ident">channel</span> : Optional[str]</code></dt>
141151
<dd>
142152
<div class="desc"></div>
@@ -180,6 +190,7 @@ <h3>Class variables</h3>
180190
<li>
181191
<h4><code><a title="slack_bolt.context.say.Say" href="#slack_bolt.context.say.Say">Say</a></code></h4>
182192
<ul class="">
193+
<li><code><a title="slack_bolt.context.say.Say.build_metadata" href="#slack_bolt.context.say.Say.build_metadata">build_metadata</a></code></li>
183194
<li><code><a title="slack_bolt.context.say.Say.channel" href="#slack_bolt.context.say.Say.channel">channel</a></code></li>
184195
<li><code><a title="slack_bolt.context.say.Say.client" href="#slack_bolt.context.say.Say.client">client</a></code></li>
185196
<li><code><a title="slack_bolt.context.say.Say.metadata" href="#slack_bolt.context.say.Say.metadata">metadata</a></code></li>

‎docs/static/api-docs/slack_bolt/context/say/say.html

+14-3
Original file line numberDiff line numberDiff line change
@@ -37,7 +37,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
3737
<dl>
3838
<dt id="slack_bolt.context.say.say.Say"><code class="flex name class">
3939
<span>class <span class="ident">Say</span></span>
40-
<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>
40+
<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>
4141
</code></dt>
4242
<dd>
4343
<div class="desc"></div>
@@ -50,18 +50,21 @@ <h2 class="section-title" id="header-classes">Classes</h2>
5050
channel: Optional[str]
5151
thread_ts: Optional[str]
5252
metadata: Optional[Union[Dict, Metadata]]
53+
build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]]
5354

5455
def __init__(
5556
self,
5657
client: Optional[WebClient],
5758
channel: Optional[str],
5859
thread_ts: Optional[str] = None,
5960
metadata: Optional[Union[Dict, Metadata]] = None,
61+
build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]] = None,
6062
):
6163
self.client = client
6264
self.channel = channel
6365
self.thread_ts = thread_ts
6466
self.metadata = metadata
67+
self.build_metadata = build_metadata
6568

6669
def __call__(
6770
self,
@@ -87,6 +90,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
8790
text_or_whole_response: Union[str, dict] = text
8891
if isinstance(text_or_whole_response, str):
8992
text = text_or_whole_response
93+
if metadata is None:
94+
metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
9095
return self.client.chat_postMessage( # type: ignore[union-attr]
9196
channel=channel or self.channel, # type: ignore[arg-type]
9297
text=text,
@@ -103,7 +108,7 @@ <h2 class="section-title" id="header-classes">Classes</h2>
103108
mrkdwn=mrkdwn,
104109
link_names=link_names,
105110
parse=parse,
106-
metadata=metadata or self.metadata,
111+
metadata=metadata,
107112
**kwargs,
108113
)
109114
elif isinstance(text_or_whole_response, dict):
@@ -113,7 +118,8 @@ <h2 class="section-title" id="header-classes">Classes</h2>
113118
if &#34;thread_ts&#34; not in message:
114119
message[&#34;thread_ts&#34;] = thread_ts or self.thread_ts
115120
if &#34;metadata&#34; not in message:
116-
message[&#34;metadata&#34;] = metadata or self.metadata
121+
metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
122+
message[&#34;metadata&#34;] = metadata
117123
return self.client.chat_postMessage(**message) # type: ignore[union-attr]
118124
else:
119125
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>
122128
</details>
123129
<h3>Class variables</h3>
124130
<dl>
131+
<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>
132+
<dd>
133+
<div class="desc"></div>
134+
</dd>
125135
<dt id="slack_bolt.context.say.say.Say.channel"><code class="name">var <span class="ident">channel</span> : Optional[str]</code></dt>
126136
<dd>
127137
<div class="desc"></div>
@@ -158,6 +168,7 @@ <h3>Class variables</h3>
158168
<li>
159169
<h4><code><a title="slack_bolt.context.say.say.Say" href="#slack_bolt.context.say.say.Say">Say</a></code></h4>
160170
<ul class="">
171+
<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>
161172
<li><code><a title="slack_bolt.context.say.say.Say.channel" href="#slack_bolt.context.say.say.Say.channel">channel</a></code></li>
162173
<li><code><a title="slack_bolt.context.say.say.Say.client" href="#slack_bolt.context.say.say.Say.client">client</a></code></li>
163174
<li><code><a title="slack_bolt.context.say.say.Say.metadata" href="#slack_bolt.context.say.say.Say.metadata">metadata</a></code></li>

‎docs/static/api-docs/slack_bolt/index.html

+14-3
Original file line numberDiff line numberDiff line change
@@ -4300,7 +4300,7 @@ <h3>Class variables</h3>
43004300
</dd>
43014301
<dt id="slack_bolt.Say"><code class="flex name class">
43024302
<span>class <span class="ident">Say</span></span>
4303-
<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>
4303+
<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>
43044304
</code></dt>
43054305
<dd>
43064306
<div class="desc"></div>
@@ -4313,18 +4313,21 @@ <h3>Class variables</h3>
43134313
channel: Optional[str]
43144314
thread_ts: Optional[str]
43154315
metadata: Optional[Union[Dict, Metadata]]
4316+
build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]]
43164317

43174318
def __init__(
43184319
self,
43194320
client: Optional[WebClient],
43204321
channel: Optional[str],
43214322
thread_ts: Optional[str] = None,
43224323
metadata: Optional[Union[Dict, Metadata]] = None,
4324+
build_metadata: Optional[Callable[[], Optional[Union[Dict, Metadata]]]] = None,
43234325
):
43244326
self.client = client
43254327
self.channel = channel
43264328
self.thread_ts = thread_ts
43274329
self.metadata = metadata
4330+
self.build_metadata = build_metadata
43284331

43294332
def __call__(
43304333
self,
@@ -4350,6 +4353,8 @@ <h3>Class variables</h3>
43504353
text_or_whole_response: Union[str, dict] = text
43514354
if isinstance(text_or_whole_response, str):
43524355
text = text_or_whole_response
4356+
if metadata is None:
4357+
metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
43534358
return self.client.chat_postMessage( # type: ignore[union-attr]
43544359
channel=channel or self.channel, # type: ignore[arg-type]
43554360
text=text,
@@ -4366,7 +4371,7 @@ <h3>Class variables</h3>
43664371
mrkdwn=mrkdwn,
43674372
link_names=link_names,
43684373
parse=parse,
4369-
metadata=metadata or self.metadata,
4374+
metadata=metadata,
43704375
**kwargs,
43714376
)
43724377
elif isinstance(text_or_whole_response, dict):
@@ -4376,7 +4381,8 @@ <h3>Class variables</h3>
43764381
if &#34;thread_ts&#34; not in message:
43774382
message[&#34;thread_ts&#34;] = thread_ts or self.thread_ts
43784383
if &#34;metadata&#34; not in message:
4379-
message[&#34;metadata&#34;] = metadata or self.metadata
4384+
metadata = self.build_metadata() if self.build_metadata is not None else self.metadata
4385+
message[&#34;metadata&#34;] = metadata
43804386
return self.client.chat_postMessage(**message) # type: ignore[union-attr]
43814387
else:
43824388
raise ValueError(f&#34;The arg is unexpected type ({type(text_or_whole_response)})&#34;)
@@ -4385,6 +4391,10 @@ <h3>Class variables</h3>
43854391
</details>
43864392
<h3>Class variables</h3>
43874393
<dl>
4394+
<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>
4395+
<dd>
4396+
<div class="desc"></div>
4397+
</dd>
43884398
<dt id="slack_bolt.Say.channel"><code class="name">var <span class="ident">channel</span> : Optional[str]</code></dt>
43894399
<dd>
43904400
<div class="desc"></div>
@@ -4799,6 +4809,7 @@ <h4><code><a title="slack_bolt.SaveThreadContext" href="#slack_bolt.SaveThreadCo
47994809
<li>
48004810
<h4><code><a title="slack_bolt.Say" href="#slack_bolt.Say">Say</a></code></h4>
48014811
<ul class="">
4812+
<li><code><a title="slack_bolt.Say.build_metadata" href="#slack_bolt.Say.build_metadata">build_metadata</a></code></li>
48024813
<li><code><a title="slack_bolt.Say.channel" href="#slack_bolt.Say.channel">channel</a></code></li>
48034814
<li><code><a title="slack_bolt.Say.client" href="#slack_bolt.Say.client">client</a></code></li>
48044815
<li><code><a title="slack_bolt.Say.metadata" href="#slack_bolt.Say.metadata">metadata</a></code></li>

‎slack_bolt/version.py

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,3 @@
11
"""Check the latest version at https://pypi.org/project/slack-bolt/"""
22

3-
__version__ = "1.21.1"
3+
__version__ = "1.21.2"

0 commit comments

Comments
 (0)
Please sign in to comment.