Add mypy check, add missing types and fix type issues

Author: Andre0512

.github/workflows/python_check.yml

@@ -24,12 +24,17 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        python -m pip install flake8 pylint black
+        python -m pip install -r requirements.txt
+        python -m pip install -r requirements_dev.txt
     - name: Lint with flake8
       run: |
         # stop the build if there are Python syntax errors or undefined names
         flake8 . --count --select=E9,F63,F7,F82 --show-source --statistics
         flake8 . --count --exit-zero --max-complexity=10 --max-line-length=88 --statistics
+    - name: Type check with mypy
+      run: |
+        touch "$(python -c 'import inspect, homeassistant, os; print(os.path.dirname(inspect.getfile(homeassistant)))')"/py.typed
+        mypy -p custom_components.hon
     # - name: Analysing the code with pylint
     #   run: |
     #     pylint --max-line-length 88 $(git ls-files '*.py')

custom_components/hon/__init__.py

@@ -1,7 +1,7 @@
 import logging
 from pathlib import Path
 
-import voluptuous as vol
+import voluptuous as vol  # type: ignore[import]
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_EMAIL, CONF_PASSWORD
 from homeassistant.helpers import config_validation as cv, aiohttp_client
@@ -25,13 +25,15 @@
 )
 
 
-async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry):
+async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry) -> None:
     session = aiohttp_client.async_get_clientsession(hass)
+    if (config_dir := hass.config.config_dir) is None:
+        raise ValueError("Missing Config Dir")
     hon = await Hon(
         entry.data["email"],
         entry.data["password"],
         session=session,
-        test_data_path=Path(hass.config.config_dir),
+        test_data_path=Path(config_dir),
     ).create()
     hass.data.setdefault(DOMAIN, {})
     hass.data[DOMAIN][entry.unique_id] = hon
@@ -41,10 +43,10 @@ async def async_setup_entry(hass: HomeAssistantType, entry: ConfigEntry):
         hass.async_create_task(
             hass.config_entries.async_forward_entry_setup(entry, platform)
         )
-    return True
+    return
 
 
-async def async_unload_entry(hass, entry: ConfigEntry) -> bool:
+async def async_unload_entry(hass: HomeAssistantType, entry: ConfigEntry) -> bool:
     unload = await hass.config_entries.async_unload_platforms(entry, PLATFORMS)
     if unload:
         if not hass.data[DOMAIN]:

custom_components/hon/binary_sensor.py

@@ -8,6 +8,8 @@
 )
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.core import callback
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.typing import HomeAssistantType
 
 from .const import DOMAIN
 from .hon import HonEntity, unique_entities
@@ -287,7 +289,9 @@ class HonBinarySensorEntityDescription(BinarySensorEntityDescription):
 BINARY_SENSORS["WD"] = unique_entities(BINARY_SENSORS["WM"], BINARY_SENSORS["TD"])
 
 
-async def async_setup_entry(hass, entry: ConfigEntry, async_add_entities) -> None:
+async def async_setup_entry(
+    hass: HomeAssistantType, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
+) -> None:
     entities = []
     for device in hass.data[DOMAIN][entry.unique_id].appliances:
         for description in BINARY_SENSORS.get(device.appliance_type, []):
@@ -304,13 +308,13 @@ class HonBinarySensorEntity(HonEntity, BinarySensorEntity):
 
     @property
     def is_on(self) -> bool:
-        return (
+        return bool(
             self._device.get(self.entity_description.key, "")
             == self.entity_description.on_value
         )
 
     @callback
-    def _handle_coordinator_update(self, update=True) -> None:
+    def _handle_coordinator_update(self, update: bool = True) -> None:
         self._attr_native_value = (
             self._device.get(self.entity_description.key, "")
             == self.entity_description.on_value

custom_components/hon/button.py

@@ -5,10 +5,13 @@
 from homeassistant.components.button import ButtonEntityDescription, ButtonEntity
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.helpers.entity import EntityCategory
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
+from homeassistant.helpers.typing import HomeAssistantType
 from pyhon.appliance import HonAppliance
 
 from .const import DOMAIN
 from .hon import HonEntity
+from .typedefs import HonButtonType
 
 _LOGGER = logging.getLogger(__name__)
 
@@ -38,8 +41,10 @@
 }
 
 
-async def async_setup_entry(hass, entry: ConfigEntry, async_add_entities) -> None:
-    entities = []
+async def async_setup_entry(
+    hass: HomeAssistantType, entry: ConfigEntry, async_add_entities: AddEntitiesCallback
+) -> None:
+    entities: list[HonButtonType] = []
     for device in hass.data[DOMAIN][entry.unique_id].appliances:
         for description in BUTTONS.get(device.appliance_type, []):
             if not device.commands.get(description.key):
@@ -70,7 +75,9 @@ def available(self) -> bool:
 
 
 class HonDeviceInfo(HonEntity, ButtonEntity):
-    def __init__(self, hass, entry, device: HonAppliance) -> None:
+    def __init__(
+        self, hass: HomeAssistantType, entry: ConfigEntry, device: HonAppliance
+    ) -> None:
         super().__init__(hass, entry, device)
 
         self._attr_unique_id = f"{super().unique_id}_show_device_info"
@@ -93,7 +100,9 @@ async def async_press(self) -> None:
 
 
 class HonDataArchive(HonEntity, ButtonEntity):
-    def __init__(self, hass, entry, device: HonAppliance) -> None:
+    def __init__(
+        self, hass: HomeAssistantType, entry: ConfigEntry, device: HonAppliance
+    ) -> None:
         super().__init__(hass, entry, device)
 
         self._attr_unique_id = f"{super().unique_id}_create_data_archive"
@@ -104,7 +113,9 @@ def __init__(self, hass, entry, device: HonAppliance) -> None:
             self._attr_entity_registry_enabled_default = False
 
     async def async_press(self) -> None:
-        path = Path(self._hass.config.config_dir) / "www"
+        if (config_dir := self._hass.config.config_dir) is None:
+            raise ValueError("Missing Config Dir")
+        path = Path(config_dir) / "www"
         data = await self._device.data_archive(path)
         title = f"{self._device.nick_name} Data Archive"
         text = (