jeans/developers.home-assistant
jeans/developers.home-assistant
1
0
Fork 0
mirror of https://github.com/home-assistant/developers.home-assistant.git synced 2025-07-15 05:16:28 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update options flow examples to including typing (#1338)

Browse Source
This commit is contained in:
Allen Porter 2022-05-23 00:12:52 -07:00 committed by GitHub
parent b4884b51f8
commit 04e6cd5406
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 8 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
docs/config_entries_options_flow_handler.md
View File

@ -14,7 +14,10 @@ For an integration to support options it needs to have an `async_get_options_flo
```python ```python
@staticmethod @staticmethod
@callback @callback
def async_get_options_flow(config_entry): def async_get_options_flow(
config_entry: config_entries.ConfigEntry,
) -> config_entries.OptionsFlow:
"""Create the options flow."""
return OptionsFlowHandler(config_entry) return OptionsFlowHandler(config_entry)
``` ```
@ -24,11 +27,13 @@ The Flow handler works just like the config flow handler, except that the first
```python ```python
class OptionsFlowHandler(config_entries.OptionsFlow): class OptionsFlowHandler(config_entries.OptionsFlow):
def __init__(self, config_entry): def __init__(self, config_entry: config_entries.ConfigEntry) -> None:
"""Initialize options flow.""" """Initialize options flow."""
self.config_entry = config_entry self.config_entry = config_entry
async def async_step_init(self, user_input=None): async def async_step_init(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Manage the options.""" """Manage the options."""
if user_input is not None: if user_input is not None:
return self.async_create_entry(title="", data=user_input) return self.async_create_entry(title="", data=user_input)