Module slack_sdk.socket_mode.websockets
websockets bassd Socket Mode client
- https://api.slack.com/apis/connections/socket
- https://slack.dev/python-slack-sdk/socket-mode/
- https://pypi.org/project/websockets/
Expand source code
"""websockets bassd Socket Mode client
* https://api.slack.com/apis/connections/socket
* https://slack.dev/python-slack-sdk/socket-mode/
* https://pypi.org/project/websockets/
"""
import asyncio
import logging
from asyncio import Future, Lock
from logging import Logger
from asyncio import Queue
from typing import Union, Optional, List, Callable, Awaitable
import websockets
from websockets.client import WebSocketClientProtocol
from slack_sdk.socket_mode.async_client import AsyncBaseSocketModeClient
from slack_sdk.socket_mode.async_listeners import (
AsyncWebSocketMessageListener,
AsyncSocketModeRequestListener,
)
from slack_sdk.socket_mode.request import SocketModeRequest
from slack_sdk.web.async_client import AsyncWebClient
class SocketModeClient(AsyncBaseSocketModeClient):
logger: Logger
web_client: AsyncWebClient
app_token: str
wss_uri: Optional[str]
auto_reconnect_enabled: bool
message_queue: Queue
message_listeners: List[
Union[
AsyncWebSocketMessageListener,
Callable[
["AsyncBaseSocketModeClient", dict, Optional[str]], Awaitable[None]
],
]
]
socket_mode_request_listeners: List[
Union[
AsyncSocketModeRequestListener,
Callable[["AsyncBaseSocketModeClient", SocketModeRequest], Awaitable[None]],
]
]
message_receiver: Optional[Future]
message_processor: Future
ping_interval: float
current_session: Optional[WebSocketClientProtocol]
current_session_monitor: Optional[Future]
auto_reconnect_enabled: bool
default_auto_reconnect_enabled: bool
closed: bool
connect_operation_lock: Lock
def __init__(
self,
app_token: str,
logger: Optional[Logger] = None,
web_client: Optional[AsyncWebClient] = None,
auto_reconnect_enabled: bool = True,
ping_interval: float = 10,
):
"""Socket Mode client
Args:
app_token: App-level token
logger: Custom logger
web_client: Web API client
auto_reconnect_enabled: True if automatic reconnection is enabled (default: True)
ping_interval: interval for ping-pong with Slack servers (seconds)
"""
self.app_token = app_token
self.logger = logger or logging.getLogger(__name__)
self.web_client = web_client or AsyncWebClient()
self.closed = False
self.connect_operation_lock = Lock()
self.default_auto_reconnect_enabled = auto_reconnect_enabled
self.auto_reconnect_enabled = self.default_auto_reconnect_enabled
self.ping_interval = ping_interval
self.wss_uri = None
self.message_queue = Queue()
self.message_listeners = []
self.socket_mode_request_listeners = []
self.current_session = None
self.current_session_monitor = None
self.message_receiver = None
self.message_processor = asyncio.ensure_future(self.process_messages())
async def monitor_current_session(self) -> None:
while not self.closed:
await asyncio.sleep(self.ping_interval)
try:
if self.auto_reconnect_enabled and (
self.current_session is None or self.current_session.closed
):
self.logger.info(
"The session seems to be already closed. Going to reconnect..."
)
await self.connect_to_new_endpoint()
except Exception as e:
self.logger.error(
"Failed to check the current session or reconnect to the server "
f"(error: {type(e).__name__}, message: {e})"
)
async def receive_messages(self) -> None:
consecutive_error_count = 0
while not self.closed:
try:
message = await self.current_session.recv()
if message is not None:
if isinstance(message, bytes):
message = message.decode("utf-8")
if self.logger.level <= logging.DEBUG:
self.logger.debug(f"Received message: {message}")
await self.enqueue_message(message)
consecutive_error_count = 0
except Exception as e:
consecutive_error_count += 1
self.logger.error(
f"Failed to receive or enqueue a message: {type(e).__name__}, {e}"
)
if isinstance(e, websockets.ConnectionClosedError):
await asyncio.sleep(self.ping_interval)
else:
await asyncio.sleep(consecutive_error_count)
async def is_connected(self) -> bool:
return (
not self.closed
and self.current_session is not None
and not self.current_session.closed
)
async def connect(self):
if self.wss_uri is None:
self.wss_uri = await self.issue_new_wss_url()
old_session: Optional[WebSocketClientProtocol] = (
None if self.current_session is None else self.current_session
)
# NOTE: websockets does not support proxy settings
self.current_session = await websockets.connect(
uri=self.wss_uri,
ping_interval=self.ping_interval,
)
self.auto_reconnect_enabled = self.default_auto_reconnect_enabled
self.logger.info("A new session has been established")
if self.current_session_monitor is None:
self.current_session_monitor = asyncio.ensure_future(
self.monitor_current_session()
)
if self.message_receiver is None:
self.message_receiver = asyncio.ensure_future(self.receive_messages())
if old_session is not None:
await old_session.close()
self.logger.info("The old session has been abandoned")
async def disconnect(self):
if self.current_session is not None:
await self.current_session.close()
async def send_message(self, message: str):
if self.logger.level <= logging.DEBUG:
self.logger.debug(f"Sending a message: {message}")
await self.current_session.send(message)
async def close(self):
self.closed = True
self.auto_reconnect_enabled = False
await self.disconnect()
self.message_processor.cancel()
if self.current_session_monitor is not None:
self.current_session_monitor.cancel()
if self.message_receiver is not None:
self.message_receiver.cancel()
Classes
class SocketModeClient (app_token: str, logger: Optional[logging.Logger] = None, web_client: Optional[AsyncWebClient] = None, auto_reconnect_enabled: bool = True, ping_interval: float = 10)
-
Socket Mode client
Args
app_token
- App-level token
logger
- Custom logger
web_client
- Web API client
auto_reconnect_enabled
- True if automatic reconnection is enabled (default: True)
ping_interval
- interval for ping-pong with Slack servers (seconds)
Expand source code
class SocketModeClient(AsyncBaseSocketModeClient): logger: Logger web_client: AsyncWebClient app_token: str wss_uri: Optional[str] auto_reconnect_enabled: bool message_queue: Queue message_listeners: List[ Union[ AsyncWebSocketMessageListener, Callable[ ["AsyncBaseSocketModeClient", dict, Optional[str]], Awaitable[None] ], ] ] socket_mode_request_listeners: List[ Union[ AsyncSocketModeRequestListener, Callable[["AsyncBaseSocketModeClient", SocketModeRequest], Awaitable[None]], ] ] message_receiver: Optional[Future] message_processor: Future ping_interval: float current_session: Optional[WebSocketClientProtocol] current_session_monitor: Optional[Future] auto_reconnect_enabled: bool default_auto_reconnect_enabled: bool closed: bool connect_operation_lock: Lock def __init__( self, app_token: str, logger: Optional[Logger] = None, web_client: Optional[AsyncWebClient] = None, auto_reconnect_enabled: bool = True, ping_interval: float = 10, ): """Socket Mode client Args: app_token: App-level token logger: Custom logger web_client: Web API client auto_reconnect_enabled: True if automatic reconnection is enabled (default: True) ping_interval: interval for ping-pong with Slack servers (seconds) """ self.app_token = app_token self.logger = logger or logging.getLogger(__name__) self.web_client = web_client or AsyncWebClient() self.closed = False self.connect_operation_lock = Lock() self.default_auto_reconnect_enabled = auto_reconnect_enabled self.auto_reconnect_enabled = self.default_auto_reconnect_enabled self.ping_interval = ping_interval self.wss_uri = None self.message_queue = Queue() self.message_listeners = [] self.socket_mode_request_listeners = [] self.current_session = None self.current_session_monitor = None self.message_receiver = None self.message_processor = asyncio.ensure_future(self.process_messages()) async def monitor_current_session(self) -> None: while not self.closed: await asyncio.sleep(self.ping_interval) try: if self.auto_reconnect_enabled and ( self.current_session is None or self.current_session.closed ): self.logger.info( "The session seems to be already closed. Going to reconnect..." ) await self.connect_to_new_endpoint() except Exception as e: self.logger.error( "Failed to check the current session or reconnect to the server " f"(error: {type(e).__name__}, message: {e})" ) async def receive_messages(self) -> None: consecutive_error_count = 0 while not self.closed: try: message = await self.current_session.recv() if message is not None: if isinstance(message, bytes): message = message.decode("utf-8") if self.logger.level <= logging.DEBUG: self.logger.debug(f"Received message: {message}") await self.enqueue_message(message) consecutive_error_count = 0 except Exception as e: consecutive_error_count += 1 self.logger.error( f"Failed to receive or enqueue a message: {type(e).__name__}, {e}" ) if isinstance(e, websockets.ConnectionClosedError): await asyncio.sleep(self.ping_interval) else: await asyncio.sleep(consecutive_error_count) async def is_connected(self) -> bool: return ( not self.closed and self.current_session is not None and not self.current_session.closed ) async def connect(self): if self.wss_uri is None: self.wss_uri = await self.issue_new_wss_url() old_session: Optional[WebSocketClientProtocol] = ( None if self.current_session is None else self.current_session ) # NOTE: websockets does not support proxy settings self.current_session = await websockets.connect( uri=self.wss_uri, ping_interval=self.ping_interval, ) self.auto_reconnect_enabled = self.default_auto_reconnect_enabled self.logger.info("A new session has been established") if self.current_session_monitor is None: self.current_session_monitor = asyncio.ensure_future( self.monitor_current_session() ) if self.message_receiver is None: self.message_receiver = asyncio.ensure_future(self.receive_messages()) if old_session is not None: await old_session.close() self.logger.info("The old session has been abandoned") async def disconnect(self): if self.current_session is not None: await self.current_session.close() async def send_message(self, message: str): if self.logger.level <= logging.DEBUG: self.logger.debug(f"Sending a message: {message}") await self.current_session.send(message) async def close(self): self.closed = True self.auto_reconnect_enabled = False await self.disconnect() self.message_processor.cancel() if self.current_session_monitor is not None: self.current_session_monitor.cancel() if self.message_receiver is not None: self.message_receiver.cancel()
Ancestors
Class variables
var app_token : str
var auto_reconnect_enabled : bool
var closed : bool
var connect_operation_lock : asyncio.locks.Lock
var current_session : Optional[websockets.legacy.client.WebSocketClientProtocol]
var current_session_monitor : Optional[_asyncio.Future]
var default_auto_reconnect_enabled : bool
var logger : logging.Logger
var message_listeners : List[Union[AsyncWebSocketMessageListener, Callable[[AsyncBaseSocketModeClient, dict, Optional[str]], Awaitable[NoneType]]]]
var message_processor : _asyncio.Future
var message_queue : asyncio.queues.Queue
var message_receiver : Optional[_asyncio.Future]
var ping_interval : float
var socket_mode_request_listeners : List[Union[AsyncSocketModeRequestListener, Callable[[AsyncBaseSocketModeClient, SocketModeRequest], Awaitable[NoneType]]]]
var web_client : AsyncWebClient
var wss_uri : Optional[str]
Methods
async def close(self)
-
Expand source code
async def close(self): self.closed = True self.auto_reconnect_enabled = False await self.disconnect() self.message_processor.cancel() if self.current_session_monitor is not None: self.current_session_monitor.cancel() if self.message_receiver is not None: self.message_receiver.cancel()
async def connect(self)
-
Expand source code
async def connect(self): if self.wss_uri is None: self.wss_uri = await self.issue_new_wss_url() old_session: Optional[WebSocketClientProtocol] = ( None if self.current_session is None else self.current_session ) # NOTE: websockets does not support proxy settings self.current_session = await websockets.connect( uri=self.wss_uri, ping_interval=self.ping_interval, ) self.auto_reconnect_enabled = self.default_auto_reconnect_enabled self.logger.info("A new session has been established") if self.current_session_monitor is None: self.current_session_monitor = asyncio.ensure_future( self.monitor_current_session() ) if self.message_receiver is None: self.message_receiver = asyncio.ensure_future(self.receive_messages()) if old_session is not None: await old_session.close() self.logger.info("The old session has been abandoned")
async def disconnect(self)
-
Expand source code
async def disconnect(self): if self.current_session is not None: await self.current_session.close()
async def is_connected(self) ‑> bool
-
Expand source code
async def is_connected(self) -> bool: return ( not self.closed and self.current_session is not None and not self.current_session.closed )
async def monitor_current_session(self) ‑> NoneType
-
Expand source code
async def monitor_current_session(self) -> None: while not self.closed: await asyncio.sleep(self.ping_interval) try: if self.auto_reconnect_enabled and ( self.current_session is None or self.current_session.closed ): self.logger.info( "The session seems to be already closed. Going to reconnect..." ) await self.connect_to_new_endpoint() except Exception as e: self.logger.error( "Failed to check the current session or reconnect to the server " f"(error: {type(e).__name__}, message: {e})" )
async def receive_messages(self) ‑> NoneType
-
Expand source code
async def receive_messages(self) -> None: consecutive_error_count = 0 while not self.closed: try: message = await self.current_session.recv() if message is not None: if isinstance(message, bytes): message = message.decode("utf-8") if self.logger.level <= logging.DEBUG: self.logger.debug(f"Received message: {message}") await self.enqueue_message(message) consecutive_error_count = 0 except Exception as e: consecutive_error_count += 1 self.logger.error( f"Failed to receive or enqueue a message: {type(e).__name__}, {e}" ) if isinstance(e, websockets.ConnectionClosedError): await asyncio.sleep(self.ping_interval) else: await asyncio.sleep(consecutive_error_count)
async def send_message(self, message: str)
-
Expand source code
async def send_message(self, message: str): if self.logger.level <= logging.DEBUG: self.logger.debug(f"Sending a message: {message}") await self.current_session.send(message)