jeans/core
jeans/core
1
0
Fork 0
mirror of https://github.com/home-assistant/core.git synced 2025-07-19 19:27:45 +00:00
Code Issues Packages Projects Releases Wiki Activity

Make step_id parameter to FlowHandler.async_show_progress optional (#107802)

Browse Source 
Drop step_id parameter from FlowHandler.async_show_progress
This commit is contained in:
Erik Montnemery 2024-01-11 21:05:20 +01:00 committed by GitHub
parent ddf3a36061
commit 44a6882c39
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 14 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

16
homeassistant/data_entry_flow.py
View File

@ -74,6 +74,10 @@ FLOW_NOT_COMPLETE_STEPS = {
FlowResultType.MENU, FlowResultType.MENU,
} }
STEP_ID_OPTIONAL_STEPS = {
FlowResultType.SHOW_PROGRESS,
}
@dataclass(slots=True) @dataclass(slots=True)
class BaseServiceInfo: class BaseServiceInfo:
@ -458,6 +462,10 @@ class FlowManager(abc.ABC):
elif result["type"] != FlowResultType.SHOW_PROGRESS: elif result["type"] != FlowResultType.SHOW_PROGRESS:
flow.async_cancel_progress_task() flow.async_cancel_progress_task()
if result["type"] in STEP_ID_OPTIONAL_STEPS:
if "step_id" not in result:
result["step_id"] = step_id
if result["type"] in FLOW_NOT_COMPLETE_STEPS: if result["type"] in FLOW_NOT_COMPLETE_STEPS:
self._raise_if_step_does_not_exist(flow, result["step_id"]) self._raise_if_step_does_not_exist(flow, result["step_id"])
flow.cur_step = result flow.cur_step = result
@ -654,21 +662,23 @@ class FlowHandler:
def async_show_progress( def async_show_progress(
self, self,
*, *,
step_id: str, step_id: str | None = None,
progress_action: str, progress_action: str,
description_placeholders: Mapping[str, str] | None = None, description_placeholders: Mapping[str, str] | None = None,
progress_task: asyncio.Task[Any] | None = None, progress_task: asyncio.Task[Any] | None = None,
) -> FlowResult: ) -> FlowResult:
"""Show a progress message to the user, without user input allowed.""" """Show a progress message to the user, without user input allowed."""
return FlowResult( result = FlowResult(
type=FlowResultType.SHOW_PROGRESS, type=FlowResultType.SHOW_PROGRESS,
flow_id=self.flow_id, flow_id=self.flow_id,
handler=self.handler, handler=self.handler,
step_id=step_id,
progress_action=progress_action, progress_action=progress_action,
description_placeholders=description_placeholders, description_placeholders=description_placeholders,
progress_task=progress_task, progress_task=progress_task,
) )
if step_id is not None:
result["step_id"] = step_id
return result
@callback @callback
def async_show_progress_done(self, *, next_step_id: str) -> FlowResult: def async_show_progress_done(self, *, next_step_id: str) -> FlowResult:

3
tests/test_data_entry_flow.py
View File

@ -380,7 +380,6 @@ async def test_show_progress(hass: HomeAssistant, manager) -> None:
self.start_task_two = False self.start_task_two = False
if not task_one_evt.is_set() or not task_two_evt.is_set(): if not task_one_evt.is_set() or not task_two_evt.is_set():
return self.async_show_progress( return self.async_show_progress(
step_id="init",
progress_action=progress_action, progress_action=progress_action,
progress_task=self.progress_task, progress_task=self.progress_task,
) )
@ -464,7 +463,7 @@ async def test_show_progress_error(hass: HomeAssistant, manager) -> None:
return self.async_show_progress_done(next_step_id="error") return self.async_show_progress_done(next_step_id="error")
return self.async_show_progress_done(next_step_id="no_error") return self.async_show_progress_done(next_step_id="no_error")
return self.async_show_progress( return self.async_show_progress(
step_id="init", progress_action="task", progress_task=self.progress_task progress_action="task", progress_task=self.progress_task
) )
async def async_step_error(self, user_input=None): async def async_step_error(self, user_input=None):