Skip to content

Commit 27eee24

Browse files
committed
Smile.py: add typing hints for all arguments of methods
1 parent 1843918 commit 27eee24

File tree

1 file changed

+22
-10
lines changed

1 file changed

+22
-10
lines changed

plugwise/smile.py

Lines changed: 22 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -39,7 +39,9 @@
3939
class SmileData(SmileHelper):
4040
"""The Plugwise Smile main class."""
4141

42-
def _append_special(self, d_id, bs_dict, s_dict) -> None:
42+
def _append_special(
43+
self, d_id: str, bs_dict: dict[str, bool], s_dict: dict[str, Any]
44+
) -> None:
4345
"""Helper-function for smile.py: _all_device_data().
4446
When conditions are met, the plugwise_notification binary_sensor is appended.
4547
"""
@@ -106,7 +108,9 @@ def get_all_devices(self) -> None:
106108
# Collect data for each device via helper function
107109
self._all_device_data()
108110

109-
def _device_data_switching_group(self, details, device_data) -> dict[str, bool]:
111+
def _device_data_switching_group(
112+
self, details: dict[str, Any], device_data: dict[str, Any]
113+
) -> dict[str, bool]:
110114
"""Helper-function for _get_device_data().
111115
Determine switching group device data.
112116
"""
@@ -123,7 +127,9 @@ def _device_data_switching_group(self, details, device_data) -> dict[str, bool]:
123127

124128
return device_data
125129

126-
def _device_data_adam(self, details, device_data) -> dict[str, bool]:
130+
def _device_data_adam(
131+
self, details: dict[str, Any], device_data: dict[str, Any]
132+
) -> dict[str, bool]:
127133
"""Helper-function for _get_device_data().
128134
Determine Adam device data.
129135
"""
@@ -137,7 +143,9 @@ def _device_data_adam(self, details, device_data) -> dict[str, bool]:
137143

138144
return device_data
139145

140-
def _device_data_climate(self, details, device_data) -> dict[str, Any]:
146+
def _device_data_climate(
147+
self, details: dict[str, Any], device_data: dict[str, Any]
148+
) -> dict[str, Any]:
141149
"""Helper-function for _get_device_data().
142150
Determine climate-control device data.
143151
"""
@@ -179,7 +187,7 @@ def _device_data_climate(self, details, device_data) -> dict[str, Any]:
179187

180188
return device_data
181189

182-
def _get_device_data(self, dev_id) -> dict[str, Any]:
190+
def _get_device_data(self, dev_id: str) -> dict[str, Any]:
183191
"""Helper-function for _all_device_data() and async_update().
184192
Provide device-data, based on Location ID (= dev_id), from APPLIANCES.
185193
"""
@@ -298,7 +306,9 @@ async def connect(self) -> bool:
298306

299307
return True
300308

301-
async def _smile_detect_legacy(self, result, dsmrmain) -> tuple[str, str]:
309+
async def _smile_detect_legacy(
310+
self, result: etree, dsmrmain: etree
311+
) -> tuple[str, str]:
302312
"""Helper-function for _smile_detect()."""
303313
network = result.find(".//module/protocols/master_controller")
304314

@@ -341,7 +351,7 @@ async def _smile_detect_legacy(self, result, dsmrmain) -> tuple[str, str]:
341351
raise ConnectionFailedError
342352
return model, version
343353

344-
async def _smile_detect(self, result, dsmrmain) -> None:
354+
async def _smile_detect(self, result: etree, dsmrmain: etree) -> None:
345355
"""Helper-function for connect().
346356
Detect which type of Smile is connected.
347357
"""
@@ -463,7 +473,7 @@ async def async_update(self) -> dict[str, Any]:
463473

464474
return [self.gw_data, self.gw_devices]
465475

466-
async def _set_schedule_state_legacy(self, name, status) -> bool:
476+
async def _set_schedule_state_legacy(self, name: str, status: str) -> bool:
467477
"""Helper-function for set_schedule_state()."""
468478
schema_rule_id: str | None = None
469479
for rule in self._domain_objects.findall("rule"):
@@ -524,7 +534,7 @@ async def set_schedule_state(self, loc_id: str, name: str, state: str) -> bool:
524534

525535
return True
526536

527-
async def _set_preset_legacy(self, preset) -> bool:
537+
async def _set_preset_legacy(self, preset: str) -> bool:
528538
"""Set the given Preset on the relevant Thermostat - from DOMAIN_OBJECTS."""
529539
locator = f'rule/directives/when/then[@icon="{preset}"].../.../...'
530540
if (rule := self._domain_objects.find(locator)) is None:
@@ -569,7 +579,9 @@ async def set_temperature(self, loc_id: str, temperature: str) -> bool:
569579
await self._request(uri, method="put", data=data)
570580
return True
571581

572-
async def _set_groupswitch_member_state(self, members, state, switch) -> bool:
582+
async def _set_groupswitch_member_state(
583+
self, members: list[str] | None, state: str, switch: Munch
584+
) -> bool:
573585
"""Helper-function for set_switch_state() .
574586
Set the given State of the relevant Switch within a group of members.
575587
"""

0 commit comments

Comments
 (0)