From 3049f820b88c1efc850f85e4a1176b8db0940db2 Mon Sep 17 00:00:00 2001 From: epenet <6771947+epenet@users.noreply.github.com> Date: Fri, 14 Jan 2022 16:43:52 +0100 Subject: [PATCH] Add setup type hints to raspihats (#63988) * Use DOMAIN to store hass.data * Add setup type hints to binary_sensor * Add setup type hints to switch * Adjust callback registration * Revert "Adjust callback registration" This reverts commit 88c179f870536174fca969064789a19ff847f27e. Co-authored-by: epenet --- .../components/raspihats/__init__.py | 6 +++--- .../components/raspihats/binary_sensor.py | 21 +++++++++++++++---- homeassistant/components/raspihats/switch.py | 21 +++++++++++++++---- 3 files changed, 37 insertions(+), 11 deletions(-) diff --git a/homeassistant/components/raspihats/__init__.py b/homeassistant/components/raspihats/__init__.py index 6304c39cc1b..3d28086db43 100644 --- a/homeassistant/components/raspihats/__init__.py +++ b/homeassistant/components/raspihats/__init__.py @@ -40,15 +40,15 @@ def setup(hass: HomeAssistant, config: ConfigType) -> bool: "https://github.com/home-assistant/architecture/blob/master/adr/0019-GPIO.md" ) - hass.data[I2C_HATS_MANAGER] = I2CHatsManager() + hass.data[DOMAIN][I2C_HATS_MANAGER] = I2CHatsManager() def start_i2c_hats_keep_alive(event): """Start I2C-HATs keep alive.""" - hass.data[I2C_HATS_MANAGER].start_keep_alive() + hass.data[DOMAIN][I2C_HATS_MANAGER].start_keep_alive() def stop_i2c_hats_keep_alive(event): """Stop I2C-HATs keep alive.""" - hass.data[I2C_HATS_MANAGER].stop_keep_alive() + hass.data[DOMAIN][I2C_HATS_MANAGER].stop_keep_alive() hass.bus.listen_once(EVENT_HOMEASSISTANT_START, start_i2c_hats_keep_alive) hass.bus.listen_once(EVENT_HOMEASSISTANT_STOP, stop_i2c_hats_keep_alive) diff --git a/homeassistant/components/raspihats/binary_sensor.py b/homeassistant/components/raspihats/binary_sensor.py index ea3130da4ba..f8fbc0d010f 100644 --- a/homeassistant/components/raspihats/binary_sensor.py +++ b/homeassistant/components/raspihats/binary_sensor.py @@ -1,4 +1,6 @@ """Support for raspihats board binary sensors.""" +from __future__ import annotations + import logging import voluptuous as vol @@ -10,7 +12,10 @@ from homeassistant.const import ( CONF_NAME, DEVICE_DEFAULT_NAME, ) +from homeassistant.core import HomeAssistant import homeassistant.helpers.config_validation as cv +from homeassistant.helpers.entity_platform import AddEntitiesCallback +from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from . import ( CONF_BOARD, @@ -18,9 +23,11 @@ from . import ( CONF_I2C_HATS, CONF_INDEX, CONF_INVERT_LOGIC, + DOMAIN, I2C_HAT_NAMES, I2C_HATS_MANAGER, I2CHatsException, + I2CHatsManager, ) _LOGGER = logging.getLogger(__name__) @@ -54,15 +61,21 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend( ) -def setup_platform(hass, config, add_entities, discovery_info=None): +def setup_platform( + hass: HomeAssistant, + config: ConfigType, + add_entities: AddEntitiesCallback, + discovery_info: DiscoveryInfoType | None = None, +) -> None: """Set up the raspihats binary_sensor devices.""" - I2CHatBinarySensor.I2C_HATS_MANAGER = hass.data[I2C_HATS_MANAGER] + I2CHatBinarySensor.I2C_HATS_MANAGER = hass.data[DOMAIN][I2C_HATS_MANAGER] binary_sensors = [] - i2c_hat_configs = config.get(CONF_I2C_HATS) + i2c_hat_configs = config.get(CONF_I2C_HATS, []) for i2c_hat_config in i2c_hat_configs: address = i2c_hat_config[CONF_ADDRESS] board = i2c_hat_config[CONF_BOARD] try: + assert I2CHatBinarySensor.I2C_HATS_MANAGER I2CHatBinarySensor.I2C_HATS_MANAGER.register_board(board, address) for channel_config in i2c_hat_config[CONF_CHANNELS]: binary_sensors.append( @@ -84,7 +97,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None): class I2CHatBinarySensor(BinarySensorEntity): """Representation of a binary sensor that uses a I2C-HAT digital input.""" - I2C_HATS_MANAGER = None + I2C_HATS_MANAGER: I2CHatsManager | None = None def __init__(self, address, channel, name, invert_logic, device_class): """Initialize the raspihats sensor.""" diff --git a/homeassistant/components/raspihats/switch.py b/homeassistant/components/raspihats/switch.py index 98bcb4d0aa8..c67a2b4ab8f 100644 --- a/homeassistant/components/raspihats/switch.py +++ b/homeassistant/components/raspihats/switch.py @@ -1,12 +1,17 @@ """Support for raspihats board switches.""" +from __future__ import annotations + import logging import voluptuous as vol from homeassistant.components.switch import PLATFORM_SCHEMA from homeassistant.const import CONF_ADDRESS, CONF_NAME, DEVICE_DEFAULT_NAME +from homeassistant.core import HomeAssistant import homeassistant.helpers.config_validation as cv from homeassistant.helpers.entity import ToggleEntity +from homeassistant.helpers.entity_platform import AddEntitiesCallback +from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from . import ( CONF_BOARD, @@ -15,9 +20,11 @@ from . import ( CONF_INDEX, CONF_INITIAL_STATE, CONF_INVERT_LOGIC, + DOMAIN, I2C_HAT_NAMES, I2C_HATS_MANAGER, I2CHatsException, + I2CHatsManager, ) _LOGGER = logging.getLogger(__name__) @@ -48,15 +55,21 @@ PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend( ) -def setup_platform(hass, config, add_entities, discovery_info=None): +def setup_platform( + hass: HomeAssistant, + config: ConfigType, + add_entities: AddEntitiesCallback, + discovery_info: DiscoveryInfoType | None = None, +) -> None: """Set up the raspihats switch devices.""" - I2CHatSwitch.I2C_HATS_MANAGER = hass.data[I2C_HATS_MANAGER] + I2CHatSwitch.I2C_HATS_MANAGER = hass.data[DOMAIN][I2C_HATS_MANAGER] switches = [] - i2c_hat_configs = config.get(CONF_I2C_HATS) + i2c_hat_configs = config.get(CONF_I2C_HATS, []) for i2c_hat_config in i2c_hat_configs: board = i2c_hat_config[CONF_BOARD] address = i2c_hat_config[CONF_ADDRESS] try: + assert I2CHatSwitch.I2C_HATS_MANAGER I2CHatSwitch.I2C_HATS_MANAGER.register_board(board, address) for channel_config in i2c_hat_config[CONF_CHANNELS]: switches.append( @@ -79,7 +92,7 @@ def setup_platform(hass, config, add_entities, discovery_info=None): class I2CHatSwitch(ToggleEntity): """Representation a switch that uses a I2C-HAT digital output.""" - I2C_HATS_MANAGER = None + I2C_HATS_MANAGER: I2CHatsManager | None = None def __init__(self, board, address, channel, name, invert_logic, initial_state): """Initialize switch."""