Type check KNX integration cover (#48046)

homeassistant/components/knx/cover.py

@@ -1,5 +1,10 @@
 """Support for KNX/IP covers."""
-from xknx.devices import Cover as XknxCover
+from __future__ import annotations
+
+from datetime import datetime
+from typing import Any, Callable, Iterable
+
+from xknx.devices import Cover as XknxCover, Device as XknxDevice
 
 from homeassistant.components.cover import (
     ATTR_POSITION,
@@ -17,13 +22,24 @@ from homeassistant.components.cover import (
     CoverEntity,
 )
 from homeassistant.core import callback
+from homeassistant.helpers.entity import Entity
 from homeassistant.helpers.event import async_track_utc_time_change
+from homeassistant.helpers.typing import (
+    ConfigType,
+    DiscoveryInfoType,
+    HomeAssistantType,
+)
 
 from .const import DOMAIN
 from .knx_entity import KnxEntity
 
 
-async def async_setup_platform(hass, config, async_add_entities, discovery_info=None):
+async def async_setup_platform(
+    hass: HomeAssistantType,
+    config: ConfigType,
+    async_add_entities: Callable[[Iterable[Entity]], None],
+    discovery_info: DiscoveryInfoType | None = None,
+) -> None:
     """Set up cover(s) for KNX platform."""
     entities = []
     for device in hass.data[DOMAIN].xknx.devices:
@@ -37,19 +53,20 @@ class KNXCover(KnxEntity, CoverEntity):
 
     def __init__(self, device: XknxCover):
         """Initialize the cover."""
+        self._device: XknxCover
         super().__init__(device)
 
-        self._unsubscribe_auto_updater = None
+        self._unsubscribe_auto_updater: Callable[[], None] | None = None
 
     @callback
-    async def after_update_callback(self, device):
+    async def after_update_callback(self, device: XknxDevice) -> None:
         """Call after device was updated."""
         self.async_write_ha_state()
         if self._device.is_traveling():
             self.start_auto_updater()
 
     @property
-    def device_class(self):
+    def device_class(self) -> str | None:
         """Return the class of this device, from component DEVICE_CLASSES."""
         if self._device.device_class in DEVICE_CLASSES:
             return self._device.device_class
@@ -58,7 +75,7 @@ class KNXCover(KnxEntity, CoverEntity):
         return None
 
     @property
-    def supported_features(self):
+    def supported_features(self) -> int:
         """Flag supported features."""
         supported_features = SUPPORT_OPEN | SUPPORT_CLOSE | SUPPORT_SET_POSITION
         if self._device.supports_stop:
@@ -73,19 +90,17 @@ class KNXCover(KnxEntity, CoverEntity):
         return supported_features
 
     @property
-    def current_cover_position(self):
+    def current_cover_position(self) -> int | None:
         """Return the current position of the cover.
 
         None is unknown, 0 is closed, 100 is fully open.
         """
         # In KNX 0 is open, 100 is closed.
-        try:
+        pos = self._device.current_position()
-            return 100 - self._device.current_position()
+        return 100 - pos if pos is not None else None
-        except TypeError:
-            return None
 
     @property
-    def is_closed(self):
+    def is_closed(self) -> bool | None:
         """Return if the cover is closed."""
         # state shall be "unknown" when xknx travelcalculator is not initialized
         if self._device.current_position() is None:
@@ -93,79 +108,76 @@ class KNXCover(KnxEntity, CoverEntity):
         return self._device.is_closed()
 
     @property
-    def is_opening(self):
+    def is_opening(self) -> bool:
         """Return if the cover is opening or not."""
         return self._device.is_opening()
 
     @property
-    def is_closing(self):
+    def is_closing(self) -> bool:
         """Return if the cover is closing or not."""
         return self._device.is_closing()
 
-    async def async_close_cover(self, **kwargs):
+    async def async_close_cover(self, **kwargs: Any) -> None:
         """Close the cover."""
         await self._device.set_down()
 
-    async def async_open_cover(self, **kwargs):
+    async def async_open_cover(self, **kwargs: Any) -> None:
         """Open the cover."""
         await self._device.set_up()
 
-    async def async_set_cover_position(self, **kwargs):
+    async def async_set_cover_position(self, **kwargs: Any) -> None:
         """Move the cover to a specific position."""
         knx_position = 100 - kwargs[ATTR_POSITION]
         await self._device.set_position(knx_position)
 
-    async def async_stop_cover(self, **kwargs):
+    async def async_stop_cover(self, **kwargs: Any) -> None:
         """Stop the cover."""
         await self._device.stop()
         self.stop_auto_updater()
 
     @property
-    def current_cover_tilt_position(self):
+    def current_cover_tilt_position(self) -> int | None:
         """Return current tilt position of cover."""
         if not self._device.supports_angle:
             return None
-        try:
+        ang = self._device.current_angle()
-            return 100 - self._device.current_angle()
+        return 100 - ang if ang is not None else None
-        except TypeError:
-            return None
 
-    async def async_set_cover_tilt_position(self, **kwargs):
+    async def async_set_cover_tilt_position(self, **kwargs: Any) -> None:
         """Move the cover tilt to a specific position."""
         knx_tilt_position = 100 - kwargs[ATTR_TILT_POSITION]
         await self._device.set_angle(knx_tilt_position)
 
-    async def async_open_cover_tilt(self, **kwargs):
+    async def async_open_cover_tilt(self, **kwargs: Any) -> None:
         """Open the cover tilt."""
         await self._device.set_short_up()
 
-    async def async_close_cover_tilt(self, **kwargs):
+    async def async_close_cover_tilt(self, **kwargs: Any) -> None:
         """Close the cover tilt."""
         await self._device.set_short_down()
 
-    async def async_stop_cover_tilt(self, **kwargs):
+    async def async_stop_cover_tilt(self, **kwargs: Any) -> None:
         """Stop the cover tilt."""
         await self._device.stop()
         self.stop_auto_updater()
 
-    def start_auto_updater(self):
+    def start_auto_updater(self) -> None:
         """Start the autoupdater to update Home Assistant while cover is moving."""
         if self._unsubscribe_auto_updater is None:
             self._unsubscribe_auto_updater = async_track_utc_time_change(
                 self.hass, self.auto_updater_hook
             )
 
-    def stop_auto_updater(self):
+    def stop_auto_updater(self) -> None:
         """Stop the autoupdater."""
         if self._unsubscribe_auto_updater is not None:
             self._unsubscribe_auto_updater()
             self._unsubscribe_auto_updater = None
 
     @callback
-    def auto_updater_hook(self, now):
+    def auto_updater_hook(self, now: datetime) -> None:
         """Call for the autoupdater."""
         self.async_write_ha_state()
         if self._device.position_reached():
+            self.hass.async_create_task(self._device.auto_stop_if_necessary())
             self.stop_auto_updater()
-
-        self.hass.add_job(self._device.auto_stop_if_necessary())