Styling/typing

Author: CoMPaTech

CHANGELOG.md

@@ -2,7 +2,11 @@
 
 ## Changelog
 
-### DEC 2023 [0.3.0]
+### DEC 2023 [0.3.1 (alpha/beta]
+
+- Released version 0.3
+
+### DEC 2023 [0.3.0 (alpha/beta]
 
 - Introduce Lock and Light switches
 - Fix UnitOf[X] for future HA compatibility (e.g. TEMP_CELSIUS => UnitOfTemperature.CELSIUS)

README.md

@@ -31,6 +31,7 @@ In the current state it retrieves `bike`, `status` and `position` from the API e
 **BETA** There is an early implementation on toggling data on your bike, `light` and `lock` can be adjusted.
 Do note that the switches do not immediately reflect the status (i.e. they will when you toggle them, but switch back quickly).
 After your 'switch' command we do request an API update to check on the status, pending that update the switch might toggle back-n-forth some time.
+The light-switch is called 'Light mode' as depending on your bike type it will switch on/off or between 'dim and bright'.
 
 ## If you want more frequent updates
 

custom_components/stromer/__init__.py

@@ -46,7 +46,7 @@ async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
         hass.config_entries.async_update_entry(entry, unique_id=stromer.bike_id)
 
     # Set up coordinator for fetching data
-    coordinator = StromerDataUpdateCoordinator(hass, stromer, SCAN_INTERVAL)
+    coordinator = StromerDataUpdateCoordinator(hass, stromer, SCAN_INTERVAL)  # type: ignore[arg-type]
     await coordinator.async_config_entry_first_refresh()
 
     # Store coordinator for use in platforms
@@ -73,4 +73,4 @@ async def async_unload_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     if unload_ok := await hass.config_entries.async_unload_platforms(entry, PLATFORMS):
         hass.data[DOMAIN].pop(entry.entry_id)
 
-    return unload_ok
+    return unload_ok  # type: ignore [no-any-return]

custom_components/stromer/binary_sensor.py

@@ -3,20 +3,22 @@
 
 from dataclasses import dataclass
 
-from custom_components.stromer.coordinator import StromerDataUpdateCoordinator
-
 from homeassistant.components.binary_sensor import (
     BinarySensorEntity,
     BinarySensorEntityDescription,
 )
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity import EntityCategory
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
 from .const import DOMAIN, LOGGER
+from .coordinator import StromerDataUpdateCoordinator
 from .entity import StromerEntity
 
 
 @dataclass
-class StromerBinarySensorEntityDescription(BinarySensorEntityDescription):
+class StromerBinarySensorEntityDescription(BinarySensorEntityDescription):  # type: ignore[misc]
     """Describes a Stromer binary sensor entity."""
 
     icon_off: str | None = None
@@ -47,7 +49,7 @@ class StromerBinarySensorEntityDescription(BinarySensorEntityDescription):
 )
 
 
-async def async_setup_entry(hass, config_entry, async_add_entities):
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None:
     """Set up the Stromer sensors from a config entry."""
     coordinator = hass.data[DOMAIN][config_entry.entry_id]
 
@@ -65,7 +67,7 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
     async_add_entities(entities, update_before_add=False)
 
 
-class StromerBinarySensor(StromerEntity, BinarySensorEntity):
+class StromerBinarySensor(StromerEntity, BinarySensorEntity):  # type: ignore[misc]
     """Representation of a Binary Sensor."""
 
     _attr_has_entity_name = True
@@ -92,4 +94,4 @@ def __init__(
     @property
     def is_on(self) -> bool | None:
         """Return true if the binary sensor is on."""
-        return self._coordinator.data.bikedata.get(self._ent)
+        return self._coordinator.data.bikedata.get(self._ent)  # type: ignore[no-any-return]

custom_components/stromer/config_flow.py

@@ -7,6 +7,7 @@
 
 from homeassistant import config_entries
 from homeassistant.const import CONF_PASSWORD, CONF_USERNAME
+from homeassistant.core import HomeAssistant
 from homeassistant.data_entry_flow import FlowResult
 from homeassistant.exceptions import HomeAssistantError
 
@@ -23,7 +24,7 @@
 )
 
 
-async def validate_input(_, data: dict[str, Any]) -> dict[str, Any]:
+async def validate_input(_: HomeAssistant, data: dict[str, Any]) -> dict[str, Any]:
     """Validate the user input allows us to connect."""
     username = data[CONF_USERNAME]
     password = data[CONF_PASSWORD]
@@ -39,7 +40,7 @@ async def validate_input(_, data: dict[str, Any]) -> dict[str, Any]:
     return {"title": stromer.bike_name}
 
 
-class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):
+class ConfigFlow(config_entries.ConfigFlow, domain=DOMAIN):  # type: ignore[call-arg, misc]
     """Handle a config flow for Stromer."""
 
     VERSION = 1
@@ -75,9 +76,9 @@ async def async_step_user(
         )
 
 
-class CannotConnect(HomeAssistantError):
+class CannotConnect(HomeAssistantError):  # type: ignore[misc]
     """Error to indicate we cannot connect."""
 
 
-class InvalidAuth(HomeAssistantError):
+class InvalidAuth(HomeAssistantError):  # type: ignore[misc]
     """Error to indicate there is invalid auth."""

custom_components/stromer/coordinator.py

@@ -17,7 +17,7 @@ class StromerData(NamedTuple):
     bike_name: str
 
 
