Skip to content

Commit bbcad63

Browse files
committed
Apply more updates on #216
1 parent f0ee5a1 commit bbcad63

File tree

9 files changed

+33
-22
lines changed

9 files changed

+33
-22
lines changed

slack_bolt/app/app.py

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,11 @@
6161
from slack_bolt.oauth.oauth_settings import OAuthSettings
6262
from slack_bolt.request import BoltRequest
6363
from slack_bolt.response import BoltResponse
64-
from slack_bolt.util.utils import create_web_client, get_boot_message
64+
from slack_bolt.util.utils import (
65+
create_web_client,
66+
get_boot_message,
67+
get_name_for_callable,
68+
)
6569
from slack_bolt.workflows.step import WorkflowStep, WorkflowStepMiddleware
6670

6771

@@ -347,7 +351,7 @@ def middleware_next():
347351
return resp
348352

349353
for listener in self._listeners:
350-
listener_name = listener.ack_function.__name__
354+
listener_name = get_name_for_callable(listener.ack_function)
351355
self._framework_logger.debug(debug_checking_listener(listener_name))
352356
if listener.matches(req=req, resp=resp):
353357
# run all the middleware attached to this listener first

slack_bolt/app/async_app.py

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,6 +12,7 @@
1212
AsyncMessageListenerMatches,
1313
)
1414
from slack_bolt.oauth.async_internals import select_consistent_installation_store
15+
from slack_bolt.util.utils import get_name_for_callable
1516
from slack_bolt.workflows.step.async_step import AsyncWorkflowStep
1617
from slack_bolt.workflows.step.async_step_middleware import AsyncWorkflowStepMiddleware
1718
from slack_sdk.oauth.installation_store.async_installation_store import (
@@ -385,7 +386,7 @@ async def async_middleware_next():
385386
return resp
386387

387388
for listener in self._async_listeners:
388-
listener_name = listener.ack_function.__name__
389+
listener_name = get_name_for_callable(listener.ack_function)
389390
self._framework_logger.debug(debug_checking_listener(listener_name))
390391
if await listener.async_matches(req=req, resp=resp):
391392
# run all the middleware attached to this listener first
@@ -917,7 +918,7 @@ def _register_listener(
917918

918919
for func in functions:
919920
if not inspect.iscoroutinefunction(func):
920-
name = func.__name__
921+
name = get_name_for_callable(func)
921922
raise BoltError(error_listener_function_must_be_coro_func(name))
922923

923924
listener_matchers = [

slack_bolt/listener/asyncio_runner.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@
1515
)
1616
from slack_bolt.request.async_request import AsyncBoltRequest
1717
from slack_bolt.response import BoltResponse
18-
from slack_bolt.util.utils import create_copy, name_for_callable
18+
from slack_bolt.util.utils import create_copy, get_name_for_callable
1919

2020

2121
class AsyncioListenerRunner:
@@ -71,7 +71,7 @@ async def run(
7171

7272
for lazy_func in listener.lazy_functions:
7373
if request.lazy_function_name:
74-
func_name = name_for_callable(lazy_func)
74+
func_name = get_name_for_callable(lazy_func)
7575
if func_name == request.lazy_function_name:
7676
await self.lazy_listener_runner.run(
7777
function=lazy_func, request=request
@@ -128,7 +128,7 @@ async def run_ack_function_asynchronously(
128128

129129
for lazy_func in listener.lazy_functions:
130130
if request.lazy_function_name:
131-
func_name = name_for_callable(lazy_func)
131+
func_name = get_name_for_callable(lazy_func)
132132
if func_name == request.lazy_function_name:
133133
await self.lazy_listener_runner.run(
134134
function=lazy_func, request=request
@@ -163,7 +163,7 @@ def _start_lazy_function(
163163
self, lazy_func: Callable[..., Awaitable[None]], request: AsyncBoltRequest
164164
) -> None:
165165
# Start a lazy function asynchronously
166-
func_name: str = name_for_callable(lazy_func)
166+
func_name: str = get_name_for_callable(lazy_func)
167167
self.logger.debug(debug_running_lazy_listener(func_name))
168168
copied_request = self._build_lazy_request(request, func_name)
169169
self.lazy_listener_runner.start(function=lazy_func, request=copied_request)

slack_bolt/listener/thread_runner.py

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -13,7 +13,7 @@
1313
)
1414
from slack_bolt.request import BoltRequest
1515
from slack_bolt.response import BoltResponse
16-
from slack_bolt.util.utils import create_copy, name_for_callable
16+
from slack_bolt.util.utils import create_copy, get_name_for_callable
1717

1818

1919
class ThreadListenerRunner:
@@ -72,7 +72,7 @@ def run( # type: ignore
7272

7373
for lazy_func in listener.lazy_functions:
7474
if request.lazy_function_name:
75-
func_name = name_for_callable(lazy_func)
75+
func_name = get_name_for_callable(lazy_func)
7676
if func_name == request.lazy_function_name:
7777
self.lazy_listener_runner.run(
7878
function=lazy_func, request=request
@@ -127,7 +127,7 @@ def run_ack_function_asynchronously():
127127

128128
for lazy_func in listener.lazy_functions:
129129
if request.lazy_function_name:
130-
func_name = name_for_callable(lazy_func)
130+
func_name = get_name_for_callable(lazy_func)
131131
if func_name == request.lazy_function_name:
132132
self.lazy_listener_runner.run(
133133
function=lazy_func, request=request
@@ -162,7 +162,7 @@ def _start_lazy_function(
162162
self, lazy_func: Callable[..., None], request: BoltRequest
163163
) -> None:
164164
# Start a lazy function asynchronously
165-
func_name: str = name_for_callable(lazy_func)
165+
func_name: str = get_name_for_callable(lazy_func)
166166
self.logger.debug(debug_running_lazy_listener(func_name))
167167
copied_request = self._build_lazy_request(request, func_name)
168168
self.lazy_listener_runner.start(function=lazy_func, request=copied_request)

slack_bolt/middleware/async_custom_middleware.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from slack_bolt.request.async_request import AsyncBoltRequest
88
from slack_bolt.response import BoltResponse
99
from .async_middleware import AsyncMiddleware
10-
from slack_bolt.util.utils import name_for_callable
10+
from slack_bolt.util.utils import get_name_for_callable
1111

1212

1313
class AsyncCustomMiddleware(AsyncMiddleware):
@@ -46,4 +46,4 @@ async def async_process(
4646

4747
@property
4848
def name(self) -> str:
49-
return f"AsyncCustomMiddleware(func={name_for_callable(self.func)})"
49+
return f"AsyncCustomMiddleware(func={get_name_for_callable(self.func)})"

slack_bolt/middleware/custom_middleware.py

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,7 +7,7 @@
77
from slack_bolt.request import BoltRequest
88
from slack_bolt.response import BoltResponse
99
from .middleware import Middleware
10-
from slack_bolt.util.utils import name_for_callable
10+
from slack_bolt.util.utils import get_name_for_callable
1111

1212

1313
class CustomMiddleware(Middleware):
@@ -42,4 +42,4 @@ def process(
4242

4343
@property
4444
def name(self) -> str:
45-
return f"CustomMiddleware(func={name_for_callable(self.func)})"
45+
return f"CustomMiddleware(func={get_name_for_callable(self.func)})"

slack_bolt/util/utils.py

Lines changed: 8 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,13 @@ def get_boot_message(development_server: bool = False) -> str:
5959
return "⚡️ Bolt app is running!"
6060

6161

62-
def name_for_callable(func: Callable) -> str:
62+
def get_name_for_callable(func: Callable) -> str:
63+
"""Returns the name for the given Callable function object.
64+
65+
:param func: either a Callable instance or a function, which as __name__
66+
:return: name of the given Callable object
67+
"""
6368
if hasattr(func, "__name__"):
64-
func_name = func.__name__
69+
return func.__name__
6570
else:
66-
func_name = f"{func.__class__.__module__}.{func.__class__.__name__}"
67-
return func_name
71+
return f"{func.__class__.__module__}.{func.__class__.__name__}"

slack_bolt/workflows/step/async_step_middleware.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
from slack_bolt.middleware.async_middleware import AsyncMiddleware
66
from slack_bolt.request.async_request import AsyncBoltRequest
77
from slack_bolt.response import BoltResponse
8+
from slack_bolt.util.utils import get_name_for_callable
89
from slack_bolt.workflows.step.async_step import AsyncWorkflowStep
910

1011

@@ -51,6 +52,6 @@ async def _run(
5152
return await self.listener_runner.run(
5253
request=req,
5354
response=resp,
54-
listener_name=listener.ack_function.__name__,
55+
listener_name=get_name_for_callable(listener.ack_function),
5556
listener=listener,
5657
)

slack_bolt/workflows/step/step_middleware.py

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,6 +5,7 @@
55
from slack_bolt.middleware import Middleware
66
from slack_bolt.request import BoltRequest
77
from slack_bolt.response import BoltResponse
8+
from slack_bolt.util.utils import get_name_for_callable
89
from slack_bolt.workflows.step.step import WorkflowStep
910

1011

@@ -49,6 +50,6 @@ def _run(
4950
return self.listener_runner.run(
5051
request=req,
5152
response=resp,
52-
listener_name=listener.ack_function.__name__,
53+
listener_name=get_name_for_callable(listener.ack_function),
5354
listener=listener,
5455
)

0 commit comments

Comments
 (0)