chore: refactor to reduce complexity and LOC

Author: bramstroker

custom_components/powercalc/__init__.py

@@ -335,13 +335,7 @@ async def _reload_config(_: ServiceCall) -> None:
         if DOMAIN in reload_config:
             for sensor_config in reload_config[DOMAIN].get(CONF_SENSORS, []):
                 sensor_config.update({DISCOVERY_TYPE: PowercalcDiscoveryType.USER_YAML})
-                await async_load_platform(
-                    hass,
-                    Platform.SENSOR,
-                    DOMAIN,
-                    sensor_config,
-                    reload_config,
-                )
+                await _async_load_yaml_sensor(hass, sensor_config, reload_config)
 
         # Reload all config entries
         for entry in hass.config_entries.async_entries(DOMAIN):
@@ -426,15 +420,7 @@ async def _load_secondary_sensors(_: None) -> None:
         """Load secondary sensors after primary sensors."""
         await asyncio.gather(
             *(
-                hass.async_create_task(
-                    async_load_platform(
-                        hass,
-                        Platform.SENSOR,
-                        DOMAIN,
-                        sensor_config,
-                        config,
-                    ),
-                )
+                hass.async_create_task(_async_load_yaml_sensor(hass, sensor_config, config))
                 for sensor_config in secondary_sensors
             ),
         )
@@ -443,20 +429,16 @@ async def _load_secondary_sensors(_: None) -> None:
 
     await asyncio.gather(
         *(
-            hass.async_create_task(
-                async_load_platform(
-                    hass,
-                    Platform.SENSOR,
-                    DOMAIN,
-                    sensor_config,
-                    config,
-                ),
-            )
+            hass.async_create_task(_async_load_yaml_sensor(hass, sensor_config, config))
             for sensor_config in primary_sensors
         ),
     )
 
 
+async def _async_load_yaml_sensor(hass: HomeAssistant, sensor_config: ConfigType, config: ConfigType) -> None:
+    await async_load_platform(hass, Platform.SENSOR, DOMAIN, sensor_config, config)
+
+
 async def async_setup_entry(hass: HomeAssistant, entry: ConfigEntry) -> bool:
     """Set up Powercalc integration from a config entry."""
 

custom_components/powercalc/configuration/config_entry_conversion.py

@@ -2,9 +2,7 @@
 
 from __future__ import annotations
 
-import copy
 from datetime import timedelta
-from typing import Any
 
 from homeassistant.config_entries import ConfigEntry
 from homeassistant.const import CONF_ENTITY_ID, CONF_NAME
@@ -35,96 +33,57 @@
 )
 
 
-def convert_config_entry_to_sensor_config(config_entry: ConfigEntry, hass: HomeAssistant) -> ConfigType:  # noqa: C901
-    """Convert the config entry structure to the sensor config used to create the entities."""
-    sensor_config = dict(config_entry.data.copy())
-    sensor_type = sensor_config.get(CONF_SENSOR_TYPE)
+def _convert_template(config: ConfigType, source_key: str, target_key: str, hass: HomeAssistant) -> None:
+    if source_key in config:
+        config[target_key] = Template(config.pop(source_key), hass)
 
-    def handle_sensor_type() -> None:
-        """Handle sensor type-specific configuration."""
-        if sensor_type == SensorType.GROUP:
-            sensor_config[CONF_CREATE_GROUP] = sensor_config.get(CONF_NAME)
-        elif sensor_type == SensorType.REAL_POWER:
-            sensor_config[CONF_POWER_SENSOR_ID] = sensor_config.get(CONF_ENTITY_ID)
-            sensor_config[CONF_FORCE_ENERGY_SENSOR_CREATION] = True
 
