slack-sdk 3.40.0.dev0__tar.gz → 3.41.0__tar.gz

{slack_sdk-3.40.0.dev0/slack_sdk.egg-info → slack_sdk-3.41.0}/PKG-INFO

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

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/models/blocks/block_elements.py

@@ -1668,7 +1668,6 @@ class UrlSourceElement(BlockElement):
             {
                 "url",
                 "text",
-                "icon_url",
             }
         )
 
@@ -1677,23 +1676,20 @@ class UrlSourceElement(BlockElement):
         *,
         url: str,
         text: str,
-        icon_url: Optional[str] = None,
         **others: Dict,
     ):
         """
-        A URL source element to reference in a task card block.
+        A URL source element that displays a URL source for referencing within a task card block.
         https://docs.slack.dev/reference/block-kit/block-elements/url-source-element
 
         Args:
             url (required): The URL type source.
             text (required): Display text for the URL.
-            icon_url: Optional icon URL to display with the source.
         """
         super().__init__(type=self.type)
         show_unknown_key_warning(self, others)
         self.url = url
         self.text = text
-        self.icon_url = icon_url
 
 
 # -------------------------------------------------

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/models/blocks/blocks.py

@@ -812,7 +812,7 @@ class TaskCardBlock(Block):
         block_id: Optional[str] = None,
         **others: dict,
     ):
-        """A discrete action or tool call.
+        """Displays a single task, representing a single action.
         https://docs.slack.dev/reference/block-kit/blocks/task-card-block/
 
         Args:
@@ -824,8 +824,8 @@ class TaskCardBlock(Block):
             title (required): Title of the task in plain text
             details: Details of the task in the form of a single "rich_text" entity.
             output: Output of the task in the form of a single "rich_text" entity.
-            sources: List of sources used to generate a response
-            status: The state of a task. Either "pending" or "in_progress" or "complete" or "error".
+            sources: Array of URL source elements used to generate a response.
+            status: The state of a task. Either "pending", "in_progress", "complete", or "error".
         """
         super().__init__(type=self.type, block_id=block_id)
         show_unknown_key_warning(self, others)
@@ -849,7 +849,6 @@ class PlanBlock(Block):
     def attributes(self) -> Set[str]:  # type: ignore[override]
         return super().attributes.union(
             {
-                "plan_id",
                 "title",
                 "tasks",
             }
@@ -858,13 +857,12 @@ class PlanBlock(Block):
     def __init__(
         self,
         *,
-        plan_id: str,
         title: str,
         tasks: Optional[Sequence[Union[Dict, TaskCardBlock]]] = None,
         block_id: Optional[str] = None,
         **others: dict,
     ):
-        """A collection of related tasks.
+        """Displays a collection of related tasks.
         https://docs.slack.dev/reference/block-kit/blocks/plan-block/
 
         Args:
@@ -872,14 +870,11 @@ class PlanBlock(Block):
                 Maximum length for this field is 255 characters.
                 block_id should be unique for each message and each iteration of a message.
                 If a message is updated, use a new block_id.
-            plan_id (required): ID for the plan (May be removed / made optional, feel free to pass in a random UUID
-                for now)
             title (required): Title of the plan in plain text
-            tasks: Details of the task in the form of a single "rich_text" entity.
+            tasks: A sequence of task card blocks. Each task represents a single action within the plan.
         """
         super().__init__(type=self.type, block_id=block_id)
         show_unknown_key_warning(self, others)
 
-        self.plan_id = plan_id
         self.title = title
         self.tasks = tasks

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/models/messages/chunk.py

@@ -82,7 +82,7 @@ class PlanUpdateChunk(Chunk):
         title: str,
         **others: Dict,
     ):
-        """An updated title of plans for task and tool calls.
+        """Used for displaying an updated title of a plan.
 
         https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming
         """
@@ -119,7 +119,7 @@ class TaskUpdateChunk(Chunk):
         sources: Optional[Sequence[Union[Dict, UrlSourceElement]]] = None,
         **others: Dict,
     ):
-        """Used for displaying tool execution progress in a timeline-style UI.
+        """Used for displaying task progress in a timeline-style UI.
 
         https://docs.slack.dev/messaging/sending-and-scheduling-messages#text-streaming
         """

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/oauth/installation_store/sqlalchemy/__init__.py

