Merge pull request #9 from litinoveweedle/fix_async_track_state_chang…

…e_deprecation move common device json data handling into common class
litinoveweedle · May 20, 2024 · 0cc1ee0 · 0cc1ee0
2 parents ca69b91 + d47bf25
commit 0cc1ee0
Show file tree

Hide file tree

Showing 5 changed files with 136 additions and 164 deletions.
diff --git a/custom_components/smartir/__init__.py b/custom_components/smartir/__init__.py
@@ -1 +1,91 @@
 """The SmartIR component."""
+
+import logging
+import os.path
+import json
+
+_LOGGER = logging.getLogger(__name__)
+
+
+class DeviceData:
+    @staticmethod
+    def load_file(device_code, device_class, required_keys):
+        """Load device JSON file."""
+        device_json_filename = str(device_code) + ".json"
+
+        device_files_subdir = os.path.join("custom_codes", device_class)
+        device_files_absdir = os.path.join(
+            os.path.dirname(os.path.abspath(__file__)), device_files_subdir
+        )
+        if os.path.isdir(device_files_absdir):
+            device_json_path = os.path.join(device_files_absdir, device_json_filename)
+            if os.path.exists(device_json_path):
+                if device_data := DeviceData.check_file(
+                    device_json_filename, device_json_path, required_keys
+                ):
+                    return device_data
+        else:
+            os.makedirs(device_files_absdir)
+
+        device_files_subdir = os.path.join("codes", device_class)
+        device_files_absdir = os.path.join(
+            os.path.dirname(os.path.abspath(__file__)), device_files_subdir
+        )
+        if os.path.isdir(device_files_absdir):
+            device_json_path = os.path.join(device_files_absdir, device_json_filename)
+            if os.path.exists(device_json_path):
+                if device_data := DeviceData.check_file(
+                    device_json_filename, device_json_path, required_keys
+                ):
+                    return device_data
+            else:
+                _LOGGER.error(
+                    "Device Json file '%s' doesn't exists!", device_json_filename
+                )
+                return None
+        else:
+            _LOGGER.error(
+                "Devices Json files directory '%s' doesn't exists!", device_files_absdir
+            )
+            return None
+
+        return None
+
+    @staticmethod
+    def check_file(device_json_filename, device_json_path, required_keys):
+        with open(device_json_path) as j:
+            try:
+                _LOGGER.debug("Loading device json file '%s'", device_json_path)
+                device_data = json.load(j)
+                _LOGGER.debug("Device json file '%s' loaded", device_json_path)
+            except Exception:
+                _LOGGER.error(
+                    "The device JSON file '%s' is not valid json!", device_json_filename
+                )
+                return None
+
+        if not isinstance(device_data, dict):
+            _LOGGER.error("Invalid device code file '%s.", device_json_filename)
+            return None
+
+        for key in required_keys:
+            if not (key in device_data and device_data[key]):
+                _LOGGER.error(
+                    "Invalid device JSON file '%s', missing or not defined '%s'!",
+                    device_json_filename,
+                    key,
+                )
+                return None
+
+        if not (
+            "commands" in device_data
+            and isinstance(device_data["commands"], dict)
+            and len(device_data["commands"])
+        ):
+            _LOGGER.error(
+                "Invalid device JSON file '%s', missing 'commands'!",
+                device_json_filename,
+            )
+            return None
+
+        return device_data
diff --git a/custom_components/smartir/climate.py b/custom_components/smartir/climate.py
@@ -1,7 +1,5 @@
 import asyncio
-import json
 import logging
-import os.path
 
 import voluptuous as vol
 
@@ -29,6 +27,7 @@
 import homeassistant.helpers.config_validation as cv
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType
+from . import DeviceData
 from .controller import get_controller
 
 _LOGGER = logging.getLogger(__name__)
@@ -71,62 +70,25 @@ async def async_setup_platform(
     hass: HomeAssistant, config: ConfigType, async_add_entities, discovery_info=None
 ):
     """Set up the IR Climate platform."""
