Merge branch 'main' into docs-say_stream-docs

Author: WilliamBergamin

slack_bolt/__init__.py

@@ -14,6 +14,7 @@
 from .context.fail import Fail
 from .context.respond import Respond
 from .context.say import Say
+from .context.say_stream import SayStream
 from .kwargs_injection import Args
 from .listener import Listener
 from .listener_matcher import CustomListenerMatcher
@@ -42,6 +43,7 @@
     "Fail",
     "Respond",
     "Say",
+    "SayStream",
     "Args",
     "Listener",
     "CustomListenerMatcher",

slack_bolt/async_app.py

@@ -59,13 +59,15 @@ async def command(ack, body, respond):
 from .context.set_suggested_prompts.async_set_suggested_prompts import AsyncSetSuggestedPrompts
 from .context.get_thread_context.async_get_thread_context import AsyncGetThreadContext
 from .context.save_thread_context.async_save_thread_context import AsyncSaveThreadContext
+from .context.say_stream.async_say_stream import AsyncSayStream
 
 __all__ = [
     "AsyncApp",
     "AsyncAck",
     "AsyncBoltContext",
     "AsyncRespond",
     "AsyncSay",
+    "AsyncSayStream",
     "AsyncListener",
     "AsyncCustomListenerMatcher",
     "AsyncBoltRequest",

slack_bolt/context/assistant/assistant_utilities.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import Optional
 
 from slack_sdk.web import WebClient
@@ -51,6 +52,13 @@ def is_valid(self) -> bool:
 
     @property
     def set_status(self) -> SetStatus:
+        warnings.warn(
+            "AssistantUtilities.set_status is deprecated. "
+            "Use the set_status argument directly in your listener function "
+            "or access it via context.set_status instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return SetStatus(self.client, self.channel_id, self.thread_ts)
 
     @property

slack_bolt/context/assistant/async_assistant_utilities.py

@@ -1,3 +1,4 @@
+import warnings
 from typing import Optional
 
 from slack_sdk.web.async_client import AsyncWebClient
@@ -54,6 +55,13 @@ def is_valid(self) -> bool:
 
     @property
     def set_status(self) -> AsyncSetStatus:
+        warnings.warn(
+            "AsyncAssistantUtilities.set_status is deprecated. "
+            "Use the set_status argument directly in your listener function "
+            "or access it via context.set_status instead.",
+            DeprecationWarning,
+            stacklevel=2,
+        )
         return AsyncSetStatus(self.client, self.channel_id, self.thread_ts)
 
     @property

slack_bolt/context/async_context.py

@@ -10,6 +10,7 @@
 from slack_bolt.context.get_thread_context.async_get_thread_context import AsyncGetThreadContext
 from slack_bolt.context.save_thread_context.async_save_thread_context import AsyncSaveThreadContext
 from slack_bolt.context.say.async_say import AsyncSay
+from slack_bolt.context.say_stream.async_say_stream import AsyncSayStream
 from slack_bolt.context.set_status.async_set_status import AsyncSetStatus
 from slack_bolt.context.set_suggested_prompts.async_set_suggested_prompts import AsyncSetSuggestedPrompts
 from slack_bolt.context.set_title.async_set_title import AsyncSetTitle
@@ -203,6 +204,10 @@ def set_suggested_prompts(self) -> Optional[AsyncSetSuggestedPrompts]:
     def get_thread_context(self) -> Optional[AsyncGetThreadContext]:
         return self.get("get_thread_context")
 
+    @property
+    def say_stream(self) -> Optional[AsyncSayStream]:
+        return self.get("say_stream")
+
     @property
     def save_thread_context(self) -> Optional[AsyncSaveThreadContext]:
         return self.get("save_thread_context")

slack_bolt/context/base_context.py

@@ -38,6 +38,7 @@ class BaseContext(dict):
         "set_status",
         "set_title",
         "set_suggested_prompts",
+        "say_stream",
     ]
     # Note that these items are not copyable, so when you add new items to this list,
     # you must modify ThreadListenerRunner/AsyncioListenerRunner's _build_lazy_request method to pass the values.

slack_bolt/context/context.py

@@ -10,6 +10,7 @@
 from slack_bolt.context.respond import Respond
 from slack_bolt.context.save_thread_context import SaveThreadContext
 from slack_bolt.context.say import Say
+from slack_bolt.context.say_stream import SayStream
 from slack_bolt.context.set_status import SetStatus
 from slack_bolt.context.set_suggested_prompts import SetSuggestedPrompts
 from slack_bolt.context.set_title import SetTitle
@@ -204,6 +205,10 @@ def set_suggested_prompts(self) -> Optional[SetSuggestedPrompts]:
     def get_thread_context(self) -> Optional[GetThreadContext]:
         return self.get("get_thread_context")
 
+    @property
+    def say_stream(self) -> Optional[SayStream]:
+        return self.get("say_stream")
+
     @property
     def save_thread_context(self) -> Optional[SaveThreadContext]:
         return self.get("save_thread_context")

slack_bolt/context/say_stream/__init__.py

@@ -0,0 +1,6 @@
+# Don't add async module imports here
+from .say_stream import SayStream
+
+__all__ = [
+    "SayStream",
+]

slack_bolt/context/say_stream/async_say_stream.py

@@ -0,0 +1,74 @@
+import warnings
+from typing import Optional
+
+from slack_sdk.web.async_client import AsyncWebClient
+from slack_sdk.web.async_chat_stream import AsyncChatStream
+
+from slack_bolt.warning import ExperimentalWarning
+
+
+class AsyncSayStream:
+    client: AsyncWebClient
+    channel: Optional[str]
+    recipient_team_id: Optional[str]
+    recipient_user_id: Optional[str]
+    thread_ts: Optional[str]
+
+    def __init__(
+        self,
+        *,
+        client: AsyncWebClient,
+        channel: Optional[str] = None,
+        recipient_team_id: Optional[str] = None,
+        recipient_user_id: Optional[str] = None,
+        thread_ts: Optional[str] = None,
+    ):
+        self.client = client
+        self.channel = channel
+        self.recipient_team_id = recipient_team_id
+        self.recipient_user_id = recipient_user_id
+        self.thread_ts = thread_ts
+
+    async def __call__(
+        self,
+        *,
+        buffer_size: Optional[int] = None,
+        channel: Optional[str] = None,
+        recipient_team_id: Optional[str] = None,
+        recipient_user_id: Optional[str] = None,
+        thread_ts: Optional[str] = None,
+        **kwargs,
+    ) -> AsyncChatStream:
+        """Starts a new chat stream with context.
+
+        Warning: This is an experimental feature and may change in future versions.
+        """
+        warnings.warn(
+            "say_stream is experimental and may change in future versions.",
+            category=ExperimentalWarning,
+            stacklevel=2,
+        )
+
+        channel = channel or self.channel
+        thread_ts = thread_ts or self.thread_ts
+        if channel is None:
+            raise ValueError("say_stream without channel here is unsupported")
+        if thread_ts is None:
+            raise ValueError("say_stream without thread_ts here is unsupported")
+
+        if buffer_size is not None:
+            return await self.client.chat_stream(
+                buffer_size=buffer_size,
+                channel=channel,
+                recipient_team_id=recipient_team_id or self.recipient_team_id,
+                recipient_user_id=recipient_user_id or self.recipient_user_id,
+                thread_ts=thread_ts,
+                **kwargs,
+            )
+        return await self.client.chat_stream(
+            channel=channel,
+            recipient_team_id=recipient_team_id or self.recipient_team_id,
+            recipient_user_id=recipient_user_id or self.recipient_user_id,
+            thread_ts=thread_ts,
+            **kwargs,
+        )

slack_bolt/context/say_stream/say_stream.py

@@ -0,0 +1,74 @@
+import warnings
+from typing import Optional
+
+from slack_sdk import WebClient
+from slack_sdk.web.chat_stream import ChatStream
+
+from slack_bolt.warning import ExperimentalWarning
+
+
+class SayStream:
+    client: WebClient
+    channel: Optional[str]
+    recipient_team_id: Optional[str]
+    recipient_user_id: Optional[str]
+    thread_ts: Optional[str]
+
+    def __init__(
+        self,
+        *,
+        client: WebClient,
+        channel: Optional[str] = None,
+        recipient_team_id: Optional[str] = None,
+        recipient_user_id: Optional[str] = None,
+        thread_ts: Optional[str] = None,
+    ):
+        self.client = client
+        self.channel = channel
+        self.recipient_team_id = recipient_team_id
+        self.recipient_user_id = recipient_user_id
+        self.thread_ts = thread_ts
+
+    def __call__(
+        self,
+        *,
+        buffer_size: Optional[int] = None,
+        channel: Optional[str] = None,
+        recipient_team_id: Optional[str] = None,
+        recipient_user_id: Optional[str] = None,
+        thread_ts: Optional[str] = None,
+        **kwargs,
+    ) -> ChatStream:
+        """Starts a new chat stream with context.
+
+        Warning: This is an experimental feature and may change in future versions.
+        """
+        warnings.warn(
+            "say_stream is experimental and may change in future versions.",
+            category=ExperimentalWarning,
+            stacklevel=2,
+        )
+
+        channel = channel or self.channel
+        thread_ts = thread_ts or self.thread_ts
+        if channel is None:
+            raise ValueError("say_stream without channel here is unsupported")
+        if thread_ts is None:
+            raise ValueError("say_stream without thread_ts here is unsupported")
+
+        if buffer_size is not None:
+            return self.client.chat_stream(
+                buffer_size=buffer_size,
+                channel=channel,
+                recipient_team_id=recipient_team_id or self.recipient_team_id,
+                recipient_user_id=recipient_user_id or self.recipient_user_id,
+                thread_ts=thread_ts,
+                **kwargs,
+            )
+        return self.client.chat_stream(
+            channel=channel,
+            recipient_team_id=recipient_team_id or self.recipient_team_id,
+            recipient_user_id=recipient_user_id or self.recipient_user_id,
+            thread_ts=thread_ts,
+            **kwargs,
+        )