-class StromerDataUpdateCoordinator(DataUpdateCoordinator[StromerData]):
+class StromerDataUpdateCoordinator(DataUpdateCoordinator[StromerData]):  # type: ignore[misc]
     """Class to manage fetching Stromer data from single endpoint."""
 
     def __init__(self, hass: HomeAssistant, stromer: Stromer, interval: float) -> None:
@@ -45,4 +45,4 @@ async def _async_update_data(self) -> StromerData:
             raise UpdateFailed(f"Error communicating with API: {err}") from err
         except Exception as err:
             raise ConfigEntryAuthFailed from err
-        return StromerData(*data)
+        return StromerData(*data)  # type: ignore [arg-type]

custom_components/stromer/device_tracker.py

@@ -1,23 +1,25 @@
 """Stromer binary sensor component for Home Assistant."""
 from __future__ import annotations
 
-from custom_components.stromer.coordinator import StromerDataUpdateCoordinator
-
 from homeassistant.components.device_tracker import SourceType, TrackerEntity
+from homeassistant.config_entries import ConfigEntry
+from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity import EntityCategory
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
 from .const import DOMAIN
+from .coordinator import StromerDataUpdateCoordinator
 from .entity import StromerEntity
 
 
-async def async_setup_entry(hass, config_entry, async_add_entities):
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None:
     """Set up the Stromer sensors from a config entry."""
     coordinator = hass.data[DOMAIN][config_entry.entry_id]
 
     async_add_entities([StromerTracker(coordinator)], update_before_add=False)
 
 
-class StromerTracker(StromerEntity, TrackerEntity):
+class StromerTracker(StromerEntity, TrackerEntity):  # type: ignore[misc]
     """Representation of a Device Tracker."""
 
     def __init__(
@@ -43,9 +45,9 @@ def source_type(self) -> SourceType | str:
     @property
     def latitude(self) -> float | None:
         """Return latitude value of the device."""
-        return self._coordinator.data.bikedata.get("latitude")
+        return float(self._coordinator.data.bikedata.get("latitude"))
 
     @property
     def longitude(self) -> float | None:
         """Return longitude value of the device."""
-        return self._coordinator.data.bikedata.get("longitude")
+        return float(self._coordinator.data.bikedata.get("longitude"))

custom_components/stromer/entity.py

@@ -11,7 +11,7 @@
 from .coordinator import StromerData, StromerDataUpdateCoordinator
 
 
-class StromerEntity(CoordinatorEntity[StromerData]):
+class StromerEntity(CoordinatorEntity[StromerData]):  # type:ignore [misc]
     """Represent a Stromer Entity."""
 
     coordinator: StromerDataUpdateCoordinator
@@ -55,12 +55,12 @@ def __init__(
     @property
     def available(self) -> bool:
         """Return if entity is available."""
-        return super().available
+        return super().available  # type: ignore[no-any-return]
 
     @property
     def device(self) -> dict[str, Any]:
         """Return data for this device."""
-        return self.coordinator.data.bike_id
+        return self.coordinator.data.bike_id  # type: ignore[no-any-return]
 
     async def async_added_to_hass(self) -> None:
         """Subscribe to updates."""

custom_components/stromer/manifest.json

@@ -8,5 +8,5 @@
   "iot_class": "cloud_polling",
   "issue_tracker": "https://github.com/CoMPaTech/stromer/issues",
   "requirements": [],
-  "version": "0.3.0b1"
+  "version": "0.3.1"
 }

custom_components/stromer/sensor.py

@@ -2,15 +2,15 @@
 from __future__ import annotations
 
 from datetime import UTC, datetime
-
-from custom_components.stromer.coordinator import StromerDataUpdateCoordinator
+from typing import Any
 
 from homeassistant.components.sensor import (
     SensorDeviceClass,
     SensorEntity,
     SensorEntityDescription,
     SensorStateClass,
 )
+from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import (
     PERCENTAGE,
     UnitOfEnergy,
@@ -20,9 +20,12 @@
     UnitOfTemperature,
     UnitOfTime,
 )
+from homeassistant.core import HomeAssistant
 from homeassistant.helpers.entity import EntityCategory
+from homeassistant.helpers.entity_platform import AddEntitiesCallback
 
 from .const import DOMAIN, LOGGER
+from .coordinator import StromerDataUpdateCoordinator
 from .entity import StromerEntity
 
 SENSORS: tuple[SensorEntityDescription, ...] = (
@@ -169,7 +172,7 @@
 )
 
 
-async def async_setup_entry(hass, config_entry, async_add_entities):
+async def async_setup_entry(hass: HomeAssistant, config_entry: ConfigEntry, async_add_entities: AddEntitiesCallback) -> None:
     """Set up the Stromer sensors from a config entry."""
     coordinator = hass.data[DOMAIN][config_entry.entry_id]
 
@@ -183,7 +186,7 @@ async def async_setup_entry(hass, config_entry, async_add_entities):
     async_add_entities(entities, update_before_add=False)
 
 
-class StromerSensor(StromerEntity, SensorEntity):
+class StromerSensor(StromerEntity, SensorEntity):  # type: ignore[misc]
     """Representation of a Sensor."""
 
     _attr_has_entity_name = True
@@ -220,7 +223,7 @@ def _ensure_timezone(timestamp: datetime | None) -> datetime | None:
         return timestamp
 
     @property
-    def native_value(self):
+    def native_value(self) -> Any:
         """Return the state of the sensor."""
         if self.entity_description.device_class == SensorDeviceClass.TIMESTAMP:
             return self._ensure_timezone(