-    _LOGGER.debug("Setting up the startir platform")
-    device_code = config.get(CONF_DEVICE_CODE)
-    device_files_subdir = os.path.join("codes", "climate")
-    device_files_absdir = os.path.join(
-        os.path.dirname(os.path.abspath(__file__)), device_files_subdir
-    )
-
-    device_json_filename = str(device_code) + ".json"
-    device_json_path = os.path.join(device_files_absdir, device_json_filename)
-
-    if not os.path.exists(device_json_path):
-        _LOGGER.error("Couldn't find the device Json file %s!", device_json_filename)
-        return
-
-    with open(device_json_path) as j:
-        try:
-            _LOGGER.debug(f"loading json file {device_json_path}")
-            device_data = json.load(j)
-            _LOGGER.debug(f"{device_json_path} file loaded")
-        except Exception:
-            _LOGGER.error(
-                "The device JSON file '%s' is not valid json!", device_json_filename
-            )
-            return
-
-    if not isinstance(device_data, dict):
-        _LOGGER.error("Invalid device code file '%s.", device_json_filename)
-        return
-
-    for key in [
-        "manufacturer",
-        "supportedModels",
-        "supportedController",
-        "commandsEncoding",
-        "minTemperature",
-        "maxTemperature",
-        "precision",
-        "operationModes",
-        "fanModes",
-    ]:
-        if not (key in device_data and device_data[key]):
-            _LOGGER.error(
-                "Invalid device JSON file '%s, missing or not defined '%s'!",
-                device_json_filename,
-                key,
-            )
-            return
-
+    _LOGGER.debug("Setting up the smartir climate platform")
     if not (
-        "commands" in device_data
-        and isinstance(device_data["commands"], dict)
-        and len(device_data["commands"])
-    ):
-        _LOGGER.error(
-            "Invalid device JSON file '%s, missing 'commands'!", device_json_filename
+        device_data := DeviceData.load_file(
+            config.get(CONF_DEVICE_CODE),
+            "climate",
+            [
+                "manufacturer",
+                "supportedModels",
+                "supportedController",
+                "commandsEncoding",
+                "minTemperature",
+                "maxTemperature",
+                "precision",
+                "operationModes",
+                "fanModes",
+            ],
         )
+    ):
+        _LOGGER.error("Smartir climate device data init failed!")
         return
 
     async_add_entities([SmartIRClimate(hass, config, device_data)])

diff --git a/custom_components/smartir/fan.py b/custom_components/smartir/fan.py
@@ -1,7 +1,5 @@
 import asyncio
-import json
 import logging
-import os.path
 
 import voluptuous as vol
 
@@ -25,6 +23,7 @@
     ordered_list_item_to_percentage,
     percentage_to_ordered_list_item,
 )
+from . import DeviceData
 from .controller import get_controller
 
 _LOGGER = logging.getLogger(__name__)
@@ -60,60 +59,21 @@ async def async_setup_platform(
     hass: HomeAssistant, config: ConfigType, async_add_entities, discovery_info=None
 ):
     """Set up the IR Fan platform."""
-    device_code = config.get(CONF_DEVICE_CODE)
-    device_files_subdir = os.path.join("codes", "fan")
-    device_files_absdir = os.path.join(
-        os.path.dirname(os.path.abspath(__file__)), device_files_subdir
-    )
-
-    if not os.path.isdir(device_files_absdir):
-        os.makedirs(device_files_absdir)
-
-    device_json_filename = str(device_code) + ".json"
-    device_json_path = os.path.join(device_files_absdir, device_json_filename)
-
-    if not os.path.exists(device_json_path):
-        _LOGGER.error("Couldn't find the device Json file %s!", device_json_filename)
-        return
-
-    with open(device_json_path) as j:
-        try:
-            _LOGGER.debug(f"loading json file {device_json_path}")
-            device_data = json.load(j)
-            _LOGGER.debug(f"{device_json_path} file loaded")
-        except Exception:
-            _LOGGER.error(
-                "The device JSON file '%s' is not valid json!", device_json_filename
-            )
-            return
-
-    if not isinstance(device_data, dict):
-        _LOGGER.error("Invalid device JSON file '%s.", device_json_filename)
-        return
-
-    for key in [
-        "manufacturer",
-        "supportedModels",
-        "supportedController",
-        "commandsEncoding",
-        "speed",
-    ]:
-        if not (key in device_data and device_data[key]):
-            _LOGGER.error(
-                "Invalid device JSON file '%s, missing or not defined '%s'!",
-                device_json_filename,
-                key,
-            )
-            return
-
+    _LOGGER.debug("Setting up the smartir fan platform")
     if not (
-        "commands" in device_data
-        and isinstance(device_data["commands"], dict)
-        and len(device_data["commands"])
-    ):
-        _LOGGER.error(
-            "Invalid device JSON file '%s, missing 'commands'!", device_json_filename
+        device_data := DeviceData.load_file(
+            config.get(CONF_DEVICE_CODE),
+            "fan",
+            [
+                "manufacturer",
+                "supportedModels",
+                "supportedController",
+                "commandsEncoding",
+                "speed",
+            ],
         )
+    ):
+        _LOGGER.error("Smartir fan device data init failed!")
         return
 
     async_add_entities([SmartIRFan(hass, config, device_data)])

