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

Improve AndroidTV typing (#71036)

Browse Source 
* Improve AndroidTV typing

* Change input type in async_connect_androidtv
This commit is contained in:
ollo69 2022-05-25 09:57:40 +02:00 committed by GitHub
parent 1d5b8746fe
commit cc7b624418
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 83 additions and 43 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

30
homeassistant/components/androidtv/__init__.py
View File

@ -1,9 +1,17 @@
"""Support for functionality to interact with Android TV/Fire TV devices."""
from __future__ import annotations
from collections.abc import Mapping
import os
from typing import Any
from adb_shell.auth.keygen import keygen
from androidtv.adb_manager.adb_manager_sync import ADBPythonSync
from androidtv.setup_async import setup as async_androidtv_setup
from androidtv.adb_manager.adb_manager_sync import ADBPythonSync, PythonRSASigner
from androidtv.setup_async import (
AndroidTVAsync,
FireTVAsync,
setup as async_androidtv_setup,
)
from homeassistant.config_entries import ConfigEntry
from homeassistant.const import (
@ -41,7 +49,7 @@ RELOAD_OPTIONS = [CONF_STATE_DETECTION_RULES]
_INVALID_MACS = {"ff:ff:ff:ff:ff:ff"}
def get_androidtv_mac(dev_props):
def get_androidtv_mac(dev_props: dict[str, Any]) -> str | None:
"""Return formatted mac from device properties."""
for prop_mac in (PROP_ETHMAC, PROP_WIFIMAC):
if if_mac := dev_props.get(prop_mac):
@ -51,9 +59,13 @@ def get_androidtv_mac(dev_props):
return None
def _setup_androidtv(hass, config):
def _setup_androidtv(
hass: HomeAssistant, config: dict[str, Any]
) -> tuple[str, PythonRSASigner | None, str]:
"""Generate an ADB key (if needed) and load it."""
adbkey = config.get(CONF_ADBKEY, hass.config.path(STORAGE_DIR, "androidtv_adbkey"))
adbkey: str = config.get(
CONF_ADBKEY, hass.config.path(STORAGE_DIR, "androidtv_adbkey")
)
if CONF_ADB_SERVER_IP not in config:
# Use "adb_shell" (Python ADB implementation)
if not os.path.isfile(adbkey):
@ -73,8 +85,12 @@ def _setup_androidtv(hass, config):
async def async_connect_androidtv(
hass, config, *, state_detection_rules=None, timeout=30.0
):
hass: HomeAssistant,
config: Mapping[str, Any],
*,
state_detection_rules: dict[str, Any] | None = None,
timeout: float = 30.0,
) -> tuple[AndroidTVAsync | FireTVAsync | None, str | None]:
"""Connect to Android device."""
address = f"{config[CONF_HOST]}:{config[CONF_PORT]}"

96
homeassistant/components/androidtv/config_flow.py
View File

@ -1,14 +1,18 @@
"""Config flow to configure the Android TV integration."""
from __future__ import annotations
import json
import logging
import os
from typing import Any
from androidtv import state_detection_rules_validator
import voluptuous as vol
from homeassistant import config_entries
from homeassistant.config_entries import ConfigEntry, ConfigFlow, OptionsFlow
from homeassistant.const import CONF_DEVICE_CLASS, CONF_HOST, CONF_PORT
from homeassistant.core import callback
from homeassistant.data_entry_flow import FlowResult
from homeassistant.helpers import config_validation as cv
from . import async_connect_androidtv, get_androidtv_mac
@ -51,24 +55,28 @@ RESULT_UNKNOWN = "unknown"
_LOGGER = logging.getLogger(__name__)
def _is_file(value):
def _is_file(value: str) -> bool:
"""Validate that the value is an existing file."""
file_in = os.path.expanduser(str(value))
file_in = os.path.expanduser(value)
return os.path.isfile(file_in) and os.access(file_in, os.R_OK)
class AndroidTVFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
class AndroidTVFlowHandler(ConfigFlow, domain=DOMAIN):
"""Handle a config flow."""
VERSION = 1
@callback
def _show_setup_form(self, user_input=None, error=None):
def _show_setup_form(
self,
user_input: dict[str, Any] | None = None,
error: str | None = None,
) -> FlowResult:
"""Show the setup form to the user."""
user_input = user_input or {}
host = user_input.get(CONF_HOST, "") if user_input else ""
data_schema = vol.Schema(
{
vol.Required(CONF_HOST, default=user_input.get(CONF_HOST, "")): str,
vol.Required(CONF_HOST, default=host): str,
vol.Required(CONF_DEVICE_CLASS, default=DEFAULT_DEVICE_CLASS): vol.In(
DEVICE_CLASSES
),
@ -90,10 +98,12 @@ class AndroidTVFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
return self.async_show_form(
step_id="user",
data_schema=data_schema,
errors={"base": error},
errors={"base": error} if error else None,
)
async def _async_check_connection(self, user_input):
async def _async_check_connection(
self, user_input: dict[str, Any]
) -> tuple[str | None, str | None]:
"""Attempt to connect the Android TV."""
try:
@ -121,7 +131,9 @@ class AndroidTVFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
await aftv.adb_close()
return None, unique_id
async def async_step_user(self, user_input=None):
async def async_step_user(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle a flow initiated by the user."""
error = None
@ -152,32 +164,31 @@ class AndroidTVFlowHandler(config_entries.ConfigFlow, domain=DOMAIN):
data=user_input,
)
user_input = user_input or {}
return self._show_setup_form(user_input, error)
@staticmethod
@callback
def async_get_options_flow(config_entry):
def async_get_options_flow(config_entry: ConfigEntry) -> OptionsFlow:
"""Get the options flow for this handler."""
return OptionsFlowHandler(config_entry)
class OptionsFlowHandler(config_entries.OptionsFlow):
class OptionsFlowHandler(OptionsFlow):
"""Handle an option flow for Android TV."""
def __init__(self, config_entry: config_entries.ConfigEntry) -> None:
def __init__(self, config_entry: ConfigEntry) -> None:
"""Initialize options flow."""
self.config_entry = config_entry
apps = config_entry.options.get(CONF_APPS, {})
det_rules = config_entry.options.get(CONF_STATE_DETECTION_RULES, {})
self._apps = apps.copy()
self._state_det_rules = det_rules.copy()
self._conf_app_id = None
self._conf_rule_id = None
self._apps: dict[str, Any] = apps.copy()
self._state_det_rules: dict[str, Any] = det_rules.copy()
self._conf_app_id: str | None = None
self._conf_rule_id: str | None = None
@callback
def _save_config(self, data):
def _save_config(self, data: dict[str, Any]) -> FlowResult:
"""Save the updated options."""
new_data = {
k: v
@ -191,7 +202,9 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
return self.async_create_entry(title="", data=new_data)
async def async_step_init(self, user_input=None):
async def async_step_init(
self, user_input: dict[str, Any] | None = None
) -> FlowResult:
"""Handle options flow."""
if user_input is not None:
if sel_app := user_input.get(CONF_APPS):
@ -203,7 +216,7 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
return self._async_init_form()
@callback
def _async_init_form(self):
def _async_init_form(self) -> FlowResult:
"""Return initial configuration form."""
apps_list = {k: f"{v} ({k})" if v else k for k, v in self._apps.items()}
@ -246,7 +259,9 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
return self.async_show_form(step_id="init", data_schema=data_schema)
async def async_step_apps(self, user_input=None, app_id=None):
async def async_step_apps(
self, user_input: dict[str, Any] | None = None, app_id: str | None = None
) -> FlowResult:
"""Handle options flow for apps list."""
if app_id is not None:
self._conf_app_id = app_id if app_id != APPS_NEW_ID else None
@ -263,28 +278,32 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
return await self.async_step_init()
@callback
def _async_apps_form(self, app_id):
def _async_apps_form(self, app_id: str) -> FlowResult:
"""Return configuration form for apps."""
data_schema = {
app_schema = {
vol.Optional(
CONF_APP_NAME,
description={"suggested_value": self._apps.get(app_id, "")},
): str,
}
if app_id == APPS_NEW_ID:
data_schema[vol.Optional(CONF_APP_ID)] = str
data_schema = vol.Schema({**app_schema, vol.Optional(CONF_APP_ID): str})
else:
data_schema[vol.Optional(CONF_APP_DELETE, default=False)] = bool
data_schema = vol.Schema(
{**app_schema, vol.Optional(CONF_APP_DELETE, default=False): bool}
)
return self.async_show_form(
step_id="apps",
data_schema=vol.Schema(data_schema),
data_schema=data_schema,
description_placeholders={
"app_id": f"`{app_id}`" if app_id != APPS_NEW_ID else "",
},
)
async def async_step_rules(self, user_input=None, rule_id=None):
async def async_step_rules(
self, user_input: dict[str, Any] | None = None, rule_id: str | None = None
) -> FlowResult:
"""Handle options flow for detection rules."""
if rule_id is not None:
self._conf_rule_id = rule_id if rule_id != RULES_NEW_ID else None
@ -308,21 +327,26 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
return await self.async_step_init()
@callback
def _async_rules_form(self, rule_id, default_id="", errors=None):
def _async_rules_form(
self, rule_id: str, default_id: str = "", errors: dict[str, str] | None = None
) -> FlowResult:
"""Return configuration form for detection rules."""
state_det_rule = self._state_det_rules.get(rule_id)
str_det_rule = json.dumps(state_det_rule) if state_det_rule else ""
data_schema = {}
rule_schema = {vol.Optional(CONF_RULE_VALUES, default=str_det_rule): str}
if rule_id == RULES_NEW_ID:
data_schema[vol.Optional(CONF_RULE_ID, default=default_id)] = str
data_schema[vol.Optional(CONF_RULE_VALUES, default=str_det_rule)] = str
if rule_id != RULES_NEW_ID:
data_schema[vol.Optional(CONF_RULE_DELETE, default=False)] = bool
data_schema = vol.Schema(
{vol.Optional(CONF_RULE_ID, default=default_id): str, **rule_schema}
)
else:
data_schema = vol.Schema(
{**rule_schema, vol.Optional(CONF_RULE_DELETE, default=False): bool}
)
return self.async_show_form(
step_id="rules",
data_schema=vol.Schema(data_schema),
data_schema=data_schema,
description_placeholders={
"rule_id": f"`{rule_id}`" if rule_id != RULES_NEW_ID else "",
},
@ -330,7 +354,7 @@ class OptionsFlowHandler(config_entries.OptionsFlow):
)
def _validate_state_det_rules(state_det_rules):
def _validate_state_det_rules(state_det_rules: str) -> list[Any] | None:
"""Validate a string that contain state detection rules and return a dict."""
try:
json_rules = json.loads(state_det_rules)