rename acknowledgement_timeout to ack_timeout

Author: WilliamBergamin

slack_bolt/app/app.py

@@ -913,7 +913,7 @@ def function(
         matchers: Optional[Sequence[Callable[..., bool]]] = None,
         middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
         auto_acknowledge: bool = True,
-        acknowledgement_timeout: int = 3,
+        ack_timeout: int = 3,
     ) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
         """Registers a new Function listener.
         This method can be used as either a decorator or a method.
@@ -943,18 +943,16 @@ def reverse_string(ack: Ack, inputs: dict, complete: Complete, fail: Fail):
         """
 
         if auto_acknowledge is True:
-            if acknowledgement_timeout != 3:
-                self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, acknowledgement_timeout))
+            if ack_timeout != 3:
+                self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout))
 
         matchers = list(matchers) if matchers else []
         middleware = list(middleware) if middleware else []
 
         def __call__(*args, **kwargs):
             functions = self._to_listener_functions(kwargs) if kwargs else list(args)
             primary_matcher = builtin_matchers.function_executed(callback_id=callback_id, base_logger=self._base_logger)
-            return self._register_listener(
-                functions, primary_matcher, matchers, middleware, auto_acknowledge, acknowledgement_timeout
-            )
+            return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout)
 
         return __call__
 
@@ -1430,7 +1428,7 @@ def _register_listener(
         matchers: Optional[Sequence[Callable[..., bool]]],
         middleware: Optional[Sequence[Union[Callable, Middleware]]],
         auto_acknowledgement: bool = False,
-        acknowledgement_timeout: int = 3,
+        ack_timeout: int = 3,
     ) -> Optional[Callable[..., Optional[BoltResponse]]]:
         value_to_return = None
         if not isinstance(functions, list):
@@ -1461,7 +1459,7 @@ def _register_listener(
                 matchers=listener_matchers,
                 middleware=listener_middleware,
                 auto_acknowledgement=auto_acknowledgement,
-                acknowledgement_timeout=acknowledgement_timeout,
+                ack_timeout=ack_timeout,
                 base_logger=self._base_logger,
             )
         )

slack_bolt/app/async_app.py

@@ -941,7 +941,7 @@ def function(
         matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
         middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
         auto_acknowledge: bool = True,
-        acknowledgement_timeout: int = 3,
+        ack_timeout: int = 3,
     ) -> Callable[..., Optional[Callable[..., Awaitable[BoltResponse]]]]:
         """Registers a new Function listener.
         This method can be used as either a decorator or a method.
@@ -970,8 +970,8 @@ async def reverse_string(ack: AsyncAck, inputs: dict, complete: AsyncComplete, f
                 Only when all the middleware call `next()` method, the listener function can be invoked.
         """
         if auto_acknowledge is True:
-            if acknowledgement_timeout != 3:
-                self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, acknowledgement_timeout))
+            if ack_timeout != 3:
+                self._framework_logger.warning(warning_ack_timeout_has_no_effect(callback_id, ack_timeout))
 
         matchers = list(matchers) if matchers else []
         middleware = list(middleware) if middleware else []
@@ -981,9 +981,7 @@ def __call__(*args, **kwargs):
             primary_matcher = builtin_matchers.function_executed(
                 callback_id=callback_id, base_logger=self._base_logger, asyncio=True
             )
-            return self._register_listener(
-                functions, primary_matcher, matchers, middleware, auto_acknowledge, acknowledgement_timeout
-            )
+            return self._register_listener(functions, primary_matcher, matchers, middleware, auto_acknowledge, ack_timeout)
 
         return __call__
 
@@ -1463,7 +1461,7 @@ def _register_listener(
         matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]],
         middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]],
         auto_acknowledgement: bool = False,
-        acknowledgement_timeout: int = 3,
+        ack_timeout: int = 3,
     ) -> Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]:
         value_to_return = None
         if not isinstance(functions, list):
@@ -1499,7 +1497,7 @@ def _register_listener(
                 matchers=listener_matchers,
                 middleware=listener_middleware,
                 auto_acknowledgement=auto_acknowledgement,
-                acknowledgement_timeout=acknowledgement_timeout,
+                ack_timeout=ack_timeout,
                 base_logger=self._base_logger,
             )
         )

slack_bolt/listener/async_listener.py

@@ -15,7 +15,7 @@ class AsyncListener(metaclass=ABCMeta):
     ack_function: Callable[..., Awaitable[BoltResponse]]
     lazy_functions: Sequence[Callable[..., Awaitable[None]]]
     auto_acknowledgement: bool