diff --git a/custom_components/smartir/media_player.py b/custom_components/smartir/media_player.py
@@ -1,7 +1,5 @@
 import asyncio
-import json
 import logging
-import os.path
 
 import voluptuous as vol
 
@@ -23,6 +21,7 @@
 import homeassistant.helpers.config_validation as cv
 from homeassistant.helpers.restore_state import RestoreEntity
 from homeassistant.helpers.typing import ConfigType
+from . import DeviceData
 from .controller import get_controller
 
 _LOGGER = logging.getLogger(__name__)
@@ -57,59 +56,20 @@ async def async_setup_platform(
     hass: HomeAssistant, config: ConfigType, async_add_entities, discovery_info=None
 ):
     """Set up the IR Media Player platform."""
-    device_code = config.get(CONF_DEVICE_CODE)
-    device_files_subdir = os.path.join("codes", "media_player")
-    device_files_absdir = os.path.join(
-        os.path.dirname(os.path.abspath(__file__)), device_files_subdir
-    )
-
-    if not os.path.isdir(device_files_absdir):
-        os.makedirs(device_files_absdir)
-
-    device_json_filename = str(device_code) + ".json"
-    device_json_path = os.path.join(device_files_absdir, device_json_filename)
-
-    if not os.path.exists(device_json_path):
-        _LOGGER.error("Couldn't find the device Json file %s!", device_json_filename)
-        return
-
-    with open(device_json_path) as j:
-        try:
-            _LOGGER.debug(f"loading json file {device_json_path}")
-            device_data = json.load(j)
-            _LOGGER.debug(f"{device_json_path} file loaded")
-        except Exception:
-            _LOGGER.error(
-                "The device JSON file '%s' is not valid json!", device_json_filename
-            )
-            return
-
-    if not isinstance(device_data, dict):
-        _LOGGER.error("Invalid device code file '%s.", device_json_filename)
-        return
-
-    for key in [
-        "manufacturer",
-        "supportedModels",
-        "supportedController",
-        "commandsEncoding",
-    ]:
-        if not (key in device_data and device_data[key]):
-            _LOGGER.error(
-                "Invalid device JSON file '%s, missing or not defined '%s'!",
-                device_json_filename,
-                key,
-            )
-            return
-
+    _LOGGER.debug("Setting up the smartir media player platform")
     if not (
-        "commands" in device_data
-        and isinstance(device_data["commands"], dict)
-        and len(device_data["commands"])
-    ):
-        _LOGGER.error(
-            "Invalid device JSON file '%s, missing 'commands'!", device_json_filename
+        device_data := DeviceData.load_file(
+            config.get(CONF_DEVICE_CODE),
+            "media_player",
+            [
+                "manufacturer",
+                "supportedModels",
+                "supportedController",
+                "commandsEncoding",
+            ],
         )
+    ):
+        _LOGGER.error("Smartir media player device data init failed!")
         return
 
     async_add_entities([SmartIRMediaPlayer(hass, config, device_data)])

diff --git a/hacs.json b/hacs.json
@@ -1,7 +1,7 @@
 {
   "name": "SmartIR",
   "homeassistant": "2024.5.0",
-  "persistent_directory": "codes",
+  "persistent_directory": "custom_codes",
   "zip_release": true,
   "hide_default_branch": true,
   "filename": "smartir.zip",