evlli/hass-core
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Switch mqtt to use json helper (#73871)

Browse source 
* Switch mqtt to use json helper

* whitespace
This commit is contained in:
J. Nick Koston 2022-06-23 07:29:09 -05:00 • committed by GitHub
parent 95eeb8eff3
commit 2742bf86e3
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
10 changed files with 34 additions and 36 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

4
homeassistant/components/mqtt/cover.py
View file

@ -2,7 +2,6 @@
from __future__ import annotations from __future__ import annotations
import functools import functools
from json import JSONDecodeError, loads as json_loads
import logging import logging
import voluptuous as vol import voluptuous as vol
@ -29,6 +28,7 @@ from homeassistant.const import (
from homeassistant.core import HomeAssistant, callback from homeassistant.core import HomeAssistant, callback
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.json import JSON_DECODE_EXCEPTIONS, json_loads
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from . import subscription from . import subscription
@ -418,7 +418,7 @@ class MqttCover(MqttEntity, CoverEntity):
try: try:
payload = json_loads(payload) payload = json_loads(payload)
except JSONDecodeError: except JSON_DECODE_EXCEPTIONS:
pass pass
if isinstance(payload, dict): if isinstance(payload, dict):

4
homeassistant/components/mqtt/discovery.py
View file

@ -4,7 +4,6 @@ from __future__ import annotations
import asyncio import asyncio
from collections import deque from collections import deque
import functools import functools
import json
import logging import logging
import re import re
import time import time
@ -17,6 +16,7 @@ from homeassistant.helpers.dispatcher import (
async_dispatcher_connect, async_dispatcher_connect,
async_dispatcher_send, async_dispatcher_send,
) )
from homeassistant.helpers.json import json_loads
from homeassistant.loader import async_get_mqtt from homeassistant.loader import async_get_mqtt
from .. import mqtt from .. import mqtt
@ -117,7 +117,7 @@ async def async_start( # noqa: C901
if payload: if payload:
try: try:
payload = json.loads(payload) payload = json_loads(payload)
except ValueError: except ValueError:
_LOGGER.warning("Unable to parse JSON %s: '%s'", object_id, payload) _LOGGER.warning("Unable to parse JSON %s: '%s'", object_id, payload)
return return

8
homeassistant/components/mqtt/light/schema_json.py
View file

@ -1,6 +1,5 @@
"""Support for MQTT JSON lights.""" """Support for MQTT JSON lights."""
from contextlib import suppress from contextlib import suppress
import json
import logging import logging
import voluptuous as vol import voluptuous as vol
@ -46,6 +45,7 @@ from homeassistant.const import (
) )
from homeassistant.core import callback from homeassistant.core import callback
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.json import json_dumps, json_loads
from homeassistant.helpers.restore_state import RestoreEntity from homeassistant.helpers.restore_state import RestoreEntity
from homeassistant.helpers.typing import ConfigType from homeassistant.helpers.typing import ConfigType
import homeassistant.util.color as color_util import homeassistant.util.color as color_util
@ -317,7 +317,7 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
@log_messages(self.hass, self.entity_id) @log_messages(self.hass, self.entity_id)
def state_received(msg): def state_received(msg):
"""Handle new MQTT messages.""" """Handle new MQTT messages."""
values = json.loads(msg.payload) values = json_loads(msg.payload)
if values["state"] == "ON": if values["state"] == "ON":
self._state = True self._state = True
@ -644,7 +644,7 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
await self.async_publish( await self.async_publish(
self._topic[CONF_COMMAND_TOPIC], self._topic[CONF_COMMAND_TOPIC],
json.dumps(message), json_dumps(message),
self._config[CONF_QOS], self._config[CONF_QOS],
self._config[CONF_RETAIN], self._config[CONF_RETAIN],
self._config[CONF_ENCODING], self._config[CONF_ENCODING],
@ -669,7 +669,7 @@ class MqttLightJson(MqttEntity, LightEntity, RestoreEntity):
await self.async_publish( await self.async_publish(
self._topic[CONF_COMMAND_TOPIC], self._topic[CONF_COMMAND_TOPIC],
json.dumps(message), json_dumps(message),
self._config[CONF_QOS], self._config[CONF_QOS],
self._config[CONF_RETAIN], self._config[CONF_RETAIN],
self._config[CONF_ENCODING], self._config[CONF_ENCODING],

4
homeassistant/components/mqtt/mixins.py
View file

@ -4,7 +4,6 @@ from __future__ import annotations
from abc import abstractmethod from abc import abstractmethod
import asyncio import asyncio
from collections.abc import Callable from collections.abc import Callable
import json
import logging import logging
from typing import Any, Protocol, cast, final from typing import Any, Protocol, cast, final
@ -47,6 +46,7 @@ from homeassistant.helpers.entity import (
async_generate_entity_id, async_generate_entity_id,
) )
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.json import json_loads
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from . import debug_info, subscription from . import debug_info, subscription
@ -393,7 +393,7 @@ class MqttAttributes(Entity):
def attributes_message_received(msg: ReceiveMessage) -> None: def attributes_message_received(msg: ReceiveMessage) -> None:
try: try:
payload = attr_tpl(msg.payload) payload = attr_tpl(msg.payload)
json_dict = json.loads(payload) if isinstance(payload, str) else None json_dict = json_loads(payload) if isinstance(payload, str) else None
if isinstance(json_dict, dict): if isinstance(json_dict, dict):
filtered_dict = { filtered_dict = {
k: v k: v

8
homeassistant/components/mqtt/siren.py
View file

@ -3,7 +3,6 @@ from __future__ import annotations
import copy import copy
import functools import functools
import json
import logging import logging
from typing import Any from typing import Any
@ -32,6 +31,7 @@ from homeassistant.const import (
from homeassistant.core import HomeAssistant, callback from homeassistant.core import HomeAssistant, callback
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.entity_platform import AddEntitiesCallback from homeassistant.helpers.entity_platform import AddEntitiesCallback
from homeassistant.helpers.json import JSON_DECODE_EXCEPTIONS, json_dumps, json_loads
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
from . import subscription from . import subscription
@ -253,13 +253,13 @@ class MqttSiren(MqttEntity, SirenEntity):
json_payload = {STATE: payload} json_payload = {STATE: payload}
else: else:
try: try:
json_payload = json.loads(payload) json_payload = json_loads(payload)
_LOGGER.debug( _LOGGER.debug(
"JSON payload detected after processing payload '%s' on topic %s", "JSON payload detected after processing payload '%s' on topic %s",
json_payload, json_payload,
msg.topic, msg.topic,
) )
except json.decoder.JSONDecodeError: except JSON_DECODE_EXCEPTIONS:
_LOGGER.warning( _LOGGER.warning(
"No valid (JSON) payload detected after processing payload '%s' on topic %s", "No valid (JSON) payload detected after processing payload '%s' on topic %s",
json_payload, json_payload,
@ -344,7 +344,7 @@ class MqttSiren(MqttEntity, SirenEntity):
payload = ( payload = (
self._command_templates[template](value, template_variables) self._command_templates[template](value, template_variables)
if self._command_templates[template] if self._command_templates[template]
else json.dumps(template_variables) else json_dumps(template_variables)
) )
if payload and payload not in PAYLOAD_NONE: if payload and payload not in PAYLOAD_NONE:
await self.async_publish( await self.async_publish(

4
homeassistant/components/mqtt/trigger.py
View file

@ -1,6 +1,5 @@
"""Offer MQTT listening automation rules.""" """Offer MQTT listening automation rules."""
from contextlib import suppress from contextlib import suppress
import json
import logging import logging
import voluptuous as vol import voluptuous as vol
@ -12,6 +11,7 @@ from homeassistant.components.automation import (
from homeassistant.const import CONF_PAYLOAD, CONF_PLATFORM, CONF_VALUE_TEMPLATE from homeassistant.const import CONF_PAYLOAD, CONF_PLATFORM, CONF_VALUE_TEMPLATE
from homeassistant.core import CALLBACK_TYPE, HassJob, HomeAssistant, callback from homeassistant.core import CALLBACK_TYPE, HassJob, HomeAssistant, callback
from homeassistant.helpers import config_validation as cv, template from homeassistant.helpers import config_validation as cv, template
from homeassistant.helpers.json import json_loads
from homeassistant.helpers.typing import ConfigType from homeassistant.helpers.typing import ConfigType
from .. import mqtt from .. import mqtt
@ -89,7 +89,7 @@ async def async_attach_trigger(
} }
with suppress(ValueError): with suppress(ValueError):
data["payload_json"] = json.loads(mqttmsg.payload) data["payload_json"] = json_loads(mqttmsg.payload)
hass.async_run_hass_job(job, {"trigger": data}) hass.async_run_hass_job(job, {"trigger": data})

5
homeassistant/components/mqtt/vacuum/schema_legacy.py
View file

@ -1,6 +1,4 @@
"""Support for Legacy MQTT vacuum.""" """Support for Legacy MQTT vacuum."""
import json
import voluptuous as vol import voluptuous as vol
from homeassistant.components.vacuum import ( from homeassistant.components.vacuum import (
@ -14,6 +12,7 @@ from homeassistant.const import ATTR_SUPPORTED_FEATURES, CONF_NAME
from homeassistant.core import callback from homeassistant.core import callback
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.icon import icon_for_battery_level from homeassistant.helpers.icon import icon_for_battery_level
from homeassistant.helpers.json import json_dumps
from .. import subscription from .. import subscription
from ..config import MQTT_BASE_SCHEMA from ..config import MQTT_BASE_SCHEMA
@ -511,7 +510,7 @@ class MqttVacuum(MqttEntity, VacuumEntity):
if params: if params:
message = {"command": command} message = {"command": command}
message.update(params) message.update(params)
message = json.dumps(message) message = json_dumps(message)
else: else:
message = command message = command
await self.async_publish( await self.async_publish(

7
homeassistant/components/mqtt/vacuum/schema_state.py
View file

@ -1,6 +1,4 @@
"""Support for a State MQTT vacuum.""" """Support for a State MQTT vacuum."""
import json
import voluptuous as vol import voluptuous as vol
from homeassistant.components.vacuum import ( from homeassistant.components.vacuum import (
@ -21,6 +19,7 @@ from homeassistant.const import (
) )
from homeassistant.core import callback from homeassistant.core import callback
import homeassistant.helpers.config_validation as cv import homeassistant.helpers.config_validation as cv
from homeassistant.helpers.json import json_dumps, json_loads
from .. import subscription from .. import subscription
from ..config import MQTT_BASE_SCHEMA from ..config import MQTT_BASE_SCHEMA
@ -203,7 +202,7 @@ class MqttStateVacuum(MqttEntity, StateVacuumEntity):
@log_messages(self.hass, self.entity_id) @log_messages(self.hass, self.entity_id)
def state_message_received(msg): def state_message_received(msg):
"""Handle state MQTT message.""" """Handle state MQTT message."""
payload = json.loads(msg.payload) payload = json_loads(msg.payload)
if STATE in payload and ( if STATE in payload and (
payload[STATE] in POSSIBLE_STATES or payload[STATE] is None payload[STATE] in POSSIBLE_STATES or payload[STATE] is None
): ):
@ -347,7 +346,7 @@ class MqttStateVacuum(MqttEntity, StateVacuumEntity):
if params: if params:
message = {"command": command} message = {"command": command}
message.update(params) message.update(params)
message = json.dumps(message) message = json_dumps(message)
else: else:
message = command message = command
await self.async_publish( await self.async_publish(

16
tests/components/mqtt/test_light_json.py
View file

@ -688,7 +688,7 @@ async def test_sending_mqtt_commands_and_optimistic(
await common.async_turn_on(hass, "light.test") await common.async_turn_on(hass, "light.test")
mqtt_mock.async_publish.assert_called_once_with( mqtt_mock.async_publish.assert_called_once_with(
"test_light_rgb/set", '{"state": "ON"}', 2, False "test_light_rgb/set", '{"state":"ON"}', 2, False
) )
mqtt_mock.async_publish.reset_mock() mqtt_mock.async_publish.reset_mock()
state = hass.states.get("light.test") state = hass.states.get("light.test")
@ -709,7 +709,7 @@ async def test_sending_mqtt_commands_and_optimistic(
await common.async_turn_off(hass, "light.test") await common.async_turn_off(hass, "light.test")
mqtt_mock.async_publish.assert_called_once_with( mqtt_mock.async_publish.assert_called_once_with(
"test_light_rgb/set", '{"state": "OFF"}', 2, False "test_light_rgb/set", '{"state":"OFF"}', 2, False
) )
mqtt_mock.async_publish.reset_mock() mqtt_mock.async_publish.reset_mock()
state = hass.states.get("light.test") state = hass.states.get("light.test")
@ -838,7 +838,7 @@ async def test_sending_mqtt_commands_and_optimistic2(
# Turn the light on # Turn the light on
await common.async_turn_on(hass, "light.test") await common.async_turn_on(hass, "light.test")
mqtt_mock.async_publish.assert_called_once_with( mqtt_mock.async_publish.assert_called_once_with(
"test_light_rgb/set", '{"state": "ON"}', 2, False "test_light_rgb/set", '{"state":"ON"}', 2, False
) )
mqtt_mock.async_publish.reset_mock() mqtt_mock.async_publish.reset_mock()
state = hass.states.get("light.test") state = hass.states.get("light.test")
@ -848,7 +848,7 @@ async def test_sending_mqtt_commands_and_optimistic2(
await common.async_turn_on(hass, "light.test", color_temp=90) await common.async_turn_on(hass, "light.test", color_temp=90)
mqtt_mock.async_publish.assert_called_once_with( mqtt_mock.async_publish.assert_called_once_with(
"test_light_rgb/set", "test_light_rgb/set",
JsonValidator('{"state": "ON", "color_temp": 90}'), JsonValidator('{"state":"ON","color_temp":90}'),
2, 2,
False, False,
) )
@ -859,7 +859,7 @@ async def test_sending_mqtt_commands_and_optimistic2(
# Turn the light off # Turn the light off
await common.async_turn_off(hass, "light.test") await common.async_turn_off(hass, "light.test")
mqtt_mock.async_publish.assert_called_once_with( mqtt_mock.async_publish.assert_called_once_with(
"test_light_rgb/set", '{"state": "OFF"}', 2, False "test_light_rgb/set", '{"state":"OFF"}', 2, False
) )
mqtt_mock.async_publish.reset_mock() mqtt_mock.async_publish.reset_mock()
state = hass.states.get("light.test") state = hass.states.get("light.test")
@ -2004,7 +2004,7 @@ async def test_entity_debug_info_message(hass, mqtt_mock_entry_no_yaml_config):
light.DOMAIN, light.DOMAIN,
DEFAULT_CONFIG, DEFAULT_CONFIG,
light.SERVICE_TURN_ON, light.SERVICE_TURN_ON,
command_payload='{"state": "ON"}', command_payload='{"state":"ON"}',
state_payload='{"state":"ON"}', state_payload='{"state":"ON"}',
) )
@ -2038,7 +2038,7 @@ async def test_max_mireds(hass, mqtt_mock_entry_with_yaml_config):
light.SERVICE_TURN_ON, light.SERVICE_TURN_ON,
"command_topic", "command_topic",
None, None,
'{"state": "ON"}', '{"state":"ON"}',
None, None,
None, None,
None, None,
@ -2047,7 +2047,7 @@ async def test_max_mireds(hass, mqtt_mock_entry_with_yaml_config):
light.SERVICE_TURN_OFF, light.SERVICE_TURN_OFF,
"command_topic", "command_topic",
None, None,
'{"state": "OFF"}', '{"state":"OFF"}',
None, None,
None, None,
None, None,

10
tests/components/mqtt/test_siren.py
View file

@ -140,7 +140,7 @@ async def test_sending_mqtt_commands_and_optimistic(
await async_turn_on(hass, entity_id="siren.test") await async_turn_on(hass, entity_id="siren.test")
mqtt_mock.async_publish.assert_called_once_with( mqtt_mock.async_publish.assert_called_once_with(
"command-topic", '{"state": "beer on"}', 2, False "command-topic", '{"state":"beer on"}', 2, False
) )
mqtt_mock.async_publish.reset_mock() mqtt_mock.async_publish.reset_mock()
state = hass.states.get("siren.test") state = hass.states.get("siren.test")
@ -149,7 +149,7 @@ async def test_sending_mqtt_commands_and_optimistic(
await async_turn_off(hass, entity_id="siren.test") await async_turn_off(hass, entity_id="siren.test")
mqtt_mock.async_publish.assert_called_once_with( mqtt_mock.async_publish.assert_called_once_with(
"command-topic", '{"state": "beer off"}', 2, False "command-topic", '{"state":"beer off"}', 2, False
) )
state = hass.states.get("siren.test") state = hass.states.get("siren.test")
assert state.state == STATE_OFF assert state.state == STATE_OFF
@ -870,7 +870,7 @@ async def test_entity_debug_info_message(hass, mqtt_mock_entry_no_yaml_config):
siren.DOMAIN, siren.DOMAIN,
DEFAULT_CONFIG, DEFAULT_CONFIG,
siren.SERVICE_TURN_ON, siren.SERVICE_TURN_ON,
command_payload='{"state": "ON"}', command_payload='{"state":"ON"}',
) )
@ -881,14 +881,14 @@ async def test_entity_debug_info_message(hass, mqtt_mock_entry_no_yaml_config):
siren.SERVICE_TURN_ON, siren.SERVICE_TURN_ON,
"command_topic", "command_topic",
None, None,
'{"state": "ON"}', '{"state":"ON"}',
None, None,
), ),
( (
siren.SERVICE_TURN_OFF, siren.SERVICE_TURN_OFF,
"command_topic", "command_topic",
None, None,
'{"state": "OFF"}', '{"state":"OFF"}',
None, None,
), ),
], ],