slack-sdk 3.36.0.dev3__tar.gz → 3.36.0.dev4__tar.gz

{slack_sdk-3.36.0.dev3/slack_sdk.egg-info → slack_sdk-3.36.0.dev4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slack_sdk
-Version: 3.36.0.dev3
+Version: 3.36.0.dev4
 Summary: The Slack API Platform SDK for Python
 Home-page: https://github.com/slackapi/python-slack-sdk
 Author: Slack Technologies, LLC

{slack_sdk-3.36.0.dev3 → slack_sdk-3.36.0.dev4}/slack_sdk/version.py

@@ -1,3 +1,3 @@
 """Check the latest version at https://pypi.org/project/slack-sdk/"""
 
-__version__ = "3.36.0.dev3"
+__version__ = "3.36.0.dev4"

{slack_sdk-3.36.0.dev3 → slack_sdk-3.36.0.dev4}/slack_sdk/web/async_client.py

@@ -2878,7 +2878,7 @@ class AsyncWebClient(AsyncBaseClient):
         self,
         *,
         channel: str,
-        thread_ts: Optional[str] = None,
+        thread_ts: str,
         markdown_text: Optional[str] = None,
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,

slack_sdk-3.36.0.dev4/slack_sdk/web/chat_stream.py

@@ -0,0 +1,160 @@
+# from typing import Dict, Optional, Sequence, Union
+#
+# from slack_sdk.models.blocks.blocks import Block
+# from slack_sdk.models.metadata import Metadata
+# from slack_sdk.web.client import WebClient
+# from slack_sdk.web.slack_response import SlackResponse
+#
+#
+# class ChatStreamer:
+#     """A helper class for streaming markdown text into a conversation using the chat streaming APIs.
+#
+#     This class provides a convenient interface for the chat.startStream, chat.appendStream,
+#     and chat.stopStream API methods, with automatic buffering and state management.
+#     """
+#
+#     def __init__(
+#         self,
+#         client: "WebClient",
+#         *,
+#         channel: str,
+#         thread_ts: str,
+#         recipient_team_id: Optional[str] = None,
+#         recipient_user_id: Optional[str] = None,
+#         unfurl_links: Optional[bool] = None,
+#         unfurl_media: Optional[bool] = None,
+#         buffer_size: int = 256,
+#         **kwargs,
+#     ):
+#         """Initialize a new ChatStreamer instance.
+#
+#         Args:
+#             client: The WebClient instance to use for API calls
+#             channel: Channel to stream to
+#             thread_ts: Thread timestamp to stream to
+#             recipient_team_id: Team ID of the recipient (for Slack Connect)
+#             recipient_user_id: User ID of the recipient (for Slack Connect)
+#             unfurl_links: Whether to unfurl links
+#             unfurl_media: Whether to unfurl media
+#             buffer_size: Size of the internal buffer before automatically flushing (default: 256)
+#             **kwargs: Additional arguments passed to the underlying API calls
+#         """
+#         self._client = client
+#         self._stream_args = {
+#             "channel": channel,
+#             "thread_ts": thread_ts,
+#             "recipient_team_id": recipient_team_id,
+#             "recipient_user_id": recipient_user_id,
+#             "unfurl_links": unfurl_links,
+#             "unfurl_media": unfurl_media,
+#             **kwargs,
+#         }
+#         self._buffer = ""
+#         self._state = "starting"  # starting -> in_progress -> completed
+#         self._stream_ts: Optional[str] = None
+#         self._buffer_size = buffer_size
+#
+#     def append(
+#         self,
+#         *,
+#         markdown_text: str,
+#         **kwargs,
+#     ) -> Optional[SlackResponse]:
+#         """Append markdown text to the stream.
+#
+#         Args:
+#             markdown_text: The markdown text to append
+#             **kwargs: Additional arguments passed to the underlying API calls
+#
+#         Returns:
+#             SlackResponse if the buffer was flushed, None if buffering
+#
+#         Raises:
+#             SlackRequestError: If the stream is already completed
+#         """
+#         if self._state == "completed":
+#             raise e.SlackRequestError(f"Cannot append to stream: stream state is {self._state}")
+#
+#         self._buffer += markdown_text
+#
+#         if len(self._buffer) >= self._buffer_size:
+#             return self._flush_buffer(**kwargs)
+#
+#         return None
+#
+#     def stop(
+#         self,
+#         *,
+#         markdown_text: Optional[str] = None,
+#         blocks: Optional[Union[str, Sequence[Union[Dict, Block]]]] = None,
+#         metadata: Optional[Union[Dict, Metadata]] = None,
+#         **kwargs,
+#     ) -> SlackResponse:
+#         """Stop the stream and finalize the message.
+#
+#         Args:
+#             markdown_text: Additional markdown text to append before stopping
+#             blocks: Message blocks to add to the final message
+#             metadata: Message metadata to add to the final message
+#             **kwargs: Additional arguments passed to the underlying API calls
+#
+#         Returns:
+#             SlackResponse from the chat.stopStream API call
+#
+#         Raises:
+#             SlackRequestError: If the stream is already completed
+#         """
+#         if self._state == "completed":
+#             raise e.SlackRequestError(f"Cannot stop stream: stream state is {self._state}")
+#
+#         # Add any final markdown text to the buffer
+#         if markdown_text:
+#             self._buffer += markdown_text
+#
+#         # Start the stream if not already started
+#         if not self._stream_ts:
+#             response = self._client.chat_startStream(
+#                 **self._stream_args,
+#                 **kwargs,
+#             )
+#             if not response.get("ts"):
+#                 raise e.SlackRequestError("Failed to stop stream: stream not started")
+#             self._stream_ts = response["ts"]
+#             self._state = "in_progress"
+#
+#         # Stop the stream with any remaining buffer content
+#         final_text = self._buffer if self._buffer else None
+#         response = self._client.chat_stopStream(
+#             channel=self._stream_args["channel"],
+#             ts=self._stream_ts,
+#             markdown_text=final_text,
+#             blocks=blocks,
+#             metadata=metadata,
+#             **kwargs,
+#         )
+#
+#         self._state = "completed"
+#         return response
+#
+#     def _flush_buffer(self, **kwargs) -> SlackResponse:
+#         """Flush the internal buffer by making appropriate API calls."""
+#         if not self._stream_ts:
+#             # Start the stream with the current buffer content
+#             response = self._client.chat_startStream(
+#                 **self._stream_args,
+#                 markdown_text=self._buffer,
+#                 **kwargs,
+#             )
+#             self._stream_ts = response.get("ts")
+#             self._state = "in_progress"
+#         else:
+#             # Append to the existing stream
+#             response = self._client.chat_appendStream(
+#                 channel=self._stream_args["channel"],
+#                 ts=self._stream_ts,
+#                 markdown_text=self._buffer,
+#                 **kwargs,
+#             )
+#
+#         self._buffer = ""
+#         return response

{slack_sdk-3.36.0.dev3 → slack_sdk-3.36.0.dev4}/slack_sdk/web/client.py

@@ -2868,7 +2868,7 @@ class WebClient(BaseClient):
         self,
         *,
         channel: str,
-        thread_ts: Optional[str] = None,
+        thread_ts: str,
         markdown_text: Optional[str] = None,
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,

{slack_sdk-3.36.0.dev3 → slack_sdk-3.36.0.dev4}/slack_sdk/web/legacy_client.py

@@ -2880,7 +2880,7 @@ class LegacyWebClient(LegacyBaseClient):
         self,
         *,
         channel: str,
-        thread_ts: Optional[str] = None,
+        thread_ts: str,
         markdown_text: Optional[str] = None,
         recipient_team_id: Optional[str] = None,
         recipient_user_id: Optional[str] = None,

{slack_sdk-3.36.0.dev3 → slack_sdk-3.36.0.dev4/slack_sdk.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: slack_sdk
-Version: 3.36.0.dev3
+Version: 3.36.0.dev4
 Summary: The Slack API Platform SDK for Python
 Home-page: https://github.com/slackapi/python-slack-sdk
 Author: Slack Technologies, LLC

{slack_sdk-3.36.0.dev3 → slack_sdk-3.36.0.dev4}/slack_sdk.egg-info/SOURCES.txt

@@ -148,6 +148,7 @@ slack_sdk/web/async_client.py
 slack_sdk/web/async_internal_utils.py
 slack_sdk/web/async_slack_response.py
 slack_sdk/web/base_client.py
+slack_sdk/web/chat_stream.py
 slack_sdk/web/client.py
 slack_sdk/web/deprecation.py
 slack_sdk/web/file_upload_v2_result.py