Fix consumer modules (#3865)

* fix configuration type hints

* fix consumer type hints and errors

* Potential fix for pull request finding

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

---------

Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>

Author: 2 people

packages/modules/consumers/askoma/askoheat/config.py

@@ -10,8 +10,8 @@
 class AskoheatConfiguration:
     def __init__(self,
                  ip_address: Optional[str] = None,
-                 port: Optional[int] = 502,
-                 modbus_id: Optional[int] = 1):
+                 port: int = 502,
+                 modbus_id: int = 1):
         self.ip_address = ip_address
         self.port = port
         self.modbus_id = modbus_id
@@ -23,7 +23,7 @@ def __init__(self,
                  name: str = "Askoheat+",
                  type: str = "askoheat",
                  id: int = 0,
-                 configuration: AskoheatConfiguration = None,
+                 configuration: Optional[AskoheatConfiguration] = None,
                  usage: Tuple[ConsumerUsage, ...] = (ConsumerUsage.SUSPENDABLE_TUNABLE,
                                                      ConsumerUsage.METER_ONLY),
                  **kwargs) -> None:

packages/modules/consumers/askoma/askoheat/consumer.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 import logging
+from typing import Optional
 from modules.common.abstract_device import DeviceDescriptor
 from modules.common.component_state import ConsumerState
 from modules.common.component_type import ComponentType
@@ -12,8 +13,8 @@
 
 
 def create_consumer(config: Askoheat):
-    client = None
-    sim_counter = None
+    client: Optional[ModbusTcpClient_] = None
+    sim_counter: Optional[SimCounterConsumer] = None
 
     def initializer():
         nonlocal client, sim_counter

packages/modules/consumers/avm/avm/config.py

@@ -1,5 +1,4 @@
 from typing import Optional, Tuple
-
 from control.consumer.consumer_data import ConsumerUsage
 from helpermodules.auto_str import auto_str
 from modules.common.consumer_setup import ConsumerSetup
@@ -13,7 +12,7 @@ def __init__(self,
                  username: Optional[str] = None,
                  password: Optional[str] = None,
                  session_id: Optional[str] = None,
-                 session_mtime: Optional[str] = None,
+                 session_mtime: Optional[float] = None,
                  name: Optional[str] = None) -> None:
         self.ip_address = ip_address
         self.username = username
@@ -29,7 +28,7 @@ def __init__(self,
                  name: str = "AVM Fritz!Box",
                  type: str = "avm",
                  id: int = 0,
-                 configuration: AvmConfiguration = None,
+                 configuration: Optional[AvmConfiguration] = None,
                  usage: Tuple[ConsumerUsage, ...] = (ConsumerUsage.SUSPENDABLE_TUNABLE,
                                                      ConsumerUsage.METER_ONLY),
                  **kwargs) -> None:

packages/modules/consumers/avm/avm/consumer.py

@@ -3,6 +3,7 @@
 import logging
 import time
 import xml.etree.ElementTree as ET
+from typing import Optional
 
 from dataclass_utils._dataclass_asdict import asdict
 from helpermodules.pub import Pub
@@ -18,7 +19,7 @@
 
 
 def create_consumer(config: Avm):
-    ain = None  # Actuator Identification Number
+    ain: Optional[str] = None  # Actuator Identification Number
 
     def update() -> ConsumerState:
         nonlocal ain
@@ -61,6 +62,9 @@ def update() -> ConsumerState:
                     state=state,
                     voltages=voltages
                 )
+        raise RuntimeError(
+            f"Device with name '{config.configuration.name}' was not found or is not currently available"
+        )
 
     def ensure_valid_session_id():
         if check_valid_session_id() is False:

packages/modules/consumers/generic/dac/config.py

@@ -11,8 +11,8 @@
 class DacConfiguration:
     def __init__(self,
                  ip_address: Optional[str] = None,
-                 port: Optional[int] = 502,
-                 modbus_id: Optional[int] = 1,
+                 port: int = 502,
+                 modbus_id: int = 1,
                  model: Model = Model.N4Dac02):
         self.ip_address = ip_address
         self.port = port
