Skip to content

Commit e1a14b8

Browse files
misscodedseratch
authored andcommitted
remove save_callback_id, fix callback def typo + doc string grammar
1 parent 95d7dd0 commit e1a14b8

File tree

4 files changed

+10
-19
lines changed

4 files changed

+10
-19
lines changed

slack_bolt/app/app.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -352,19 +352,17 @@ def middleware(self, *args) -> None:
352352
def step(
353353
self,
354354
callback_id: Union[str, Pattern, WorkflowStep],
355-
save_callback_id: Optional[Union[str, Pattern]] = None,
356355
edit: Optional[Union[Callable[..., Optional[BoltResponse]], Listener]] = None,
357356
save: Optional[Union[Callable[..., Optional[BoltResponse]], Listener]] = None,
358357
execute: Optional[
359358
Union[Callable[..., Optional[BoltResponse]], Listener]
360359
] = None,
361360
):
362-
"""Registers a new Workflow Steps from Apps listeners."""
361+
"""Registers a new Workflow Step listener"""
363362
step = callback_id
364363
if isinstance(callback_id, (str, Pattern)):
365364
step = WorkflowStep(
366365
callback_id=callback_id,
367-
save_callback_id=save_callback_id,
368366
edit=edit,
369367
save=save,
370368
execute=execute,

slack_bolt/app/async_app.py

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -364,7 +364,6 @@ def middleware(self, *args) -> None:
364364
def step(
365365
self,
366366
callback_id: Union[str, Pattern, AsyncWorkflowStep],
367-
save_callback_id: Optional[Union[str, Pattern]] = None,
368367
edit: Optional[
369368
Union[Callable[..., Optional[BoltResponse]], AsyncListener]
370369
] = None,
@@ -375,12 +374,11 @@ def step(
375374
Union[Callable[..., Optional[BoltResponse]], AsyncListener]
376375
] = None,
377376
):
378-
"""Registers a new Workflow Steps from Apps listeners."""
377+
"""Registers a new Workflow Step listener"""
379378
step = callback_id
380379
if isinstance(callback_id, (str, Pattern)):
381380
step = AsyncWorkflowStep(
382381
callback_id=callback_id,
383-
save_callback_id=save_callback_id,
384382
edit=edit,
385383
save=save,
386384
execute=execute,

slack_bolt/workflows/step/async_step.py

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -29,15 +29,12 @@ def __init__(
2929
edit: Union[Callable[..., Awaitable[BoltResponse]], AsyncListener],
3030
save: Union[Callable[..., Awaitable[BoltResponse]], AsyncListener],
3131
execute: Union[Callable[..., Awaitable[BoltResponse]], AsyncListener],
32-
save_callback_id: Optional[str] = None, # TODO: better approach?
3332
app_name: Optional[str] = None,
3433
):
3534
self.callback_id = callback_id
3635
app_name = app_name or __name__
3736
self.edit = self._build_listener(callback_id, app_name, edit, "edit")
38-
self.save = self._build_listener(
39-
save_callback_id or callback_id, app_name, save, "save"
40-
)
37+
self.save = self._build_listener(callback_id, app_name, save, "save")
4138
self.execute = self._build_listener(callback_id, app_name, execute, "execute")
4239

4340
@classmethod
@@ -125,7 +122,7 @@ async def save_listener_middleware(
125122

126123

127124
def _build_execute_listener_middleware():
128-
async def save_listener_middleware(
125+
async def execute_listener_middleware(
129126
context: AsyncBoltContext,
130127
client: AsyncWebClient,
131128
body: dict,
@@ -135,4 +132,4 @@ async def save_listener_middleware(
135132
context["fail"] = AsyncFail(client=client, body=body,)
136133
return await next()
137134

138-
return AsyncCustomMiddleware(app_name=__name__, func=save_listener_middleware)
135+
return AsyncCustomMiddleware(app_name=__name__, func=execute_listener_middleware)

slack_bolt/workflows/step/step.py

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -29,16 +29,14 @@ def __init__(
2929
edit: Union[Callable[..., Optional[BoltResponse]], Listener],
3030
save: Union[Callable[..., Optional[BoltResponse]], Listener],
3131
execute: Union[Callable[..., Optional[BoltResponse]], Listener],
32-
save_callback_id: Optional[str] = None, # TODO: better approach?
3332
app_name: Optional[str] = None,
3433
):
3534
self.callback_id = callback_id
3635
app_name = app_name or __name__
3736
self.edit = self._build_listener(callback_id, app_name, edit, "edit")
38-
self.save = self._build_listener(
39-
save_callback_id or callback_id, app_name, save, "save"
40-
)
41-
self.execute = self._build_listener(callback_id, app_name, execute, "execute")
37+
self.save = self._build_listener(callback_id, app_name, save, "save")
38+
self.execute = self._build_listener(
39+
callback_id, app_name, execute, "execute")
4240

4341
@classmethod
4442
def _build_listener(cls, callback_id, app_name, listener, name):
@@ -123,7 +121,7 @@ def save_listener_middleware(
123121

124122

125123
def _build_execute_listener_middleware():
126-
def save_listener_middleware(
124+
def execute_listener_middleware(
127125
context: BoltContext,
128126
client: WebClient,
129127
body: dict,
@@ -133,4 +131,4 @@ def save_listener_middleware(
133131
context["fail"] = Fail(client=client, body=body,)
134132
return next()
135133

136-
return CustomMiddleware(app_name=__name__, func=save_listener_middleware)
134+
return CustomMiddleware(app_name=__name__, func=execute_listener_middleware)

0 commit comments

Comments
 (0)