platypush/platypush
platypush
/
platypush
2
2
Fork 4
Code Issues 46 Pull Requests Packages Projects 4 Releases Wiki Activity

LINT fixes on zigbee.mqtt plugin

This commit is contained in:
Fabio Manganiello 2022-10-29 14:09:44 +02:00
parent d61b053f72
commit 42651e937b
Signed by: blacklight
GPG Key ID: D90FBA7F76362774
1 changed files with 56 additions and 49 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

105
platypush/plugins/zigbee/mqtt/__init__.py
View File

@ -5,6 +5,7 @@ from queue import Queue
from typing import Optional, List, Any, Dict, Union from typing import Optional, List, Any, Dict, Union
from platypush.entities import manages from platypush.entities import manages
from platypush.entities.batteries import Battery
from platypush.entities.lights import Light from platypush.entities.lights import Light
from platypush.entities.switches import Switch from platypush.entities.switches import Switch
from platypush.message import Mapping from platypush.message import Mapping
@ -12,7 +13,7 @@ from platypush.message.response import Response
from platypush.plugins.mqtt import MqttPlugin, action from platypush.plugins.mqtt import MqttPlugin, action
@manages(Light, Switch) @manages(Light, Switch, Battery)
class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init] class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
""" """
This plugin allows you to interact with Zigbee devices over MQTT through any Zigbee sniffer and This plugin allows you to interact with Zigbee devices over MQTT through any Zigbee sniffer and
@ -246,7 +247,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
return super().transform_entities(compatible_entities) # type: ignore return super().transform_entities(compatible_entities) # type: ignore
def _get_network_info(self, **kwargs): def _get_network_info(self, **kwargs) -> dict:
self.logger.info('Fetching Zigbee network information') self.logger.info('Fetching Zigbee network information')
client = None client = None
mqtt_args = self._mqtt_args(**kwargs) mqtt_args = self._mqtt_args(**kwargs)
@ -308,28 +309,30 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
} }
self.logger.info('Zigbee network configuration updated') self.logger.info('Zigbee network configuration updated')
return info
finally: finally:
try: try:
client.loop_stop() if client:
client.disconnect() client.loop_stop()
client.disconnect()
except Exception as e: except Exception as e:
self.logger.warning( self.logger.warning(
'Error on MQTT client disconnection: {}'.format(str(e)) 'Error on MQTT client disconnection: {}'.format(str(e))
) )
return info
def _topic(self, topic): def _topic(self, topic):
return self.base_topic + '/' + topic return self.base_topic + '/' + topic
@staticmethod @staticmethod
def _parse_response(response: Union[dict, Response]) -> dict: def _parse_response(response: Union[dict, Response]) -> dict:
if isinstance(response, Response): if isinstance(response, Response):
response = response.output response = response.output # type: ignore[reportGeneralTypeIssues]
assert response.get('status') != 'error', response.get( assert response.get('status') != 'error', response.get( # type: ignore[reportGeneralTypeIssues]
'error', 'zigbee2mqtt error' 'error', 'zigbee2mqtt error'
) )
return response return response # type: ignore[reportGeneralTypeIssues]
@action @action
def devices(self, **kwargs) -> List[Dict[str, Any]]: def devices(self, **kwargs) -> List[Dict[str, Any]]:
@ -503,7 +506,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
] ]
""" """
return self._get_network_info(**kwargs).get('devices') return self._get_network_info(**kwargs).get('devices', {})
@action @action
def permit_join( def permit_join(
@ -520,12 +523,13 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
""" """
if timeout: if timeout:
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/permit_join'), topic=self._topic('bridge/request/permit_join'),
msg={'value': permit, 'time': timeout}, msg={'value': permit, 'time': timeout},
reply_topic=self._topic('bridge/response/permit_join'), reply_topic=self._topic('bridge/response/permit_join'),
**self._mqtt_args(**kwargs), **self._mqtt_args(**kwargs),
) )
or {}
) )
return self.publish( return self.publish(
@ -560,7 +564,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/config/log_level'), topic=self._topic('bridge/request/config/log_level'),
msg={'value': level}, msg={'value': level},
reply_topic=self._topic('bridge/response/config/log_level'), reply_topic=self._topic('bridge/response/config/log_level'),
@ -580,7 +584,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/options'), topic=self._topic('bridge/request/device/options'),
reply_topic=self._topic('bridge/response/device/options'), reply_topic=self._topic('bridge/response/device/options'),
msg={ msg={
@ -606,7 +610,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/remove'), topic=self._topic('bridge/request/device/remove'),
msg={'id': device, 'force': force}, msg={'id': device, 'force': force},
reply_topic=self._topic('bridge/response/device/remove'), reply_topic=self._topic('bridge/response/device/remove'),
@ -624,7 +628,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/ban'), topic=self._topic('bridge/request/device/ban'),
reply_topic=self._topic('bridge/response/device/ban'), reply_topic=self._topic('bridge/response/device/ban'),
msg={'id': device}, msg={'id': device},
@ -643,7 +647,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/whitelist'), topic=self._topic('bridge/request/device/whitelist'),
reply_topic=self._topic('bridge/response/device/whitelist'), reply_topic=self._topic('bridge/response/device/whitelist'),
msg={'id': device}, msg={'id': device},
@ -666,8 +670,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
self.logger.info('Old and new name are the same: nothing to do') self.logger.info('Old and new name are the same: nothing to do')
return return
# noinspection PyUnresolvedReferences devices = self.devices().output # type: ignore[reportGeneralTypeIssues]
devices = self.devices().output
assert not [ assert not [
dev for dev in devices if dev.get('friendly_name') == name dev for dev in devices if dev.get('friendly_name') == name
], 'A device named {} already exists on the network'.format(name) ], 'A device named {} already exists on the network'.format(name)
@ -684,7 +687,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
} }
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/rename'), topic=self._topic('bridge/request/device/rename'),
msg=req, msg=req,
reply_topic=self._topic('bridge/response/device/rename'), reply_topic=self._topic('bridge/response/device/rename'),
@ -749,7 +752,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
reply_topic=self._topic(device), reply_topic=self._topic(device),
msg={property: ''}, msg={property: ''},
**kwargs, **kwargs,
).output ).output # type: ignore[reportGeneralTypeIssues]
assert property in properties, f'No such property: {property}' assert property in properties, f'No such property: {property}'
return {property: properties[property]} return {property: properties[property]}
@ -774,7 +777,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
reply_topic=self._topic(device), reply_topic=self._topic(device),
msg=self.build_device_get_request(exposes), msg=self.build_device_get_request(exposes),
**kwargs, **kwargs,
).output ).output # type: ignore[reportGeneralTypeIssues]
if device_info: if device_info:
self.publish_entities( # type: ignore self.publish_entities( # type: ignore
@ -816,13 +819,15 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
kwargs = self._mqtt_args(**kwargs) kwargs = self._mqtt_args(**kwargs)
if not devices: if not devices:
devices = { devices = list(
device['friendly_name'] or device['ieee_address'] {
for device in self.devices(**kwargs).output device['friendly_name'] or device['ieee_address']
} for device in self.devices(**kwargs).output # type: ignore[reportGeneralTypeIssues]
}
)
def worker(device: str, q: Queue): def worker(device: str, q: Queue):
q.put(self.device_get(device, **kwargs).output) q.put(self.device_get(device, **kwargs).output) # type: ignore[reportGeneralTypeIssues]
queues = {} queues = {}
workers = {} workers = {}
@ -888,7 +893,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
reply_topic=self._topic(device), reply_topic=self._topic(device),
msg=msg, msg=msg,
**self._mqtt_args(**kwargs), **self._mqtt_args(**kwargs),
).output ).output # type: ignore[reportGeneralTypeIssues]
if property: if property:
assert property in properties, 'No such property: ' + property assert property in properties, 'No such property: ' + property
@ -917,7 +922,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
""" """
ret = self._parse_response( ret = self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/ota_update/check'), topic=self._topic('bridge/request/device/ota_update/check'),
reply_topic=self._topic('bridge/response/device/ota_update/check'), reply_topic=self._topic('bridge/response/device/ota_update/check'),
msg={'id': device}, msg={'id': device},
@ -941,7 +946,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/ota_update/update'), topic=self._topic('bridge/request/device/ota_update/update'),
reply_topic=self._topic('bridge/response/device/ota_update/update'), reply_topic=self._topic('bridge/response/device/ota_update/update'),
msg={'id': device}, msg={'id': device},
@ -957,7 +962,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
:param kwargs: Extra arguments to be passed to :meth:`platypush.plugins.mqtt.MqttPlugin.publish`` :param kwargs: Extra arguments to be passed to :meth:`platypush.plugins.mqtt.MqttPlugin.publish``
(default: query the default configured device). (default: query the default configured device).
""" """
return self._get_network_info(**kwargs).get('groups') return self._get_network_info(**kwargs).get('groups', [])
@action @action
def info(self, **kwargs) -> dict: def info(self, **kwargs) -> dict:
@ -1113,7 +1118,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
) )
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/group/add'), topic=self._topic('bridge/request/group/add'),
reply_topic=self._topic('bridge/response/group/add'), reply_topic=self._topic('bridge/response/group/add'),
msg=payload, msg=payload,
@ -1142,7 +1147,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
reply_topic=self._topic(group), reply_topic=self._topic(group),
msg=msg, msg=msg,
**self._mqtt_args(**kwargs), **self._mqtt_args(**kwargs),
).output ).output # type: ignore[reportGeneralTypeIssues]
if property: if property:
assert property in properties, 'No such property: ' + property assert property in properties, 'No such property: ' + property
@ -1169,7 +1174,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
reply_topic=self._topic(group), reply_topic=self._topic(group),
msg={property: value}, msg={property: value},
**self._mqtt_args(**kwargs), **self._mqtt_args(**kwargs),
).output ).output # type: ignore[reportGeneralTypeIssues]
if property: if property:
assert property in properties, 'No such property: ' + property assert property in properties, 'No such property: ' + property
@ -1191,14 +1196,17 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
self.logger.info('Old and new name are the same: nothing to do') self.logger.info('Old and new name are the same: nothing to do')
return return
# noinspection PyUnresolvedReferences groups = {
groups = {group.get('friendly_name'): group for group in self.groups().output} group.get('friendly_name'): group
for group in self.groups().output # type: ignore[reportGeneralTypeIssues]
}
assert ( assert (
name not in groups name not in groups
), 'A group named {} already exists on the network'.format(name) ), 'A group named {} already exists on the network'.format(name)
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/group/rename'), topic=self._topic('bridge/request/group/rename'),
reply_topic=self._topic('bridge/response/group/rename'), reply_topic=self._topic('bridge/response/group/rename'),
msg={'from': group, 'to': name} if group else name, msg={'from': group, 'to': name} if group else name,
@ -1216,7 +1224,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/group/remove'), topic=self._topic('bridge/request/group/remove'),
reply_topic=self._topic('bridge/response/group/remove'), reply_topic=self._topic('bridge/response/group/remove'),
msg=name, msg=name,
@ -1235,7 +1243,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/group/members/add'), topic=self._topic('bridge/request/group/members/add'),
reply_topic=self._topic('bridge/response/group/members/add'), reply_topic=self._topic('bridge/response/group/members/add'),
msg={ msg={
@ -1258,7 +1266,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic( topic=self._topic(
'bridge/request/group/members/remove{}'.format( 'bridge/request/group/members/remove{}'.format(
'_all' if device is None else '' '_all' if device is None else ''
@ -1294,7 +1302,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/bind'), topic=self._topic('bridge/request/device/bind'),
reply_topic=self._topic('bridge/response/device/bind'), reply_topic=self._topic('bridge/response/device/bind'),
msg={'from': source, 'to': target}, msg={'from': source, 'to': target},
@ -1315,7 +1323,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
(default: query the default configured device). (default: query the default configured device).
""" """
return self._parse_response( return self._parse_response(
self.publish( self.publish( # type: ignore[reportGeneralTypeIssues]
topic=self._topic('bridge/request/device/unbind'), topic=self._topic('bridge/request/device/unbind'),
reply_topic=self._topic('bridge/response/device/unbind'), reply_topic=self._topic('bridge/response/device/unbind'),
msg={'from': source, 'to': target}, msg={'from': source, 'to': target},
@ -1324,7 +1332,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
) )
@action @action
def on(self, device, *args, **kwargs) -> dict: def on(self, device, *_, **__) -> dict:
""" """
Implements :meth:`platypush.plugins.switch.plugin.SwitchPlugin.on` and turns on a Zigbee device with a writable Implements :meth:`platypush.plugins.switch.plugin.SwitchPlugin.on` and turns on a Zigbee device with a writable
binary property. binary property.
@ -1334,13 +1342,13 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
device = switch_info.get('friendly_name') or switch_info['ieee_address'] device = switch_info.get('friendly_name') or switch_info['ieee_address']
props = self.device_set( props = self.device_set(
device, switch_info['property'], switch_info['value_on'] device, switch_info['property'], switch_info['value_on']
).output ).output # type: ignore[reportGeneralTypeIssues]
return self._properties_to_switch( return self._properties_to_switch(
device=device, props=props, switch_info=switch_info device=device, props=props, switch_info=switch_info
) )
@action @action
def off(self, device, *args, **kwargs) -> dict: def off(self, device, *_, **__) -> dict:
""" """
Implements :meth:`platypush.plugins.switch.plugin.SwitchPlugin.off` and turns off a Zigbee device with a Implements :meth:`platypush.plugins.switch.plugin.SwitchPlugin.off` and turns off a Zigbee device with a
writable binary property. writable binary property.
@ -1350,13 +1358,13 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
device = switch_info.get('friendly_name') or switch_info['ieee_address'] device = switch_info.get('friendly_name') or switch_info['ieee_address']
props = self.device_set( props = self.device_set(
device, switch_info['property'], switch_info['value_off'] device, switch_info['property'], switch_info['value_off']
).output ).output # type: ignore[reportGeneralTypeIssues]
return self._properties_to_switch( return self._properties_to_switch(
device=device, props=props, switch_info=switch_info device=device, props=props, switch_info=switch_info
) )
@action @action
def toggle(self, device, *args, **kwargs) -> dict: def toggle(self, device, *_, **__) -> dict:
""" """
Implements :meth:`platypush.plugins.switch.plugin.SwitchPlugin.toggle` and toggles a Zigbee device with a Implements :meth:`platypush.plugins.switch.plugin.SwitchPlugin.toggle` and toggles a Zigbee device with a
writable binary property. writable binary property.
@ -1366,7 +1374,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
device = switch_info.get('friendly_name') or switch_info['ieee_address'] device = switch_info.get('friendly_name') or switch_info['ieee_address']
props = self.device_set( props = self.device_set(
device, switch_info['property'], switch_info['value_toggle'] device, switch_info['property'], switch_info['value_toggle']
).output ).output # type: ignore[reportGeneralTypeIssues]
return self._properties_to_switch( return self._properties_to_switch(
device=device, props=props, switch_info=switch_info device=device, props=props, switch_info=switch_info
) )
@ -1548,8 +1556,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
return {} return {}
def _get_switches_info(self) -> dict: def _get_switches_info(self) -> dict:
# noinspection PyUnresolvedReferences devices = self.devices().output # type: ignore[reportGeneralTypeIssues]
devices = self.devices().output
switches_info = {} switches_info = {}
for device in devices: for device in devices:
@ -1578,7 +1585,7 @@ class ZigbeeMqttPlugin(MqttPlugin): # lgtm [py/missing-call-to-init]
) )
for name, switch in self.devices_get( for name, switch in self.devices_get(
list(switches_info.keys()) list(switches_info.keys())
).output.items() ).output.items() # type: ignore[reportGeneralTypeIssues]
] ]
@action @action