@@ -23,6 +23,7 @@ from slack_sdk.oauth.installation_store.models.installation import Installation
 from slack_sdk.oauth.installation_store.async_installation_store import (
     AsyncInstallationStore,
 )
+from slack_sdk.oauth.sqlalchemy_utils import normalize_datetime_for_db
 
 
 class SQLAlchemyInstallationStore(InstallationStore):
@@ -140,6 +141,9 @@ class SQLAlchemyInstallationStore(InstallationStore):
         with self.engine.begin() as conn:
             i = installation.to_dict()
             i["client_id"] = self.client_id
+            i["installed_at"] = normalize_datetime_for_db(i.get("installed_at"))
+            i["bot_token_expires_at"] = normalize_datetime_for_db(i.get("bot_token_expires_at"))
+            i["user_token_expires_at"] = normalize_datetime_for_db(i.get("user_token_expires_at"))
 
             i_column = self.installations.c
             installations_rows = conn.execute(
@@ -171,6 +175,8 @@ class SQLAlchemyInstallationStore(InstallationStore):
             # bots
             b = bot.to_dict()
             b["client_id"] = self.client_id
+            b["installed_at"] = normalize_datetime_for_db(b.get("installed_at"))
+            b["bot_token_expires_at"] = normalize_datetime_for_db(b.get("bot_token_expires_at"))
 
             b_column = self.bots.c
             bots_rows = conn.execute(
@@ -419,6 +425,9 @@ class AsyncSQLAlchemyInstallationStore(AsyncInstallationStore):
         async with self.engine.begin() as conn:
             i = installation.to_dict()
             i["client_id"] = self.client_id
+            i["installed_at"] = normalize_datetime_for_db(i.get("installed_at"))
+            i["bot_token_expires_at"] = normalize_datetime_for_db(i.get("bot_token_expires_at"))
+            i["user_token_expires_at"] = normalize_datetime_for_db(i.get("user_token_expires_at"))
 
             i_column = self.installations.c
             installations_rows = await conn.execute(
@@ -450,6 +459,8 @@ class AsyncSQLAlchemyInstallationStore(AsyncInstallationStore):
             # bots
             b = bot.to_dict()
             b["client_id"] = self.client_id
+            b["installed_at"] = normalize_datetime_for_db(b.get("installed_at"))
+            b["bot_token_expires_at"] = normalize_datetime_for_db(b.get("bot_token_expires_at"))
 
             b_column = self.bots.c
             bots_rows = await conn.execute(

slack_sdk-3.41.0/slack_sdk/oauth/sqlalchemy_utils/__init__.py

@@ -0,0 +1,33 @@
+from datetime import datetime
+from typing import Optional
+
+
+# TODO: Remove this function in next major release (v4.0.0) after updating all
+# DateTime columns to DateTime(timezone=True). See issue #1832 for context.
+def normalize_datetime_for_db(dt: Optional[datetime]) -> Optional[datetime]:
+    """
+    Normalize timezone-aware datetime to naive UTC datetime for database storage.
+
+    Ensures compatibility with existing databases using TIMESTAMP WITHOUT TIME ZONE.
+    SQLAlchemy DateTime columns without timezone=True create naive timestamp columns
+    in databases like PostgreSQL. This function strips timezone information from
+    timezone-aware datetimes (which are already in UTC) to enable safe comparisons.
+
+    Args:
+        dt: A timezone-aware or naive datetime object, or None
+
+    Returns:
+        A naive datetime in UTC, or None if input is None
+
+    Example:
+        >>> from datetime import datetime, timezone
+        >>> aware_dt = datetime(2024, 1, 1, 12, 0, 0, tzinfo=timezone.utc)
+        >>> naive_dt = normalize_datetime_for_db(aware_dt)
+        >>> naive_dt.tzinfo is None
+        True
+    """
+    if dt is None:
+        return None
+    if dt.tzinfo is not None:
+        return dt.replace(tzinfo=None)
+    return dt

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/oauth/state_store/sqlalchemy/__init__.py

@@ -10,6 +10,7 @@ import sqlalchemy
 from sqlalchemy import Table, Column, Integer, String, DateTime, and_, MetaData
 from sqlalchemy.engine import Engine
 from sqlalchemy.ext.asyncio import AsyncEngine
+from slack_sdk.oauth.sqlalchemy_utils import normalize_datetime_for_db
 
 
 class SQLAlchemyOAuthStateStore(OAuthStateStore):
@@ -55,7 +56,7 @@ class SQLAlchemyOAuthStateStore(OAuthStateStore):
 
     def issue(self, *args, **kwargs) -> str:
         state: str = str(uuid4())
-        now = datetime.fromtimestamp(time.time() + self.expiration_seconds, tz=timezone.utc)
+        now = normalize_datetime_for_db(datetime.fromtimestamp(time.time() + self.expiration_seconds, tz=timezone.utc))
         with self.engine.begin() as conn:
             conn.execute(
                 self.oauth_states.insert(),
@@ -65,9 +66,10 @@ class SQLAlchemyOAuthStateStore(OAuthStateStore):
 
     def consume(self, state: str) -> bool:
         try:
+            now = normalize_datetime_for_db(datetime.now(tz=timezone.utc))
             with self.engine.begin() as conn:
                 c = self.oauth_states.c
-                query = self.oauth_states.select().where(and_(c.state == state, c.expire_at > datetime.now(tz=timezone.utc)))
+                query = self.oauth_states.select().where(and_(c.state == state, c.expire_at > now))
                 result = conn.execute(query)
                 for row in result.mappings():
                     self.logger.debug(f"consume's query result: {row}")
@@ -124,7 +126,7 @@ class AsyncSQLAlchemyOAuthStateStore(AsyncOAuthStateStore):
 
     async def async_issue(self, *args, **kwargs) -> str:
         state: str = str(uuid4())
-        now = datetime.fromtimestamp(time.time() + self.expiration_seconds, tz=timezone.utc)
+        now = normalize_datetime_for_db(datetime.fromtimestamp(time.time() + self.expiration_seconds, tz=timezone.utc))
         async with self.engine.begin() as conn:
             await conn.execute(
                 self.oauth_states.insert(),
@@ -134,9 +136,10 @@ class AsyncSQLAlchemyOAuthStateStore(AsyncOAuthStateStore):
 
     async def async_consume(self, state: str) -> bool:
         try:
+            now = normalize_datetime_for_db(datetime.now(tz=timezone.utc))
             async with self.engine.begin() as conn:
                 c = self.oauth_states.c
-                query = self.oauth_states.select().where(and_(c.state == state, c.expire_at > datetime.now(tz=timezone.utc)))
+                query = self.oauth_states.select().where(and_(c.state == state, c.expire_at > now))
                 result = await conn.execute(query)
                 for row in result.mappings():
                     self.logger.debug(f"consume's query result: {row}")

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/version.py

@@ -1,3 +1,3 @@
 """Check the latest version at https://pypi.org/project/slack-sdk/"""
 
-__version__ = "3.40.0.dev0"
+__version__ = "3.41.0"

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/web/async_chat_stream.py

@@ -56,7 +56,7 @@ class AsyncChatStream:
               streaming to channels.
             recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
             task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
-              interleaved with text and "plan" displays all tasks together.
+              with text and "plan" displays all tasks together.
             buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value
               decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
             **kwargs: Additional arguments passed to the underlying API calls.
@@ -90,7 +90,7 @@ class AsyncChatStream:
         is stopped this method cannot be called.
 
         Args:
-            chunks: An array of streaming chunks that can contain either markdown text or task updates.
+            chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks.
             markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
               what will be appended to the message received so far.
             **kwargs: Additional arguments passed to the underlying API calls.
@@ -146,7 +146,7 @@ class AsyncChatStream:
 
         Args:
             blocks: A list of blocks that will be rendered at the bottom of the finalized message.
-            chunks: An array of streaming chunks that can contain either markdown text or task updates.
+            chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks.
             markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
               what will be appended to the message received so far.
             metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you
@@ -206,17 +206,17 @@ class AsyncChatStream:
 
     async def _flush_buffer(self, chunks: Optional[Sequence[Union[Dict, Chunk]]] = None, **kwargs) -> AsyncSlackResponse:
         """Flush the internal buffer with chunks by making appropriate API calls."""
-        flushings: List[Union[Dict, Chunk]] = []
+        chunks_to_flush: List[Union[Dict, Chunk]] = []
         if len(self._buffer) != 0:
-            flushings.append(MarkdownTextChunk(text=self._buffer))
+            chunks_to_flush.append(MarkdownTextChunk(text=self._buffer))
         if chunks is not None:
-            flushings.extend(chunks)
+            chunks_to_flush.extend(chunks)
         if not self._stream_ts:
             response = await self._client.chat_startStream(
                 **self._stream_args,
                 token=self._token,
                 **kwargs,
-                chunks=flushings,
+                chunks=chunks_to_flush,
             )
             self._stream_ts = response.get("ts")
             self._state = "in_progress"
@@ -226,7 +226,7 @@ class AsyncChatStream:
                 channel=self._stream_args["channel"],
                 ts=self._stream_ts,
                 **kwargs,
-                chunks=flushings,
+                chunks=chunks_to_flush,
             )
         self._buffer = ""
         return response

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/web/async_client.py

@@ -2059,6 +2059,19 @@ class AsyncWebClient(AsyncBaseClient):
         kwargs.update({"app_id": app_id})
         return await self.api_call("apps.manifest.validate", params=kwargs)
 
+    async def apps_user_connection_update(
+        self,
+        *,
+        user_id: str,
+        status: str,
+        **kwargs,
+    ) -> AsyncSlackResponse:
+        """Updates the connection status between a user and an app.
+        https://docs.slack.dev/reference/methods/apps.user.connection.update
+        """
+        kwargs.update({"user_id": user_id, "status": status})
+        return await self.api_call("apps.user.connection.update", params=kwargs)
+
     async def tooling_tokens_rotate(
         self,
         *,
@@ -2974,7 +2987,7 @@ class AsyncWebClient(AsyncBaseClient):
               streaming to channels.
             recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
             task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
-              interleaved with text and "plan" displays all tasks together.
+              with text and "plan" displays all tasks together.
             **kwargs: Additional arguments passed to the underlying API calls.
 
         Returns:

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/web/async_slack_response.py

@@ -163,12 +163,10 @@ class AsyncSlackResponse:
             raise StopAsyncIteration
 
     @overload
-    def get(self, key: str, default: None = None) -> Optional[Any]:
-        ...
+    def get(self, key: str, default: None = None) -> Optional[Any]: ...
 
     @overload
-    def get(self, key: str, default: T) -> T:
-        ...
+    def get(self, key: str, default: T) -> T: ...
 
     def get(self, key, default=None):
         """Retrieves any key from the response data.

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/web/chat_stream.py

@@ -46,7 +46,7 @@ class ChatStream:
               streaming to channels.
             recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
             task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
-              interleaved with text and "plan" displays all tasks together.
+              with text and "plan" displays all tasks together.
             buffer_size: The length of markdown_text to buffer in-memory before calling a method. Increasing this value
               decreases the number of method calls made for the same amount of text, which is useful to avoid rate limits.
             **kwargs: Additional arguments passed to the underlying API calls.
@@ -80,7 +80,7 @@ class ChatStream:
         is stopped this method cannot be called.
 
         Args:
-            chunks: An array of streaming chunks that can contain either markdown text or task updates.
+            chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks.
             markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
               what will be appended to the message received so far.
             **kwargs: Additional arguments passed to the underlying API calls.
@@ -136,7 +136,7 @@ class ChatStream:
 
         Args:
             blocks: A list of blocks that will be rendered at the bottom of the finalized message.
-            chunks: An array of streaming chunks that can contain either markdown text or task updates.
+            chunks: An array of streaming chunks. Chunks can be markdown text, plan, or task update chunks.
             markdown_text: Accepts message text formatted in markdown. Limit this field to 12,000 characters. This text is
               what will be appended to the message received so far.
             metadata: JSON object with event_type and event_payload fields, presented as a URL-encoded string. Metadata you
@@ -196,17 +196,17 @@ class ChatStream:
 
     def _flush_buffer(self, chunks: Optional[Sequence[Union[Dict, Chunk]]] = None, **kwargs) -> SlackResponse:
         """Flush the internal buffer with chunks by making appropriate API calls."""
-        flushings: List[Union[Dict, Chunk]] = []
+        chunks_to_flush: List[Union[Dict, Chunk]] = []
         if len(self._buffer) != 0:
-            flushings.append(MarkdownTextChunk(text=self._buffer))
+            chunks_to_flush.append(MarkdownTextChunk(text=self._buffer))
         if chunks is not None:
-            flushings.extend(chunks)
+            chunks_to_flush.extend(chunks)
         if not self._stream_ts:
             response = self._client.chat_startStream(
                 **self._stream_args,
                 token=self._token,
                 **kwargs,
-                chunks=flushings,
+                chunks=chunks_to_flush,
             )
             self._stream_ts = response.get("ts")
             self._state = "in_progress"
@@ -216,7 +216,7 @@ class ChatStream:
                 channel=self._stream_args["channel"],
                 ts=self._stream_ts,
                 **kwargs,
-                chunks=flushings,
+                chunks=chunks_to_flush,
             )
         self._buffer = ""
         return response

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/web/client.py

@@ -2049,6 +2049,19 @@ class WebClient(BaseClient):
         kwargs.update({"app_id": app_id})
         return self.api_call("apps.manifest.validate", params=kwargs)
 
+    def apps_user_connection_update(
+        self,
+        *,
+        user_id: str,
+        status: str,
+        **kwargs,
+    ) -> SlackResponse:
+        """Updates the connection status between a user and an app.
+        https://docs.slack.dev/reference/methods/apps.user.connection.update
+        """
+        kwargs.update({"user_id": user_id, "status": status})
+        return self.api_call("apps.user.connection.update", params=kwargs)
+
     def tooling_tokens_rotate(
         self,
         *,
@@ -2964,7 +2977,7 @@ class WebClient(BaseClient):
               streaming to channels.
             recipient_user_id: The encoded ID of the user to receive the streaming text. Required when streaming to channels.
             task_display_mode: Specifies how tasks are displayed in the message. A "timeline" displays individual tasks
-              interleaved with text and "plan" displays all tasks together.
+              with text and "plan" displays all tasks together.
             **kwargs: Additional arguments passed to the underlying API calls.
 
         Returns:

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/web/legacy_client.py

@@ -2060,6 +2060,19 @@ class LegacyWebClient(LegacyBaseClient):
         kwargs.update({"app_id": app_id})
         return self.api_call("apps.manifest.validate", params=kwargs)
 
+    def apps_user_connection_update(
+        self,
+        *,
+        user_id: str,
+        status: str,
+        **kwargs,
+    ) -> Union[Future, SlackResponse]:
+        """Updates the connection status between a user and an app.
+        https://docs.slack.dev/reference/methods/apps.user.connection.update
+        """
+        kwargs.update({"user_id": user_id, "status": status})
+        return self.api_call("apps.user.connection.update", params=kwargs)
+
     def tooling_tokens_rotate(
         self,
         *,

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk/web/slack_response.py

@@ -157,12 +157,10 @@ class SlackResponse:
             raise StopIteration
 
     @overload
-    def get(self, key: str, default: None = None) -> Optional[Any]:
-        ...
+    def get(self, key: str, default: None = None) -> Optional[Any]: ...
 
     @overload
-    def get(self, key: str, default: T) -> T:
-        ...
+    def get(self, key: str, default: T) -> T: ...
 
     def get(self, key, default=None):
         """Retrieves any key from the response data.

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0/slack_sdk.egg-info}/PKG-INFO

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

{slack_sdk-3.40.0.dev0 → slack_sdk-3.41.0}/slack_sdk.egg-info/SOURCES.txt

@@ -99,6 +99,7 @@ slack_sdk/oauth/installation_store/models/installation.py
 slack_sdk/oauth/installation_store/sqlalchemy/__init__.py
 slack_sdk/oauth/installation_store/sqlite3/__init__.py
 slack_sdk/oauth/redirect_uri_page_renderer/__init__.py
+slack_sdk/oauth/sqlalchemy_utils/__init__.py
 slack_sdk/oauth/state_store/__init__.py
 slack_sdk/oauth/state_store/async_state_store.py
 slack_sdk/oauth/state_store/state_store.py