diff --git a/docs/reference/audit_logs/async_client.html b/docs/reference/audit_logs/async_client.html index a6761dd56..fe97d686f 100644 --- a/docs/reference/audit_logs/async_client.html +++ b/docs/reference/audit_logs/async_client.html @@ -365,7 +365,7 @@

Classes

): if self.logger.level <= logging.DEBUG: self.logger.info( - f"A retry handler found: {type(handler).__name__} " f"for {http_verb} {url} - {e}" + f"A retry handler found: {type(handler).__name__} for {http_verb} {url} - {e}" ) await handler.prepare_for_next_attempt_async( state=retry_state, diff --git a/docs/reference/audit_logs/v1/async_client.html b/docs/reference/audit_logs/v1/async_client.html index 699a6c38d..c5a05eb63 100644 --- a/docs/reference/audit_logs/v1/async_client.html +++ b/docs/reference/audit_logs/v1/async_client.html @@ -367,7 +367,7 @@

Classes

): if self.logger.level <= logging.DEBUG: self.logger.info( - f"A retry handler found: {type(handler).__name__} " f"for {http_verb} {url} - {e}" + f"A retry handler found: {type(handler).__name__} for {http_verb} {url} - {e}" ) await handler.prepare_for_next_attempt_async( state=retry_state, diff --git a/docs/reference/models/basic_objects.html b/docs/reference/models/basic_objects.html index 6c6c3b670..9095f5630 100644 --- a/docs/reference/models/basic_objects.html +++ b/docs/reference/models/basic_objects.html @@ -78,7 +78,7 @@

Subclasses

class EnumValidator(JsonValidator):
     def __init__(self, attribute: str, enum: Iterable[str]):
-        super().__init__(f"{attribute} attribute must be one of the following values: " f"{', '.join(enum)}")
+ super().__init__(f"{attribute} attribute must be one of the following values: {', '.join(enum)}")

Decorate a method on a class to mark it as a JSON validator. Validation functions should return true if valid, false if not.

diff --git a/docs/reference/models/blocks/block_elements.html b/docs/reference/models/blocks/block_elements.html index 2688ba7e4..794a61670 100644 --- a/docs/reference/models/blocks/block_elements.html +++ b/docs/reference/models/blocks/block_elements.html @@ -2832,7 +2832,7 @@

Inherited members

self.options = options self.confirm = ConfirmObject.parse(confirm) # type: ignore[arg-type] - @JsonValidator(f"options attribute must have between {options_min_length} " f"and {options_max_length} items") + @JsonValidator(f"options attribute must have between {options_min_length} and {options_max_length} items") def _validate_options_length(self) -> bool: return self.options_min_length <= len(self.options) <= self.options_max_length diff --git a/docs/reference/models/blocks/index.html b/docs/reference/models/blocks/index.html index d6cae1dbc..b9f0e76d8 100644 --- a/docs/reference/models/blocks/index.html +++ b/docs/reference/models/blocks/index.html @@ -5414,7 +5414,7 @@

Inherited members

self.options = options self.confirm = ConfirmObject.parse(confirm) # type: ignore[arg-type] - @JsonValidator(f"options attribute must have between {options_min_length} " f"and {options_max_length} items") + @JsonValidator(f"options attribute must have between {options_min_length} and {options_max_length} items") def _validate_options_length(self) -> bool: return self.options_min_length <= len(self.options) <= self.options_max_length diff --git a/docs/reference/models/index.html b/docs/reference/models/index.html index dd6a05957..6fa4aeb15 100644 --- a/docs/reference/models/index.html +++ b/docs/reference/models/index.html @@ -183,7 +183,7 @@

Subclasses

class EnumValidator(JsonValidator):
     def __init__(self, attribute: str, enum: Iterable[str]):
-        super().__init__(f"{attribute} attribute must be one of the following values: " f"{', '.join(enum)}")
+ super().__init__(f"{attribute} attribute must be one of the following values: {', '.join(enum)}")

Decorate a method on a class to mark it as a JSON validator. Validation functions should return true if valid, false if not.

diff --git a/docs/reference/oauth/authorize_url_generator/index.html b/docs/reference/oauth/authorize_url_generator/index.html index 97e893156..2ae69e328 100644 --- a/docs/reference/oauth/authorize_url_generator/index.html +++ b/docs/reference/oauth/authorize_url_generator/index.html @@ -74,13 +74,7 @@

Classes

def generate(self, state: str, team: Optional[str] = None) -> str: scopes = ",".join(self.scopes) if self.scopes else "" user_scopes = ",".join(self.user_scopes) if self.user_scopes else "" - url = ( - f"{self.authorization_url}?" - f"state={state}&" - f"client_id={self.client_id}&" - f"scope={scopes}&" - f"user_scope={user_scopes}" - ) + url = f"{self.authorization_url}?state={state}&client_id={self.client_id}&scope={scopes}&user_scope={user_scopes}" if self.redirect_uri is not None: url += f"&redirect_uri={self.redirect_uri}" if team is not None: @@ -101,13 +95,7 @@

Methods

def generate(self, state: str, team: Optional[str] = None) -> str:
     scopes = ",".join(self.scopes) if self.scopes else ""
     user_scopes = ",".join(self.user_scopes) if self.user_scopes else ""
-    url = (
-        f"{self.authorization_url}?"
-        f"state={state}&"
-        f"client_id={self.client_id}&"
-        f"scope={scopes}&"
-        f"user_scope={user_scopes}"
-    )
+    url = f"{self.authorization_url}?state={state}&client_id={self.client_id}&scope={scopes}&user_scope={user_scopes}"
     if self.redirect_uri is not None:
         url += f"&redirect_uri={self.redirect_uri}"
     if team is not None:
diff --git a/docs/reference/oauth/index.html b/docs/reference/oauth/index.html
index 59efdf88c..7f3fe642c 100644
--- a/docs/reference/oauth/index.html
+++ b/docs/reference/oauth/index.html
@@ -107,13 +107,7 @@ 

Classes

def generate(self, state: str, team: Optional[str] = None) -> str: scopes = ",".join(self.scopes) if self.scopes else "" user_scopes = ",".join(self.user_scopes) if self.user_scopes else "" - url = ( - f"{self.authorization_url}?" - f"state={state}&" - f"client_id={self.client_id}&" - f"scope={scopes}&" - f"user_scope={user_scopes}" - ) + url = f"{self.authorization_url}?state={state}&client_id={self.client_id}&scope={scopes}&user_scope={user_scopes}" if self.redirect_uri is not None: url += f"&redirect_uri={self.redirect_uri}" if team is not None: @@ -134,13 +128,7 @@

Methods

def generate(self, state: str, team: Optional[str] = None) -> str:
     scopes = ",".join(self.scopes) if self.scopes else ""
     user_scopes = ",".join(self.user_scopes) if self.user_scopes else ""
-    url = (
-        f"{self.authorization_url}?"
-        f"state={state}&"
-        f"client_id={self.client_id}&"
-        f"scope={scopes}&"
-        f"user_scope={user_scopes}"
-    )
+    url = f"{self.authorization_url}?state={state}&client_id={self.client_id}&scope={scopes}&user_scope={user_scopes}"
     if self.redirect_uri is not None:
         url += f"&redirect_uri={self.redirect_uri}"
     if team is not None:
@@ -521,10 +509,10 @@ 

Methods

self.expiration_seconds = expiration_seconds def build_set_cookie_for_new_state(self, state: str) -> str: - return f"{self.cookie_name}={state}; " "Secure; " "HttpOnly; " "Path=/; " f"Max-Age={self.expiration_seconds}" + return f"{self.cookie_name}={state}; Secure; HttpOnly; Path=/; Max-Age={self.expiration_seconds}" def build_set_cookie_for_deletion(self) -> str: - return f"{self.cookie_name}=deleted; " "Secure; " "HttpOnly; " "Path=/; " "Expires=Thu, 01 Jan 1970 00:00:00 GMT" + return f"{self.cookie_name}=deleted; Secure; HttpOnly; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT" def is_valid_browser( self, @@ -575,7 +563,7 @@

Methods

Expand source code
def build_set_cookie_for_deletion(self) -> str:
-    return f"{self.cookie_name}=deleted; " "Secure; " "HttpOnly; " "Path=/; " "Expires=Thu, 01 Jan 1970 00:00:00 GMT"
+ return f"{self.cookie_name}=deleted; Secure; HttpOnly; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT"
@@ -588,7 +576,7 @@

Methods

Expand source code
def build_set_cookie_for_new_state(self, state: str) -> str:
-    return f"{self.cookie_name}={state}; " "Secure; " "HttpOnly; " "Path=/; " f"Max-Age={self.expiration_seconds}"
+ return f"{self.cookie_name}={state}; Secure; HttpOnly; Path=/; Max-Age={self.expiration_seconds}"
diff --git a/docs/reference/oauth/state_utils/index.html b/docs/reference/oauth/state_utils/index.html index d732babfd..0cd58393f 100644 --- a/docs/reference/oauth/state_utils/index.html +++ b/docs/reference/oauth/state_utils/index.html @@ -72,10 +72,10 @@

Classes

self.expiration_seconds = expiration_seconds def build_set_cookie_for_new_state(self, state: str) -> str: - return f"{self.cookie_name}={state}; " "Secure; " "HttpOnly; " "Path=/; " f"Max-Age={self.expiration_seconds}" + return f"{self.cookie_name}={state}; Secure; HttpOnly; Path=/; Max-Age={self.expiration_seconds}" def build_set_cookie_for_deletion(self) -> str: - return f"{self.cookie_name}=deleted; " "Secure; " "HttpOnly; " "Path=/; " "Expires=Thu, 01 Jan 1970 00:00:00 GMT" + return f"{self.cookie_name}=deleted; Secure; HttpOnly; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT" def is_valid_browser( self, @@ -126,7 +126,7 @@

Methods

Expand source code
def build_set_cookie_for_deletion(self) -> str:
-    return f"{self.cookie_name}=deleted; " "Secure; " "HttpOnly; " "Path=/; " "Expires=Thu, 01 Jan 1970 00:00:00 GMT"
+ return f"{self.cookie_name}=deleted; Secure; HttpOnly; Path=/; Expires=Thu, 01 Jan 1970 00:00:00 GMT"
@@ -139,7 +139,7 @@

Methods

Expand source code
def build_set_cookie_for_new_state(self, state: str) -> str:
-    return f"{self.cookie_name}={state}; " "Secure; " "HttpOnly; " "Path=/; " f"Max-Age={self.expiration_seconds}"
+ return f"{self.cookie_name}={state}; Secure; HttpOnly; Path=/; Max-Age={self.expiration_seconds}"
diff --git a/docs/reference/rtm/v2/index.html b/docs/reference/rtm/v2/index.html index 5f6267c25..c55488f77 100644 --- a/docs/reference/rtm/v2/index.html +++ b/docs/reference/rtm/v2/index.html @@ -385,7 +385,7 @@

Classes

def run_all_error_listeners(self, error: Exception): self.logger.exception( - f"on_error invoked (session id: {self.session_id()}, " f"error: {type(error).__name__}, message: {error})" + f"on_error invoked (session id: {self.session_id()}, error: {type(error).__name__}, message: {error})" ) for listener in self.on_error_listeners: listener(error) @@ -394,7 +394,7 @@

Classes

if self.logger.level <= logging.DEBUG: self.logger.debug(f"on_close invoked (session id: {self.session_id()})") if self.auto_reconnect_enabled: - self.logger.info("Received CLOSE event. Going to reconnect... " f"(session id: {self.session_id()})") + self.logger.info(f"Received CLOSE event. Going to reconnect... (session id: {self.session_id()})") self.connect_to_new_endpoint() for listener in self.on_close_listeners: listener(code, reason) @@ -403,14 +403,12 @@

Classes

if self.current_session is not None and self.current_session.is_active(): session_id = self.session_id() try: - self.logger.info("Starting to receive messages from a new connection" f" (session id: {session_id})") + self.logger.info(f"Starting to receive messages from a new connection (session id: {session_id})") self.current_session_state.terminated = False self.current_session.run_until_completion(self.current_session_state) - self.logger.info("Stopped receiving messages from a connection" f" (session id: {session_id})") + self.logger.info(f"Stopped receiving messages from a connection (session id: {session_id})") except Exception as e: - self.logger.exception( - "Failed to start or stop the current session" f" (session id: {session_id}, error: {e})" - ) + self.logger.exception(f"Failed to start or stop the current session (session id: {session_id}, error: {e})") def _monitor_current_session(self): if self.current_app_monitor_started: @@ -419,7 +417,7 @@

Classes

if self.auto_reconnect_enabled and (self.current_session is None or not self.current_session.is_active()): self.logger.info( - "The session seems to be already closed. Going to reconnect... " f"(session id: {self.session_id()})" + f"The session seems to be already closed. Going to reconnect... (session id: {self.session_id()})" ) self.connect_to_new_endpoint() except Exception as e: @@ -800,7 +798,7 @@

Methods

if self.logger.level <= logging.DEBUG: self.logger.debug(f"on_close invoked (session id: {self.session_id()})") if self.auto_reconnect_enabled: - self.logger.info("Received CLOSE event. Going to reconnect... " f"(session id: {self.session_id()})") + self.logger.info(f"Received CLOSE event. Going to reconnect... (session id: {self.session_id()})") self.connect_to_new_endpoint() for listener in self.on_close_listeners: listener(code, reason) @@ -817,7 +815,7 @@

Methods

def run_all_error_listeners(self, error: Exception):
     self.logger.exception(
-        f"on_error invoked (session id: {self.session_id()}, " f"error: {type(error).__name__}, message: {error})"
+        f"on_error invoked (session id: {self.session_id()}, error: {type(error).__name__}, message: {error})"
     )
     for listener in self.on_error_listeners:
         listener(error)
diff --git a/docs/reference/rtm_v2/index.html b/docs/reference/rtm_v2/index.html index 70d19d5c0..44b6533c3 100644 --- a/docs/reference/rtm_v2/index.html +++ b/docs/reference/rtm_v2/index.html @@ -386,7 +386,7 @@

Classes

def run_all_error_listeners(self, error: Exception): self.logger.exception( - f"on_error invoked (session id: {self.session_id()}, " f"error: {type(error).__name__}, message: {error})" + f"on_error invoked (session id: {self.session_id()}, error: {type(error).__name__}, message: {error})" ) for listener in self.on_error_listeners: listener(error) @@ -395,7 +395,7 @@

Classes

if self.logger.level <= logging.DEBUG: self.logger.debug(f"on_close invoked (session id: {self.session_id()})") if self.auto_reconnect_enabled: - self.logger.info("Received CLOSE event. Going to reconnect... " f"(session id: {self.session_id()})") + self.logger.info(f"Received CLOSE event. Going to reconnect... (session id: {self.session_id()})") self.connect_to_new_endpoint() for listener in self.on_close_listeners: listener(code, reason) @@ -404,14 +404,12 @@

Classes

if self.current_session is not None and self.current_session.is_active(): session_id = self.session_id() try: - self.logger.info("Starting to receive messages from a new connection" f" (session id: {session_id})") + self.logger.info(f"Starting to receive messages from a new connection (session id: {session_id})") self.current_session_state.terminated = False self.current_session.run_until_completion(self.current_session_state) - self.logger.info("Stopped receiving messages from a connection" f" (session id: {session_id})") + self.logger.info(f"Stopped receiving messages from a connection (session id: {session_id})") except Exception as e: - self.logger.exception( - "Failed to start or stop the current session" f" (session id: {session_id}, error: {e})" - ) + self.logger.exception(f"Failed to start or stop the current session (session id: {session_id}, error: {e})") def _monitor_current_session(self): if self.current_app_monitor_started: @@ -420,7 +418,7 @@

Classes

if self.auto_reconnect_enabled and (self.current_session is None or not self.current_session.is_active()): self.logger.info( - "The session seems to be already closed. Going to reconnect... " f"(session id: {self.session_id()})" + f"The session seems to be already closed. Going to reconnect... (session id: {self.session_id()})" ) self.connect_to_new_endpoint() except Exception as e: @@ -801,7 +799,7 @@

Methods

if self.logger.level <= logging.DEBUG: self.logger.debug(f"on_close invoked (session id: {self.session_id()})") if self.auto_reconnect_enabled: - self.logger.info("Received CLOSE event. Going to reconnect... " f"(session id: {self.session_id()})") + self.logger.info(f"Received CLOSE event. Going to reconnect... (session id: {self.session_id()})") self.connect_to_new_endpoint() for listener in self.on_close_listeners: listener(code, reason) @@ -818,7 +816,7 @@

Methods

def run_all_error_listeners(self, error: Exception):
     self.logger.exception(
-        f"on_error invoked (session id: {self.session_id()}, " f"error: {type(error).__name__}, message: {error})"
+        f"on_error invoked (session id: {self.session_id()}, error: {type(error).__name__}, message: {error})"
     )
     for listener in self.on_error_listeners:
         listener(error)
diff --git a/docs/reference/scim/async_client.html b/docs/reference/scim/async_client.html index db7fc9f35..35cdc5583 100644 --- a/docs/reference/scim/async_client.html +++ b/docs/reference/scim/async_client.html @@ -394,7 +394,7 @@

Classes

): if self.logger.level <= logging.DEBUG: self.logger.info( - f"A retry handler found: {type(handler).__name__} " f"for {http_verb} {url} - {e}" + f"A retry handler found: {type(handler).__name__} for {http_verb} {url} - {e}" ) await handler.prepare_for_next_attempt_async( state=retry_state, diff --git a/docs/reference/scim/v1/async_client.html b/docs/reference/scim/v1/async_client.html index 261e93444..8c11d1cb6 100644 --- a/docs/reference/scim/v1/async_client.html +++ b/docs/reference/scim/v1/async_client.html @@ -394,7 +394,7 @@

Classes

): if self.logger.level <= logging.DEBUG: self.logger.info( - f"A retry handler found: {type(handler).__name__} " f"for {http_verb} {url} - {e}" + f"A retry handler found: {type(handler).__name__} for {http_verb} {url} - {e}" ) await handler.prepare_for_next_attempt_async( state=retry_state, diff --git a/docs/reference/socket_mode/aiohttp/index.html b/docs/reference/socket_mode/aiohttp/index.html index 1c987d9b2..05a1ebb97 100644 --- a/docs/reference/socket_mode/aiohttp/index.html +++ b/docs/reference/socket_mode/aiohttp/index.html @@ -382,7 +382,7 @@

Classes

# a new monitor and a new message receiver are also created. # If a new session is created but we failed to create the new # monitor or the new message, we should try it. - while True: + while not self.closed: try: old_session: Optional[ClientWebSocketResponse] = ( None if self.current_session is None else self.current_session @@ -438,6 +438,10 @@

Classes

self.logger.debug(f"A new receive_messages() executor has been recreated for {session_id}") break except Exception as e: + if self.closed: + if self.logger.level <= logging.DEBUG: + self.logger.debug(f"Stopped connecting because the client is closed (error: {e})") + return self.logger.exception(f"Failed to connect (error: {e}); Retrying...") await asyncio.sleep(self.ping_interval) @@ -468,9 +472,7 @@

Classes

if await self.is_connected(): await self.current_session.send_str(message) # type: ignore[union-attr] else: - self.logger.warning( - f"The current session ({session_id}) is no longer active. " "Failed to send a message" - ) + self.logger.warning(f"The current session ({session_id}) is no longer active. Failed to send a message") raise e finally: if self.connect_operation_lock.locked() is True: @@ -624,7 +626,7 @@

Methods

# a new monitor and a new message receiver are also created. # If a new session is created but we failed to create the new # monitor or the new message, we should try it. - while True: + while not self.closed: try: old_session: Optional[ClientWebSocketResponse] = ( None if self.current_session is None else self.current_session @@ -680,6 +682,10 @@

Methods

self.logger.debug(f"A new receive_messages() executor has been recreated for {session_id}") break except Exception as e: + if self.closed: + if self.logger.level <= logging.DEBUG: + self.logger.debug(f"Stopped connecting because the client is closed (error: {e})") + return self.logger.exception(f"Failed to connect (error: {e}); Retrying...") await asyncio.sleep(self.ping_interval) @@ -975,9 +981,7 @@

Methods

if await self.is_connected(): await self.current_session.send_str(message) # type: ignore[union-attr] else: - self.logger.warning( - f"The current session ({session_id}) is no longer active. " "Failed to send a message" - ) + self.logger.warning(f"The current session ({session_id}) is no longer active. Failed to send a message") raise e finally: if self.connect_operation_lock.locked() is True: diff --git a/docs/reference/socket_mode/async_client.html b/docs/reference/socket_mode/async_client.html index 2dba67f84..e8f70035d 100644 --- a/docs/reference/socket_mode/async_client.html +++ b/docs/reference/socket_mode/async_client.html @@ -206,10 +206,7 @@

Classes

finally: if self.logger.level <= logging.DEBUG: self.logger.debug( - f"Message processing completed (" - f"type: {type}, " - f"envelope_id: {envelope_id}, " - f"session: {session_id})" + f"Message processing completed (type: {type}, envelope_id: {envelope_id}, session: {session_id})" )
@@ -481,10 +478,7 @@

Methods

finally: if self.logger.level <= logging.DEBUG: self.logger.debug( - f"Message processing completed (" - f"type: {type}, " - f"envelope_id: {envelope_id}, " - f"session: {session_id})" + f"Message processing completed (type: {type}, envelope_id: {envelope_id}, session: {session_id})" )
diff --git a/docs/reference/socket_mode/builtin/client.html b/docs/reference/socket_mode/builtin/client.html index 056668a16..c3cab72b4 100644 --- a/docs/reference/socket_mode/builtin/client.html +++ b/docs/reference/socket_mode/builtin/client.html @@ -274,7 +274,7 @@

Classes

def _on_error(self, error: Exception): error_message = ( - f"on_error invoked (session id: {self.session_id()}, " f"error: {type(error).__name__}, message: {error})" + f"on_error invoked (session id: {self.session_id()}, error: {type(error).__name__}, message: {error})" ) if self.trace_enabled: self.logger.exception(error_message) @@ -288,7 +288,7 @@

Classes

if self.logger.level <= logging.DEBUG: self.logger.debug(f"on_close invoked (session id: {self.session_id()})") if self.auto_reconnect_enabled: - self.logger.info("Received CLOSE event. Reconnecting... " f"(session id: {self.session_id()})") + self.logger.info(f"Received CLOSE event. Reconnecting... (session id: {self.session_id()})") self.connect_to_new_endpoint() for listener in self.on_close_listeners: listener(code, reason) @@ -297,12 +297,12 @@

Classes

if self.current_session is not None and self.current_session.is_active(): session_id = self.session_id() try: - self.logger.info("Starting to receive messages from a new connection" f" (session id: {session_id})") + self.logger.info(f"Starting to receive messages from a new connection (session id: {session_id})") self.current_session_state.terminated = False self.current_session.run_until_completion(self.current_session_state) - self.logger.info("Stopped receiving messages from a connection" f" (session id: {session_id})") + self.logger.info(f"Stopped receiving messages from a connection (session id: {session_id})") except Exception as e: - error_message = "Failed to start or stop the current session" f" (session id: {session_id}, error: {e})" + error_message = f"Failed to start or stop the current session (session id: {session_id}, error: {e})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -315,7 +315,7 @@

Classes

if self.auto_reconnect_enabled and (self.current_session is None or not self.current_session.is_active()): self.logger.info( - "The session seems to be already closed. Reconnecting... " f"(session id: {self.session_id()})" + f"The session seems to be already closed. Reconnecting... (session id: {self.session_id()})" ) self.connect_to_new_endpoint() except Exception as e: diff --git a/docs/reference/socket_mode/builtin/connection.html b/docs/reference/socket_mode/builtin/connection.html index 5c85bef91..208e9a591 100644 --- a/docs/reference/socket_mode/builtin/connection.html +++ b/docs/reference/socket_mode/builtin/connection.html @@ -126,7 +126,7 @@

Classes

port: int = parsed_url.port or (443 if parsed_url.scheme == "wss" else 80) if self.trace_enabled: self.logger.debug( - f"Connecting to the address for handshake: {hostname}:{port} " f"(session id: {self.session_id})" + f"Connecting to the address for handshake: {hostname}:{port} (session id: {self.session_id})" ) sock: Union[ssl.SSLSocket, socket] = _establish_new_socket_connection( # type: ignore[valid-type] session_id=self.session_id, @@ -228,7 +228,7 @@

Classes

if self.trace_enabled and self.ping_pong_trace_enabled: if isinstance(payload, bytes): payload = payload.decode("utf-8") - self.logger.debug("Sending a ping data frame " f"(session id: {self.session_id}, payload: {payload})") + self.logger.debug(f"Sending a ping data frame (session id: {self.session_id}, payload: {payload})") data = _build_data_frame_for_sending(payload, FrameHeader.OPCODE_PING) with self.sock_send_lock: if self.sock is not None: @@ -241,7 +241,7 @@

Classes

if self.trace_enabled and self.ping_pong_trace_enabled: if isinstance(payload, bytes): payload = payload.decode("utf-8") - self.logger.debug("Sending a pong data frame " f"(session id: {self.session_id}, payload: {payload})") + self.logger.debug(f"Sending a pong data frame (session id: {self.session_id}, payload: {payload})") data = _build_data_frame_for_sending(payload, FrameHeader.OPCODE_PONG) with self.sock_send_lock: if self.sock is not None: @@ -254,7 +254,7 @@

Classes

if self.trace_enabled: if isinstance(payload, bytes): payload = payload.decode("utf-8") - self.logger.debug("Sending a text data frame " f"(session id: {self.session_id}, payload: {payload})") + self.logger.debug(f"Sending a text data frame (session id: {self.session_id}, payload: {payload})") data = _build_data_frame_for_sending(payload, FrameHeader.OPCODE_TEXT) with self.sock_send_lock: try: @@ -302,12 +302,11 @@

Classes

self.disconnect() return else: - self.logger.debug("This connection is already closed." f" (session id: {self.session_id})") + self.logger.debug(f"This connection is already closed. (session id: {self.session_id})") self.consecutive_check_state_error_count = 0 except Exception as e: error_message = ( - "Failed to check the state of sock " - f"(session id: {self.session_id}, error: {type(e).__name__}, message: {e})" + f"Failed to check the state of sock (session id: {self.session_id}, error: {type(e).__name__}, message: {e})" ) if self.trace_enabled: self.logger.exception(error_message) @@ -399,7 +398,7 @@

Classes

self.last_ping_pong_time = float(ping_time) except Exception as e: self.logger.debug( - "Failed to parse a pong message " f" (message: {str_message}, error: {e}" + f"Failed to parse a pong message (message: {str_message}, error: {e}" ) elif header.opcode == FrameHeader.OPCODE_TEXT: if self.on_message_listener is not None: @@ -437,13 +436,13 @@

Classes

# getting errno.EBADF and the socket is no longer available if e.errno == 9 and state.terminated: self.logger.debug( - "The reason why you got [Errno 9] Bad file descriptor here is " "the socket is no longer available." + "The reason why you got [Errno 9] Bad file descriptor here is the socket is no longer available." ) else: if self.on_error_listener is not None: self.on_error_listener(e) else: - error_message = "Got an OSError while receiving data" f" (session id: {self.session_id}, error: {e})" + error_message = f"Got an OSError while receiving data (session id: {self.session_id}, error: {e})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -454,9 +453,7 @@

Classes

try: self.disconnect() except Exception as disconnection_error: - error_message = ( - "Failed to disconnect" f" (session id: {self.session_id}, error: {disconnection_error})" - ) + error_message = f"Failed to disconnect (session id: {self.session_id}, error: {disconnection_error})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -467,7 +464,7 @@

Classes

if self.on_error_listener is not None: self.on_error_listener(e) else: - error_message = "Got an exception while receiving data" f" (session id: {self.session_id}, error: {e})" + error_message = f"Got an exception while receiving data (session id: {self.session_id}, error: {e})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -570,12 +567,11 @@

Methods

self.disconnect() return else: - self.logger.debug("This connection is already closed." f" (session id: {self.session_id})") + self.logger.debug(f"This connection is already closed. (session id: {self.session_id})") self.consecutive_check_state_error_count = 0 except Exception as e: error_message = ( - "Failed to check the state of sock " - f"(session id: {self.session_id}, error: {type(e).__name__}, message: {e})" + f"Failed to check the state of sock (session id: {self.session_id}, error: {type(e).__name__}, message: {e})" ) if self.trace_enabled: self.logger.exception(error_message) @@ -616,7 +612,7 @@

Methods

port: int = parsed_url.port or (443 if parsed_url.scheme == "wss" else 80) if self.trace_enabled: self.logger.debug( - f"Connecting to the address for handshake: {hostname}:{port} " f"(session id: {self.session_id})" + f"Connecting to the address for handshake: {hostname}:{port} (session id: {self.session_id})" ) sock: Union[ssl.SSLSocket, socket] = _establish_new_socket_connection( # type: ignore[valid-type] session_id=self.session_id, @@ -745,7 +741,7 @@

Methods

if self.trace_enabled and self.ping_pong_trace_enabled: if isinstance(payload, bytes): payload = payload.decode("utf-8") - self.logger.debug("Sending a ping data frame " f"(session id: {self.session_id}, payload: {payload})") + self.logger.debug(f"Sending a ping data frame (session id: {self.session_id}, payload: {payload})") data = _build_data_frame_for_sending(payload, FrameHeader.OPCODE_PING) with self.sock_send_lock: if self.sock is not None: @@ -768,7 +764,7 @@

Methods

if self.trace_enabled and self.ping_pong_trace_enabled: if isinstance(payload, bytes): payload = payload.decode("utf-8") - self.logger.debug("Sending a pong data frame " f"(session id: {self.session_id}, payload: {payload})") + self.logger.debug(f"Sending a pong data frame (session id: {self.session_id}, payload: {payload})") data = _build_data_frame_for_sending(payload, FrameHeader.OPCODE_PONG) with self.sock_send_lock: if self.sock is not None: @@ -868,7 +864,7 @@

Methods

self.last_ping_pong_time = float(ping_time) except Exception as e: self.logger.debug( - "Failed to parse a pong message " f" (message: {str_message}, error: {e}" + f"Failed to parse a pong message (message: {str_message}, error: {e}" ) elif header.opcode == FrameHeader.OPCODE_TEXT: if self.on_message_listener is not None: @@ -906,13 +902,13 @@

Methods

# getting errno.EBADF and the socket is no longer available if e.errno == 9 and state.terminated: self.logger.debug( - "The reason why you got [Errno 9] Bad file descriptor here is " "the socket is no longer available." + "The reason why you got [Errno 9] Bad file descriptor here is the socket is no longer available." ) else: if self.on_error_listener is not None: self.on_error_listener(e) else: - error_message = "Got an OSError while receiving data" f" (session id: {self.session_id}, error: {e})" + error_message = f"Got an OSError while receiving data (session id: {self.session_id}, error: {e})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -923,9 +919,7 @@

Methods

try: self.disconnect() except Exception as disconnection_error: - error_message = ( - "Failed to disconnect" f" (session id: {self.session_id}, error: {disconnection_error})" - ) + error_message = f"Failed to disconnect (session id: {self.session_id}, error: {disconnection_error})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -936,7 +930,7 @@

Methods

if self.on_error_listener is not None: self.on_error_listener(e) else: - error_message = "Got an exception while receiving data" f" (session id: {self.session_id}, error: {e})" + error_message = f"Got an exception while receiving data (session id: {self.session_id}, error: {e})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -958,7 +952,7 @@

Methods

if self.trace_enabled: if isinstance(payload, bytes): payload = payload.decode("utf-8") - self.logger.debug("Sending a text data frame " f"(session id: {self.session_id}, payload: {payload})") + self.logger.debug(f"Sending a text data frame (session id: {self.session_id}, payload: {payload})") data = _build_data_frame_for_sending(payload, FrameHeader.OPCODE_TEXT) with self.sock_send_lock: try: diff --git a/docs/reference/socket_mode/builtin/index.html b/docs/reference/socket_mode/builtin/index.html index b24db1c9b..ce295e515 100644 --- a/docs/reference/socket_mode/builtin/index.html +++ b/docs/reference/socket_mode/builtin/index.html @@ -288,7 +288,7 @@

Classes

def _on_error(self, error: Exception): error_message = ( - f"on_error invoked (session id: {self.session_id()}, " f"error: {type(error).__name__}, message: {error})" + f"on_error invoked (session id: {self.session_id()}, error: {type(error).__name__}, message: {error})" ) if self.trace_enabled: self.logger.exception(error_message) @@ -302,7 +302,7 @@

Classes

if self.logger.level <= logging.DEBUG: self.logger.debug(f"on_close invoked (session id: {self.session_id()})") if self.auto_reconnect_enabled: - self.logger.info("Received CLOSE event. Reconnecting... " f"(session id: {self.session_id()})") + self.logger.info(f"Received CLOSE event. Reconnecting... (session id: {self.session_id()})") self.connect_to_new_endpoint() for listener in self.on_close_listeners: listener(code, reason) @@ -311,12 +311,12 @@

Classes

if self.current_session is not None and self.current_session.is_active(): session_id = self.session_id() try: - self.logger.info("Starting to receive messages from a new connection" f" (session id: {session_id})") + self.logger.info(f"Starting to receive messages from a new connection (session id: {session_id})") self.current_session_state.terminated = False self.current_session.run_until_completion(self.current_session_state) - self.logger.info("Stopped receiving messages from a connection" f" (session id: {session_id})") + self.logger.info(f"Stopped receiving messages from a connection (session id: {session_id})") except Exception as e: - error_message = "Failed to start or stop the current session" f" (session id: {session_id}, error: {e})" + error_message = f"Failed to start or stop the current session (session id: {session_id}, error: {e})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -329,7 +329,7 @@

Classes

if self.auto_reconnect_enabled and (self.current_session is None or not self.current_session.is_active()): self.logger.info( - "The session seems to be already closed. Reconnecting... " f"(session id: {self.session_id()})" + f"The session seems to be already closed. Reconnecting... (session id: {self.session_id()})" ) self.connect_to_new_endpoint() except Exception as e: diff --git a/docs/reference/socket_mode/index.html b/docs/reference/socket_mode/index.html index 1fb84832e..64788cd30 100644 --- a/docs/reference/socket_mode/index.html +++ b/docs/reference/socket_mode/index.html @@ -325,7 +325,7 @@

Classes

def _on_error(self, error: Exception): error_message = ( - f"on_error invoked (session id: {self.session_id()}, " f"error: {type(error).__name__}, message: {error})" + f"on_error invoked (session id: {self.session_id()}, error: {type(error).__name__}, message: {error})" ) if self.trace_enabled: self.logger.exception(error_message) @@ -339,7 +339,7 @@

Classes

if self.logger.level <= logging.DEBUG: self.logger.debug(f"on_close invoked (session id: {self.session_id()})") if self.auto_reconnect_enabled: - self.logger.info("Received CLOSE event. Reconnecting... " f"(session id: {self.session_id()})") + self.logger.info(f"Received CLOSE event. Reconnecting... (session id: {self.session_id()})") self.connect_to_new_endpoint() for listener in self.on_close_listeners: listener(code, reason) @@ -348,12 +348,12 @@

Classes

if self.current_session is not None and self.current_session.is_active(): session_id = self.session_id() try: - self.logger.info("Starting to receive messages from a new connection" f" (session id: {session_id})") + self.logger.info(f"Starting to receive messages from a new connection (session id: {session_id})") self.current_session_state.terminated = False self.current_session.run_until_completion(self.current_session_state) - self.logger.info("Stopped receiving messages from a connection" f" (session id: {session_id})") + self.logger.info(f"Stopped receiving messages from a connection (session id: {session_id})") except Exception as e: - error_message = "Failed to start or stop the current session" f" (session id: {session_id}, error: {e})" + error_message = f"Failed to start or stop the current session (session id: {session_id}, error: {e})" if self.trace_enabled: self.logger.exception(error_message) else: @@ -366,7 +366,7 @@

Classes

if self.auto_reconnect_enabled and (self.current_session is None or not self.current_session.is_active()): self.logger.info( - "The session seems to be already closed. Reconnecting... " f"(session id: {self.session_id()})" + f"The session seems to be already closed. Reconnecting... (session id: {self.session_id()})" ) self.connect_to_new_endpoint() except Exception as e: diff --git a/docs/reference/web/index.html b/docs/reference/web/index.html index 8c42b1030..aea748acf 100644 --- a/docs/reference/web/index.html +++ b/docs/reference/web/index.html @@ -93,7 +93,7 @@

Sub-modules

slack_sdk.web.legacy_client
-
+

A Python module for interacting with Slack's Web API.

slack_sdk.web.legacy_slack_response
diff --git a/docs/reference/web/legacy_client.html b/docs/reference/web/legacy_client.html index 5d3c4d165..cd714042b 100644 --- a/docs/reference/web/legacy_client.html +++ b/docs/reference/web/legacy_client.html @@ -5,7 +5,7 @@ slack_sdk.web.legacy_client API documentation - + @@ -36,6 +36,7 @@

Module slack_sdk.web.legacy_client

+

A Python module for interacting with Slack's Web API.

diff --git a/docs/reference/web/legacy_slack_response.html b/docs/reference/web/legacy_slack_response.html index ebb222904..d3f2bfe65 100644 --- a/docs/reference/web/legacy_slack_response.html +++ b/docs/reference/web/legacy_slack_response.html @@ -240,10 +240,7 @@

Classes

if self._logger.level <= logging.DEBUG: body = self.data if isinstance(self.data, dict) else "(binary)" self._logger.debug( - "Received the following response - " - f"status: {self.status_code}, " - f"headers: {dict(self.headers)}, " - f"body: {body}" + f"Received the following response - status: {self.status_code}, headers: {dict(self.headers)}, body: {body}" ) if self.status_code == 200 and self.data and (isinstance(self.data, bytes) or self.data.get("ok", False)): return self @@ -363,10 +360,7 @@

Methods

if self._logger.level <= logging.DEBUG: body = self.data if isinstance(self.data, dict) else "(binary)" self._logger.debug( - "Received the following response - " - f"status: {self.status_code}, " - f"headers: {dict(self.headers)}, " - f"body: {body}" + f"Received the following response - status: {self.status_code}, headers: {dict(self.headers)}, body: {body}" ) if self.status_code == 200 and self.data and (isinstance(self.data, bytes) or self.data.get("ok", False)): return self diff --git a/docs/reference/webhook/async_client.html b/docs/reference/webhook/async_client.html index c5c01c799..484f636ca 100644 --- a/docs/reference/webhook/async_client.html +++ b/docs/reference/webhook/async_client.html @@ -278,7 +278,7 @@

Classes

): if self.logger.level <= logging.DEBUG: self.logger.info( - f"A retry handler found: {type(handler).__name__} " f"for POST {self.url} - {e}" + f"A retry handler found: {type(handler).__name__} for POST {self.url} - {e}" ) await handler.prepare_for_next_attempt_async( state=retry_state, diff --git a/slack_sdk/version.py b/slack_sdk/version.py index ed69eec06..3d0785b32 100644 --- a/slack_sdk/version.py +++ b/slack_sdk/version.py @@ -1,3 +1,3 @@ """Check the latest version at https://pypi.org/project/slack-sdk/""" -__version__ = "3.44.0" +__version__ = "3.44.1"