@@ -26,7 +26,7 @@ def __init__(self,
                  name: str = "Digital-Analog-Konverter (DAC) 0.01V bis 10.0V",
                  type: str = "dac",
                  id: int = 0,
-                 configuration: DacConfiguration = None,
+                 configuration: Optional[DacConfiguration] = None,
                  usage: Tuple[ConsumerUsage, ...] = (ConsumerUsage.SUSPENDABLE_TUNABLE,),
                  **kwargs) -> None:
         super().__init__(name, type, id, vendor=vendor_descriptor.configuration_factory(

packages/modules/consumers/generic/dac/consumer.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 import logging
+from typing import Optional
 from modules.common.abstract_device import DeviceDescriptor
 from modules.common.component_type import ComponentType
 from modules.common.configurable_consumer import ConfigurableConsumer, SetLimitData
@@ -12,8 +13,8 @@
 
 
 def create_consumer(config: Dac):
-    client: ModbusTcpClient_ = None
-    sim_counter = None
+    client: Optional[ModbusTcpClient_] = None
+    sim_counter: Optional[SimCounterConsumer] = None
 
     def initializer():
         nonlocal client, sim_counter
@@ -31,18 +32,18 @@ def set_power_limit(power_limit: float, data: SetLimitData) -> None:
         elif config.configuration.model == Model.DA02:
             client.write_register(0x01f4, power_limit * 4000 / data.max_power, ModbusDataType.INT_16, unit=modbus_id)
         elif config.configuration.model == Model.M120T:
-            #  ausgabe nicht kleiner 0,9V sonst Leistungsregelung der WP aus
+            #  Ausgabe nicht kleiner 0,9V sonst Leistungsregelung der WP aus
             power_limit = max(power_limit * 4095 / data.max_power, 370)
             client.write_register(0x01f4, power_limit, ModbusDataType.INT_16, unit=modbus_id)
         elif config.configuration.model == Model.AA02B:
             power_limit = max((power_limit * (4095-820) / data.max_power)+820, 820)
-            #  ausgabe nicht kleiner 4ma sonst Leistungsregelung der WP aus
+            #  Ausgabe nicht kleiner 4ma sonst Leistungsregelung der WP aus
             client.write_register(0x01f4, power_limit, ModbusDataType.INT_16, unit=modbus_id)
 
     return ConfigurableConsumer(consumer_config=config,
                                 initializer=initializer,
                                 error_handler=error_handler,
-                                set_power_limit=set_power_limit,)
+                                set_power_limit=set_power_limit)
 
 
 device_descriptor = DeviceDescriptor(configuration_factory=Dac)

packages/modules/consumers/generic/http/config.py

@@ -1,5 +1,4 @@
-from typing import Tuple
-
+from typing import Tuple, Optional
 from control.consumer.consumer_data import ConsumerUsage
 from helpermodules.auto_str import auto_str
 from modules.common.consumer_setup import ConsumerSetup
@@ -9,17 +8,17 @@
 @auto_str
 class HttpConfiguration:
     def __init__(self,
-                 url: str = None,
-                 current_l1_path: str = None,
-                 current_l2_path: str = None,
-                 current_l3_path: str = None,
-                 power_path: str = None,
-                 temperatures_path: str = None,
-                 imported_path: str = None,
-                 exported_path: str = None,
-                 switch_on_path: str = None,
-                 switch_off_path: str = None,
-                 set_power_limit_path: str = None):
+                 url: Optional[str] = None,
+                 current_l1_path: Optional[str] = None,
+                 current_l2_path: Optional[str] = None,
+                 current_l3_path: Optional[str] = None,
+                 power_path: Optional[str] = None,
+                 temperatures_path: Optional[str] = None,
+                 imported_path: Optional[str] = None,
+                 exported_path: Optional[str] = None,
+                 switch_on_path: Optional[str] = None,
+                 switch_off_path: Optional[str] = None,
+                 set_power_limit_path: Optional[str] = None):
         self.url = url
         self.current_l1_path = current_l1_path
         self.current_l2_path = current_l2_path