-    acknowledgement_timeout: int
+    ack_timeout: int
 
     async def async_matches(
         self,
@@ -88,7 +88,7 @@ class AsyncCustomListener(AsyncListener):
     matchers: Sequence[AsyncListenerMatcher]
     middleware: Sequence[AsyncMiddleware]
     auto_acknowledgement: bool
-    acknowledgement_timeout: int
+    ack_timeout: int
     arg_names: MutableSequence[str]
     logger: Logger
 
@@ -101,7 +101,7 @@ def __init__(
         matchers: Sequence[AsyncListenerMatcher],
         middleware: Sequence[AsyncMiddleware],
         auto_acknowledgement: bool = False,
-        acknowledgement_timeout: int = 3,
+        ack_timeout: int = 3,
         base_logger: Optional[Logger] = None,
     ):
         self.app_name = app_name
@@ -110,7 +110,7 @@ def __init__(
         self.matchers = matchers
         self.middleware = middleware
         self.auto_acknowledgement = auto_acknowledgement
-        self.acknowledgement_timeout = acknowledgement_timeout
+        self.ack_timeout = ack_timeout
         self.arg_names = get_arg_names_of_callable(ack_function)
         self.logger = get_bolt_app_logger(app_name, self.ack_function, base_logger)
 

slack_bolt/listener/asyncio_runner.py

@@ -149,7 +149,7 @@ async def run_ack_function_asynchronously(
                     self._start_lazy_function(lazy_func, request)
 
             # await for the completion of ack() in the async listener execution
-            while ack.response is None and time.time() - starting_time <= listener.acknowledgement_timeout:
+            while ack.response is None and time.time() - starting_time <= listener.ack_timeout:
                 await asyncio.sleep(0.01)
 
             if response is None and ack.response is None:

slack_bolt/listener/custom_listener.py

@@ -18,7 +18,7 @@ class CustomListener(Listener):
     matchers: Sequence[ListenerMatcher]
     middleware: Sequence[Middleware]
     auto_acknowledgement: bool
-    acknowledgement_timeout: int = 3
+    ack_timeout: int = 3
     arg_names: MutableSequence[str]
     logger: Logger
 
@@ -31,7 +31,7 @@ def __init__(
         matchers: Sequence[ListenerMatcher],
         middleware: Sequence[Middleware],
         auto_acknowledgement: bool = False,
-        acknowledgement_timeout: int = 3,
+        ack_timeout: int = 3,
         base_logger: Optional[Logger] = None,
     ):
         self.app_name = app_name
@@ -40,7 +40,7 @@ def __init__(
         self.matchers = matchers
         self.middleware = middleware
         self.auto_acknowledgement = auto_acknowledgement
-        self.acknowledgement_timeout = acknowledgement_timeout
+        self.ack_timeout = ack_timeout
         self.arg_names = get_arg_names_of_callable(ack_function)
         self.logger = get_bolt_app_logger(app_name, self.ack_function, base_logger)
 

slack_bolt/listener/listener.py

@@ -13,7 +13,7 @@ class Listener(metaclass=ABCMeta):
     ack_function: Callable[..., BoltResponse]
     lazy_functions: Sequence[Callable[..., None]]
     auto_acknowledgement: bool
-    acknowledgement_timeout: int = 3
+    ack_timeout: int = 3
 
     def matches(
         self,

slack_bolt/listener/thread_runner.py

@@ -160,7 +160,7 @@ def run_ack_function_asynchronously():
                     self._start_lazy_function(lazy_func, request)
 
             # await for the completion of ack() in the async listener execution
-            while ack.response is None and time.time() - starting_time <= listener.acknowledgement_timeout:
+            while ack.response is None and time.time() - starting_time <= listener.ack_timeout:
                 time.sleep(0.01)
 
             if response is None and ack.response is None:

slack_bolt/logger/messages.py

@@ -332,12 +332,9 @@ def warning_skip_uncommon_arg_name(arg_name: str) -> str:
     )
 
 
-def warning_ack_timeout_has_no_effect(identifier: Union[str, Pattern], acknowledgement_timeout: int) -> str:
+def warning_ack_timeout_has_no_effect(identifier: Union[str, Pattern], ack_timeout: int) -> str:
     handler_example = f'@app.function("{identifier}")' if isinstance(identifier, str) else f"@app.function({identifier})"
-    return (
-        f"On {handler_example}, as `auto_acknowledge` is `True`, "
-        f"`acknowledgement_timeout={acknowledgement_timeout}` you gave will be unused"
-    )
+    return f"On {handler_example}, as `auto_acknowledge` is `True`, " f"`ack_timeout={ack_timeout}` you gave will be unused"
 
 
 # -------------------------------

tests/scenario_tests/test_function.py

@@ -155,7 +155,7 @@ def test_function_handler_timeout(self, monkeypatch):
             client=self.web_client,
             signing_secret=self.signing_secret,
         )
-        app.function("reverse", auto_acknowledge=False, acknowledgement_timeout=timeout)(just_no_ack)
+        app.function("reverse", auto_acknowledge=False, ack_timeout=timeout)(just_no_ack)
         request = self.build_request_from_body(function_body)
 
         sleep_mock = Mock()
@@ -181,7 +181,7 @@ def test_warning_when_timeout_improperly_set(self, caplog):
         app.function("reverse")(just_no_ack)
         assert "WARNING" not in caplog.text
 
-        timeout_argument_name = "acknowledgement_timeout"
+        timeout_argument_name = "ack_timeout"
         kwargs = {timeout_argument_name: 5}
 
         callback_id = "reverse1"

tests/scenario_tests_async/test_function.py

@@ -166,7 +166,7 @@ async def test_function_handler_timeout(self, monkeypatch):
             client=self.web_client,
             signing_secret=self.signing_secret,
         )
-        app.function("reverse", auto_acknowledge=False, acknowledgement_timeout=timeout)(just_no_ack)
+        app.function("reverse", auto_acknowledge=False, ack_timeout=timeout)(just_no_ack)
         request = self.build_request_from_body(function_body)
 
         sleep_mock = MagicMock(side_effect=fake_sleep)
@@ -193,7 +193,7 @@ async def test_warning_when_timeout_improperly_set(self, caplog):
         app.function("reverse")(just_no_ack)
         assert "WARNING" not in caplog.text
 
-        timeout_argument_name = "acknowledgement_timeout"
+        timeout_argument_name = "ack_timeout"
         kwargs = {timeout_argument_name: 5}
 
         callback_id = "reverse1"