-    def process_template(config: dict[str, Any], template_key: str, target_key: str) -> None:
-        """Convert a template key in the config to a Template object."""
-        if template_key in config:
-            config[target_key] = Template(config[template_key], hass)
-            del config[template_key]
-
-    def process_on_time(config: dict[str, Any]) -> None:
-        """Convert on_time dictionary to timedelta."""
-        on_time = config.get(CONF_ON_TIME)
-        config[CONF_ON_TIME] = (
+def convert_config_entry_to_sensor_config(config_entry: ConfigEntry, hass: HomeAssistant) -> ConfigType:
+    """Convert the config entry structure to the sensor config used to create the entities."""
+    sensor_config = dict(config_entry.data)
+    sensor_type = sensor_config.get(CONF_SENSOR_TYPE)
+    if sensor_type == SensorType.GROUP:
+        sensor_config[CONF_CREATE_GROUP] = sensor_config.get(CONF_NAME)
+    elif sensor_type == SensorType.REAL_POWER:
+        sensor_config[CONF_POWER_SENSOR_ID] = sensor_config.get(CONF_ENTITY_ID)
+        sensor_config[CONF_FORCE_ENERGY_SENSOR_CREATION] = True
+
+    if CONF_DAILY_FIXED_ENERGY in sensor_config:
+        daily_fixed_config = dict(sensor_config[CONF_DAILY_FIXED_ENERGY])
+        _convert_template(daily_fixed_config, CONF_VALUE_TEMPLATE, CONF_VALUE, hass)
+        on_time = daily_fixed_config.get(CONF_ON_TIME)
+        daily_fixed_config[CONF_ON_TIME] = (
             timedelta(hours=on_time["hours"], minutes=on_time["minutes"], seconds=on_time["seconds"])
             if on_time
             else timedelta(days=1)
         )
-
-    def process_states_power(states_power: dict[str, Any] | list[dict[str, Any]]) -> dict[str, Any]:
-        """Convert state power values to Template objects where necessary."""
-        return {
-            key: Template(value, hass) if isinstance(value, str) and "{{" in value else value
-            for key, value in normalize_states_power(states_power).items()
-        }
-
-    def process_daily_fixed_energy() -> None:
-        """Process daily fixed energy configuration."""
-        if CONF_DAILY_FIXED_ENERGY not in sensor_config:
-            return
-
-        daily_fixed_config = copy.copy(sensor_config[CONF_DAILY_FIXED_ENERGY])
-        process_template(daily_fixed_config, CONF_VALUE_TEMPLATE, CONF_VALUE)
-        process_on_time(daily_fixed_config)
         sensor_config[CONF_DAILY_FIXED_ENERGY] = daily_fixed_config
 
-    def process_fixed_config() -> None:
-        """Process fixed energy configuration."""
-        if CONF_FIXED not in sensor_config:
-            return
-
-        fixed_config = copy.copy(sensor_config[CONF_FIXED])
-        process_template(fixed_config, CONF_POWER_TEMPLATE, CONF_POWER)
+    if CONF_FIXED in sensor_config:
+        fixed_config = dict(sensor_config[CONF_FIXED])
+        _convert_template(fixed_config, CONF_POWER_TEMPLATE, CONF_POWER, hass)
         if CONF_STATES_POWER in fixed_config:
-            fixed_config[CONF_STATES_POWER] = process_states_power(fixed_config[CONF_STATES_POWER])
+            fixed_config[CONF_STATES_POWER] = {
+                key: Template(value, hass) if isinstance(value, str) and "{{" in value else value
+                for key, value in normalize_states_power(fixed_config[CONF_STATES_POWER]).items()
+            }
         sensor_config[CONF_FIXED] = fixed_config
 
-    def process_linear_config() -> None:
-        """Process linear energy configuration."""
-        if CONF_LINEAR not in sensor_config:
-            return
-
-        linear_config = copy.copy(sensor_config[CONF_LINEAR])
-        sensor_config[CONF_LINEAR] = linear_config
+    if CONF_LINEAR in sensor_config:
+        sensor_config[CONF_LINEAR] = dict(sensor_config[CONF_LINEAR])
 
-    def process_calculation_enabled_condition() -> None:
-        """Process calculation enabled condition template."""
-        if CONF_CALCULATION_ENABLED_CONDITION in sensor_config:
-            sensor_config[CONF_CALCULATION_ENABLED_CONDITION] = Template(
-                sensor_config[CONF_CALCULATION_ENABLED_CONDITION],
-                hass,
-            )
-
-    def process_utility_meter_offset() -> None:
-        if CONF_UTILITY_METER_OFFSET in sensor_config:
-            sensor_config[CONF_UTILITY_METER_OFFSET] = timedelta(days=sensor_config[CONF_UTILITY_METER_OFFSET])
-
-    def process_playbook_config() -> None:
-        if CONF_PLAYBOOK not in sensor_config:
-            return
-        playbook_config = copy.copy(sensor_config[CONF_PLAYBOOK])
+    if CONF_PLAYBOOK in sensor_config:
+        playbook_config = dict(sensor_config[CONF_PLAYBOOK])
         playbook_config[CONF_PLAYBOOKS] = normalize_playbooks(playbook_config[CONF_PLAYBOOKS])
         sensor_config[CONF_PLAYBOOK] = playbook_config
 
-    handle_sensor_type()
+    if CONF_CALCULATION_ENABLED_CONDITION in sensor_config:
+        sensor_config[CONF_CALCULATION_ENABLED_CONDITION] = Template(
+            sensor_config[CONF_CALCULATION_ENABLED_CONDITION],
+            hass,
+        )
 
-    process_daily_fixed_energy()
-    process_fixed_config()
-    process_linear_config()
-    process_playbook_config()
-    process_calculation_enabled_condition()
-    process_utility_meter_offset()
+    if CONF_UTILITY_METER_OFFSET in sensor_config:
+        sensor_config[CONF_UTILITY_METER_OFFSET] = timedelta(days=sensor_config[CONF_UTILITY_METER_OFFSET])
 
     return sensor_config

custom_components/powercalc/power_profile/sub_profile_selector.py

@@ -53,23 +53,30 @@ def get_tracking_entities(self) -> list[str]:
     def _create_matcher(self, matcher_config: dict) -> SubProfileMatcher:
         """Create a matcher from json config. Can be extended for more matchers in the future."""
         matcher_type: SubProfileMatcherType = matcher_config["type"]
-
-        matcher_classes: dict[SubProfileMatcherType, type[SubProfileMatcher]] = {
-            SubProfileMatcherType.ATTRIBUTE: AttributeMatcher,
-            SubProfileMatcherType.ENTITY_STATE: EntityStateMatcher,
-            SubProfileMatcherType.ENTITY_ID: EntityIdMatcher,
-            SubProfileMatcherType.ENTITY_REGISTRY: EntityRegistryMatcher,
-            SubProfileMatcherType.INTEGRATION: IntegrationMatcher,
-            SubProfileMatcherType.MODEL_ID: ModelIdMatcher,
-        }
-        if matcher_type not in matcher_classes:
-            raise PowercalcSetupError(f"Unknown sub profile matcher type: {matcher_type}")
-
-        return matcher_classes[matcher_type].from_config(
-            matcher_config,
-            hass=self._hass,
-            source_entity=self._source_entity,
-        )
+        match matcher_type:
+            case SubProfileMatcherType.ATTRIBUTE:
+                return AttributeMatcher(matcher_config["attribute"], matcher_config["map"])
+            case SubProfileMatcherType.ENTITY_STATE:
+                return EntityStateMatcher(
+                    self._hass,
+                    self._source_entity,
+                    matcher_config["entity_id"],
+                    matcher_config["map"],
+                )
+            case SubProfileMatcherType.ENTITY_ID:
+                return EntityIdMatcher(matcher_config["pattern"], matcher_config["profile"])
+            case SubProfileMatcherType.ENTITY_REGISTRY:
+                return EntityRegistryMatcher(
+                    matcher_config["property"],
+                    matcher_config["value"],
+                    matcher_config["profile"],
+                )
+            case SubProfileMatcherType.INTEGRATION:
+                return IntegrationMatcher(matcher_config["integration"], matcher_config["profile"])
+            case SubProfileMatcherType.MODEL_ID:
+                return ModelIdMatcher(matcher_config["model_id"], matcher_config["profile"])
+            case _:
+                raise PowercalcSetupError(f"Unknown sub profile matcher type: {matcher_type}")
 
 
 class SubProfileSelectConfig(NamedTuple):
@@ -78,21 +85,12 @@ class SubProfileSelectConfig(NamedTuple):
 
 
 class SubProfileMatcher(Protocol):
-    @classmethod
-    def from_config(
-        cls,
-        config: dict,
-        *,
-        hass: HomeAssistant | None = None,
-        source_entity: SourceEntity | None = None,
-    ) -> SubProfileMatcher:
-        """Create a matcher from a config dict."""
-
     def match(self, entity_state: State, source_entity: SourceEntity) -> str | None:
         """Returns a sub profile."""
 
     def get_tracking_entities(self) -> list[str]:
         """Get extra entities to track for state changes."""
+        return []
 
 
 class EntityStateMatcher(SubProfileMatcher):
@@ -119,17 +117,6 @@ def match(self, entity_state: State, source_entity: SourceEntity) -> str | None:
 
         return self._mapping.get(state.state)
 
-    @classmethod
-    def from_config(
-        cls,
-        config: dict,
-        *,
-        hass: HomeAssistant | None = None,
-        source_entity: SourceEntity | None = None,
-    ) -> EntityStateMatcher:
-        assert hass is not None
-        return cls(hass, source_entity, config["entity_id"], config["map"])
-
     def get_tracking_entities(self) -> list[str]:
         return [self._entity_id]
 
@@ -146,19 +133,6 @@ def match(self, entity_state: State, source_entity: SourceEntity) -> str | None:
 
         return self._mapping.get(val)
 
-    @classmethod
-    def from_config(
-        cls,
-        config: dict,
-        *,
-        hass: HomeAssistant | None = None,
-        source_entity: SourceEntity | None = None,
-    ) -> AttributeMatcher:
-        return cls(config["attribute"], config["map"])
-
-    def get_tracking_entities(self) -> list[str]:
-        return []
-
 
 class EntityIdMatcher(SubProfileMatcher):
     def __init__(self, pattern: str, profile: str) -> None:
@@ -171,19 +145,6 @@ def match(self, entity_state: State, source_entity: SourceEntity) -> str | None:
 
         return None
 
-    @classmethod
-    def from_config(
-        cls,
-        config: dict,
-        *,
-        hass: HomeAssistant | None = None,
-        source_entity: SourceEntity | None = None,
-    ) -> EntityIdMatcher:
-        return cls(config["pattern"], config["profile"])
-
-    def get_tracking_entities(self) -> list[str]:
-        return []
-
 
 class IntegrationMatcher(SubProfileMatcher):
     def __init__(self, integration: str, profile: str) -> None:
@@ -200,19 +161,6 @@ def match(self, entity_state: State, source_entity: SourceEntity) -> str | None:
 
         return None
 
-    @classmethod
-    def from_config(
-        cls,
-        config: dict,
-        *,
-        hass: HomeAssistant | None = None,
-        source_entity: SourceEntity | None = None,
-    ) -> IntegrationMatcher:
-        return cls(config["integration"], config["profile"])
-
-    def get_tracking_entities(self) -> list[str]:
-        return []
-
 
 class EntityRegistryMatcher(SubProfileMatcher):
     def __init__(self, property_name: str, value: object, profile: str) -> None:
@@ -234,19 +182,6 @@ def match(self, entity_state: State, source_entity: SourceEntity) -> str | None:
 
         return None
 
-    @classmethod
-    def from_config(
-        cls,
-        config: dict,
-        *,
-        hass: HomeAssistant | None = None,
-        source_entity: SourceEntity | None = None,
-    ) -> EntityRegistryMatcher:
-        return cls(config["property"], config["value"], config["profile"])
-
-    def get_tracking_entities(self) -> list[str]:
-        return []
-
     def _matches_registry_value(self, registry_value: object) -> bool:
         if registry_value == self._value:
             return True
@@ -271,16 +206,3 @@ def match(self, entity_state: State, source_entity: SourceEntity) -> str | None:
             return self._profile
 
         return None
-
-    @classmethod
-    def from_config(
-        cls,
-        config: dict,
-        *,
-        hass: HomeAssistant | None = None,
-        source_entity: SourceEntity | None = None,
-    ) -> ModelIdMatcher:
-        return cls(config["model_id"], config["profile"])
-
-    def get_tracking_entities(self) -> list[str]:
-        return []