@@ -39,7 +38,7 @@ def __init__(self,
                  name: str = "HTTP-Verbraucher",
                  type: str = "http",
                  id: int = 0,
-                 configuration: HttpConfiguration = None,
+                 configuration: Optional[HttpConfiguration] = None,
                  usage: Tuple[ConsumerUsage, ...] = (ConsumerUsage.METER_ONLY,
                                                      ConsumerUsage.CONTINUOUS,
                                                      ConsumerUsage.SUSPENDABLE_ONOFF,

packages/modules/consumers/generic/http/consumer.py

@@ -1,5 +1,6 @@
 #!/usr/bin/env python3
 import logging
+from typing import Optional, Callable
 
 from modules.common import req
 from modules.common.abstract_device import DeviceDescriptor
@@ -14,16 +15,16 @@
 
 
 def create_consumer(config: Http):
-    session = None
-    sim_counter = None
-    get_power = None
-    get_imported = None
-    get_exported = None
-    get_currents = None
-    get_temperatures = None
-    post_set_power_limit = None
-    post_switch_on = None
-    post_switch_off = None
+    session: Optional[req.CustomSession] = None
+    sim_counter: Optional[SimCounterConsumer] = None
+    get_power: Optional[Callable] = None
+    get_imported: Optional[Callable] = None
+    get_exported: Optional[Callable] = None
+    get_currents: Optional[Callable] = None
+    get_temperatures: Optional[Callable] = None
+    post_set_power_limit: Optional[Callable] = None
+    post_switch_on: Optional[Callable] = None
+    post_switch_off: Optional[Callable] = None
 
     def initializer():
         nonlocal session, sim_counter
@@ -65,15 +66,15 @@ def update() -> None:
 
     def switch_on():
         # Authorization?
-        post_switch_on(session, params={"state": True})
+        post_switch_on(session, {"state": True})
 
     def switch_off():
         # Authorization?
-        post_switch_off(session, params={"state": False})
+        post_switch_off(session, {"state": False})
 
     def set_power_limit(power_limit: float, data: SetLimitData) -> None:
         # Authorization?
-        post_set_power_limit(session, params={"power_limit": power_limit})
+        post_set_power_limit(session, {"power_limit": power_limit})
 
     return ConfigurableConsumer(consumer_config=config,
                                 initializer=initializer,

packages/modules/consumers/generic/json/config.py

@@ -1,4 +1,4 @@
-from typing import Tuple
+from typing import Tuple, Optional
 
 from control.consumer.consumer_data import ConsumerUsage
 from helpermodules.auto_str import auto_str
@@ -9,17 +9,17 @@
 @auto_str
 class JsonConfiguration:
     def __init__(self,
-                 url: str = None,
-                 jq_current_l1: str = None,
-                 jq_current_l2: str = None,
-                 jq_current_l3: str = None,
-                 jq_power: str = None,
-                 jq_temperatures: str = None,
-                 jq_imported: str = None,
-                 jq_exported: str = None,
-                 jq_switch_on: str = None,
-                 jq_switch_off: str = None,
-                 jq_set_power_limit: str = None):
+                 url: Optional[str] = None,
+                 jq_current_l1: Optional[str] = None,
+                 jq_current_l2: Optional[str] = None,
+                 jq_current_l3: Optional[str] = None,
+                 jq_power: Optional[str] = None,
+                 jq_temperatures: Optional[str] = None,
+                 jq_imported: Optional[str] = None,
+                 jq_exported: Optional[str] = None,
+                 jq_switch_on: Optional[str] = None,
+                 jq_switch_off: Optional[str] = None,
+                 jq_set_power_limit: Optional[str] = None):
         self.url = url
         self.jq_currents = (jq_current_l1, jq_current_l2, jq_current_l3)
         self.jq_power = jq_power
@@ -37,7 +37,7 @@ def __init__(self,
                  name: str = "JSON-Verbraucher",
                  type: str = "json",
                  id: int = 0,
-                 configuration: JsonConfiguration = None,
+                 configuration: Optional[JsonConfiguration] = None,
                  usage: Tuple[ConsumerUsage, ...] = (ConsumerUsage.METER_ONLY,
                                                      ConsumerUsage.CONTINUOUS,
                                                      ConsumerUsage.SUSPENDABLE_ONOFF,

packages/modules/consumers/generic/json/consumer.py

@@ -15,8 +15,8 @@
 
 
 def create_consumer(config: Json):
-    session = None
-    sim_counter = None
+    session: Optional[req.CustomSession] = None
+    sim_counter: Optional[SimCounterConsumer] = None
     jq_power = None
     jq_imported = None
     jq_exported = None
@@ -57,7 +57,7 @@ def initializer():
         jq_switch_on = create_post_function(config.configuration.jq_switch_on)
         jq_switch_off = create_post_function(config.configuration.jq_switch_off)
 
-    def update() -> None:
+    def update() -> ConsumerState:
         response = req.get_http_session().get(config.configuration.url, timeout=5).json()
         power = float(jq_power.input(response).first())
         temperatures = float(jq_temperatures.input(response).first()) if jq_temperatures is not None else None