Skip to content

fix: add missing lazy parameter to listener method type hints #1469

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
quicksilversel wants to merge 2 commits into
base: main
Choose a base branch
from
+36 −0
Open

fix: add missing lazy parameter to listener method type hints #1469

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
31ceb6f
fix: add missing lazy parameter to listener method type hints
quicksilversel Mar 23, 2026
ff766a3
chore: retrigger CLA check
quicksilversel Mar 23, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 18 additions & 0 deletions slack_bolt/app/app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -813,6 +813,7 @@ def event(
],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new event listener. This method can be used as either a decorator or a method.

Expand Down Expand Up @@ -855,6 +856,7 @@ def message(
keyword: Union[str, Pattern] = "",
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new message event listener. This method can be used as either a decorator or a method.
Check the `App#event` method's docstring for details.
Expand Down Expand Up @@ -917,6 +919,7 @@ def function(
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
auto_acknowledge: bool = True,
ack_timeout: int = 3,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new Function listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -967,6 +970,7 @@ def command(
command: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new slash command listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -1008,6 +1012,7 @@ def shortcut(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new shortcut listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -1052,6 +1057,7 @@ def global_shortcut(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new global shortcut listener."""

Expand All @@ -1067,6 +1073,7 @@ def message_shortcut(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new message shortcut listener."""

Expand All @@ -1085,6 +1092,7 @@ def action(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new action listener. This method can be used as either a decorator or a method.

Expand Down Expand Up @@ -1122,6 +1130,7 @@ def block_action(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `block_actions` action listener.
Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload/ for details.
Expand All @@ -1139,6 +1148,7 @@ def attachment_action(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `interactive_message` action listener.
Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons/ for details."""
Expand All @@ -1155,6 +1165,7 @@ def dialog_submission(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `dialog_submission` listener.
Refer to https://docs.slack.dev/legacy/legacy-dialogs/ for details."""
Expand All @@ -1171,6 +1182,7 @@ def dialog_cancellation(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `dialog_cancellation` listener.
Refer to https://docs.slack.dev/legacy/legacy-dialogs/ for details."""
Expand All @@ -1190,6 +1202,7 @@ def view(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `view_submission`/`view_closed` event listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -1238,6 +1251,7 @@ def view_submission(
constraints: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `view_submission` listener.
Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload/#view_submission for
Expand All @@ -1256,6 +1270,7 @@ def view_closed(
constraints: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `view_closed` listener.
Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload/#view_closed for details."""
Expand All @@ -1275,6 +1290,7 @@ def options(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new options listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -1323,6 +1339,7 @@ def block_suggestion(
action_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `block_suggestion` listener."""

Expand All @@ -1338,6 +1355,7 @@ def dialog_suggestion(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., bool]]] = None,
middleware: Optional[Sequence[Union[Callable, Middleware]]] = None,
lazy: Optional[Sequence[Callable[..., Optional[BoltResponse]]]] = None,
) -> Callable[..., Optional[Callable[..., Optional[BoltResponse]]]]:
"""Registers a new `dialog_suggestion` listener.
Refer to https://docs.slack.dev/legacy/legacy-dialogs/ for details."""
Expand Down
18 changes: 18 additions & 0 deletions slack_bolt/app/async_app.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -841,6 +841,7 @@ def event(
],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new event listener. This method can be used as either a decorator or a method.

Expand Down Expand Up @@ -883,6 +884,7 @@ def message(
keyword: Union[str, Pattern] = "",
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new message event listener. This method can be used as either a decorator or a method.
Check the `App#event` method's docstring for details.
Expand Down Expand Up @@ -948,6 +950,7 @@ def function(
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
auto_acknowledge: bool = True,
ack_timeout: int = 3,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[BoltResponse]]]]:
"""Registers a new Function listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -999,6 +1002,7 @@ def command(
command: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new slash command listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -1040,6 +1044,7 @@ def shortcut(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new shortcut listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -1084,6 +1089,7 @@ def global_shortcut(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new global shortcut listener."""

Expand All @@ -1099,6 +1105,7 @@ def message_shortcut(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new message shortcut listener."""

Expand All @@ -1117,6 +1124,7 @@ def action(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new action listener. This method can be used as either a decorator or a method.

Expand Down Expand Up @@ -1154,6 +1162,7 @@ def block_action(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `block_actions` action listener.
Refer to https://docs.slack.dev/reference/interaction-payloads/block_actions-payload/ for details.
Expand All @@ -1171,6 +1180,7 @@ def attachment_action(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `interactive_message` action listener.
Refer to https://docs.slack.dev/legacy/legacy-messaging/legacy-message-buttons/ for details."""
Expand All @@ -1187,6 +1197,7 @@ def dialog_submission(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `dialog_submission` listener.
Refer to https://docs.slack.dev/legacy/legacy-dialogs/ for details."""
Expand All @@ -1203,6 +1214,7 @@ def dialog_cancellation(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `dialog_submission` listener.
Refer to https://docs.slack.dev/legacy/legacy-dialogs/ for details."""
Expand All @@ -1222,6 +1234,7 @@ def view(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `view_submission`/`view_closed` event listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -1270,6 +1283,7 @@ def view_submission(
constraints: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `view_submission` listener.
Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload/#view_submission for
Expand All @@ -1288,6 +1302,7 @@ def view_closed(
constraints: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `view_closed` listener.
Refer to https://docs.slack.dev/reference/interaction-payloads/view-interactions-payload/#view_closed for details."""
Expand All @@ -1307,6 +1322,7 @@ def options(
constraints: Union[str, Pattern, Dict[str, Union[str, Pattern]]],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new options listener.
This method can be used as either a decorator or a method.
Expand Down Expand Up @@ -1355,6 +1371,7 @@ def block_suggestion(
action_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `block_suggestion` listener."""

Expand All @@ -1370,6 +1387,7 @@ def dialog_suggestion(
callback_id: Union[str, Pattern],
matchers: Optional[Sequence[Callable[..., Awaitable[bool]]]] = None,
middleware: Optional[Sequence[Union[Callable, AsyncMiddleware]]] = None,
lazy: Optional[Sequence[Callable[..., Awaitable[Optional[BoltResponse]]]]] = None,
) -> Callable[..., Optional[Callable[..., Awaitable[Optional[BoltResponse]]]]]:
"""Registers a new `dialog_suggestion` listener.
Refer to https://docs.slack.dev/legacy/legacy-dialogs/ for details."""
Expand Down