Fix blocking file io (#1704)

Author: andrew-codechimp

custom_components/battery_notes/config_flow.py

@@ -174,7 +174,7 @@ async def async_step_device(
 
             model_info = ModelInfo(device_entry.manufacturer, device_entry.model, device_entry.hw_version)
 
-            library = Library.factory(self.hass)
+            library = await Library.factory(self.hass)
 
             # Set defaults if not found in library
             self.data[CONF_BATTERY_QUANTITY] = 1
@@ -248,7 +248,7 @@ async def async_step_entity(
 
                 model_info = ModelInfo(device_entry.manufacturer, device_entry.model, device_entry.hw_version)
 
-                library = Library.factory(self.hass)
+                library = await Library.factory(self.hass)
 
                 device_battery_details = await library.get_device_battery_details(
                     model_info

custom_components/battery_notes/discovery.py

@@ -83,7 +83,7 @@ async def start_discovery(self) -> None:
         _LOGGER.debug("Start auto discovering devices")
         device_registry = dr.async_get(self.hass)
 
-        library = Library.factory(self.hass)
+        library = await Library.factory(self.hass)
 
         if library.loaded():
             for device_entry in list(device_registry.devices.values()):

custom_components/battery_notes/library.py

@@ -6,6 +6,8 @@
 import os
 from typing import NamedTuple
 
+import aiofiles.os
+
 from homeassistant.core import HomeAssistant
 
 from .const import (
@@ -27,25 +29,31 @@ class Library:  # pylint: disable=too-few-public-methods
 
     def __init__(self, hass: HomeAssistant) -> None:
         """Init."""
+        self.hass = hass
+
+    async def initialize(self):
+        """Load the user and default libraries."""
 
         # User Library
         if (
-            DOMAIN_CONFIG in hass.data[DOMAIN]
-            and CONF_USER_LIBRARY in hass.data[DOMAIN][DOMAIN_CONFIG]
+            DOMAIN_CONFIG in self.hass.data[DOMAIN]
+            and CONF_USER_LIBRARY in self.hass.data[DOMAIN][DOMAIN_CONFIG]
             ):
-            user_library_filename = hass.data[DOMAIN][DOMAIN_CONFIG].get(CONF_USER_LIBRARY)
-            if  user_library_filename != "":
+            user_library_filename = self.hass.data[DOMAIN][DOMAIN_CONFIG].get(CONF_USER_LIBRARY)
+            if user_library_filename != "":
                 json_user_path = os.path.join(
                     BUILT_IN_DATA_DIRECTORY,
                     user_library_filename,
                 )
                 _LOGGER.debug("Using user library file at %s", json_user_path)
 
                 try:
-                    with open(json_user_path, encoding="utf-8") as user_file:
-                        user_json_data = json.load(user_file)
+                    async with aiofiles.open(json_user_path, mode="r", encoding="utf-8") as user_file:
+                        content = await user_file.read()
+                        user_json_data = json.loads(content)
                         self._devices = user_json_data["devices"]
-                        user_file.close()
+                        _LOGGER.debug("Loaded %s user devices", len(user_json_data["devices"]))
+                        await user_file.close()
 
                 except FileNotFoundError:
                     _LOGGER.error(
@@ -61,10 +69,12 @@ def __init__(self, hass: HomeAssistant) -> None:
         _LOGGER.debug("Using library file at %s", json_default_path)
 
         try:
-            with open(json_default_path, encoding="utf-8") as default_file:
-                default_json_data = json.load(default_file)
+            async with aiofiles.open(json_default_path, mode="r", encoding="utf-8") as default_file:
+                content = await default_file.read()
+                default_json_data = json.loads(content)
                 self._devices.extend(default_json_data["devices"])
-                default_file.close()
+                _LOGGER.debug("Loaded %s default devices", len(default_json_data["devices"]))
+                await default_file.close()
 
         except FileNotFoundError:
             _LOGGER.error(
@@ -73,7 +83,7 @@ def __init__(self, hass: HomeAssistant) -> None:
             )
 
     @staticmethod
-    def factory(hass: HomeAssistant) -> Library:
+    async def factory(hass: HomeAssistant) -> Library:
         """Return the library or create."""
 
         if DOMAIN not in hass.data:
@@ -83,6 +93,7 @@ def factory(hass: HomeAssistant) -> Library:
             return hass.data[DOMAIN][DATA_LIBRARY]  # type: ignore
 
         library = Library(hass)
+        await library.initialize()
         hass.data[DOMAIN][DATA_LIBRARY] = library
         return library
 

custom_components/battery_notes/library_updater.py

@@ -10,6 +10,7 @@
 from datetime import datetime, timedelta
 
 import aiohttp
+import aiofiles.os
 import async_timeout
 
 from homeassistant.exceptions import ConfigEntryNotReady
@@ -88,9 +89,9 @@ async def get_library_updates(self, time):
                     "library.json",
                 )
 
-                with open(json_path, "w", encoding="utf-8") as file:
-                    file.write(content)
-                    file.close()
+                async with aiofiles.open(json_path, mode="w", encoding="utf-8") as library_file:
+                    await library_file.write(content)
+                    await library_file.close()
 
                 self.hass.data[DOMAIN][DATA_LIBRARY_LAST_UPDATE] = datetime.now()