Commit HA Core version of File - Last commit Aug 27, 2024

Author: benjamin-dcs

custom_components/file_plusplus/__init__.py

@@ -1,4 +1,4 @@
-"""The file++ component."""
+"""The file component."""
 
 from copy import deepcopy
 from typing import Any
@@ -44,7 +44,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
         return True
     # The use of the legacy notify service was deprecated with HA Core 2024.6.0
     # and will be removed with HA Core 2024.12
-    migrate_notify_issue(hass, DOMAIN, "File (Large)", "2024.12.0")
+    migrate_notify_issue(hass, DOMAIN, "File", "2024.12.0")
     # The YAML config was imported with HA Core 2024.6.0 and will be removed with
     # HA Core 2024.12
     ir.async_create_issue(
@@ -59,7 +59,7 @@ async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
         translation_key="deprecated_yaml",
         translation_placeholders={
             "domain": DOMAIN,
-            "integration_title": "File (Large)",
+            "integration_title": "File",
         },
     )
 

custom_components/file_plusplus/config_flow.py

@@ -1,7 +1,6 @@
-"""Config flow for file++ integration."""
+"""Config flow for file integration."""
 
 from copy import deepcopy
-import logging
 import os
 from typing import Any
 
@@ -21,9 +20,8 @@
     CONF_PLATFORM,
     CONF_UNIT_OF_MEASUREMENT,
     CONF_VALUE_TEMPLATE,
-    Platform
+    Platform,
 )
-
 from homeassistant.core import callback
 from homeassistant.helpers.selector import (
     BooleanSelector,
@@ -35,10 +33,7 @@
     TextSelectorType,
 )
 
-from .const import (CONF_TIMESTAMP, DEFAULT_NAME, DOMAIN,
-                    CONF_NOTIFY, CONF_SENSOR)
-
-_LOGGER = logging.getLogger(__name__)
+from .const import CONF_TIMESTAMP, DEFAULT_NAME, DOMAIN
 
 BOOLEAN_SELECTOR = BooleanSelector(BooleanSelectorConfig())
 TEMPLATE_SELECTOR = TemplateSelector(TemplateSelectorConfig())
@@ -73,7 +68,7 @@
 
 
 class FileConfigFlowHandler(ConfigFlow, domain=DOMAIN):
-    """Handle a file++ config flow."""
+    """Handle a file config flow."""
 
     VERSION = 2
 
@@ -116,9 +111,6 @@ async def _async_handle_step(
                     if key not in (CONF_FILE_PATH, CONF_PLATFORM, CONF_NAME):
                         data.pop(key)
                         options[key] = value
-                _LOGGER.debug("DATA: " + str(data))
-                _LOGGER.debug("TITLE: " + str(title))
-                _LOGGER.debug("OPTIONS: " + str(options))
                 return self.async_create_entry(data=data, title=title, options=options)
 
         return self.async_show_form(
@@ -137,9 +129,7 @@ async def async_step_sensor(
         """Handle file sensor config flow."""
         return await self._async_handle_step(Platform.SENSOR.value, user_input)
 
-    async def async_step_import(
-        self, import_data: dict[str, Any]
-    ) -> ConfigFlowResult:
+    async def async_step_import(self, import_data: dict[str, Any]) -> ConfigFlowResult:
         """Import `file`` config from configuration.yaml."""
         self._async_abort_entries_match(import_data)
         platform = import_data[CONF_PLATFORM]
@@ -162,12 +152,12 @@ async def async_step_import(
 
 
 class FileOptionsFlowHandler(OptionsFlowWithConfigEntry):
-    """Handle File++ options."""
+    """Handle File options."""
 
     async def async_step_init(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
-        """Manage File++ options."""
+        """Manage File options."""
         if user_input:
             return self.async_create_entry(data=user_input)
 

custom_components/file_plusplus/const.py

@@ -1,12 +1,8 @@
-"""Constants for the file++ integration."""
+"""Constants for the file integration."""
 
-DOMAIN = "file_plusplus"
+DOMAIN = "file"
 
 CONF_TIMESTAMP = "timestamp"
 
-DEFAULT_NAME = "file_plusplus"
+DEFAULT_NAME = "File"
 FILE_ICON = "mdi:file"
-
-
-CONF_NOTIFY = "Set up a notification service"
-CONF_SENSOR = "Set up a file based sensor"

custom_components/file_plusplus/manifest.json

@@ -1,10 +1,9 @@
 {
-    "domain": "file_plusplus",
-    "name": "File++",
-    "codeowners": ["@benjamin-dcs"],
-    "config_flow": true,
-    "documentation": "https://github.com/benjamin-dcs/File-plusplus/blob/main/README.md",
-    "iot_class": "local_polling",
-    "issue_tracker": "https://github.com/benjamin-dcs/File-plusplus/issues",
-    "version": "0.1.0"
-}
+  "domain": "file",
+  "name": "File",
+  "codeowners": ["@fabaff"],
+  "config_flow": true,
+  "documentation": "https://www.home-assistant.io/integrations/file",
+  "iot_class": "local_polling",
+  "requirements": ["file-read-backwards==2.0.0"]
+}

custom_components/file_plusplus/notify.py

@@ -1,4 +1,4 @@
-"""Support for file++ notification."""
+"""Support for file notification."""
 
 from __future__ import annotations
 
@@ -57,7 +57,7 @@ async def async_get_service(
 
 
 class FileNotificationService(BaseNotificationService):
-    """Implement the notification service for the File++ service."""
+    """Implement the notification service for the File service."""
 
     def __init__(self, file_path: str, add_timestamp: bool) -> None:
         """Initialize the service."""
@@ -81,12 +81,12 @@ def send_message(self, message: str = "", **kwargs: Any) -> None:
         filepath = self._file_path
         try:
             with open(filepath, "a", encoding="utf8") as file:
-                # if os.stat(filepath).st_size == 0:
-                #     title = (
-                #         f"{kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT)} notifications (Log"
-                #         f" started: {dt_util.utcnow().isoformat()})\n{'-' * 80}\n"
-                #     )
-                #     file.write(title)
+                if os.stat(filepath).st_size == 0:
+                    title = (
+                        f"{kwargs.get(ATTR_TITLE, ATTR_TITLE_DEFAULT)} notifications (Log"
+                        f" started: {dt_util.utcnow().isoformat()})\n{'-' * 80}\n"
+                    )
+                    file.write(title)
 
                 if self.add_timestamp:
                     text = f"{dt_util.utcnow().isoformat()} {message}\n"
@@ -131,12 +131,12 @@ def send_message(self, message: str, title: str | None = None) -> None:
         filepath = self._file_path
         try:
             with open(filepath, "a", encoding="utf8") as file:
-                # if os.stat(filepath).st_size == 0:
-                #     title = (
-                #         f"{title or ATTR_TITLE_DEFAULT} notifications (Log"
-                #         f" started: {dt_util.utcnow().isoformat()})\n{'-' * 80}\n"
-                #     )
-                #     file.write(title)
+                if os.stat(filepath).st_size == 0:
+                    title = (
+                        f"{title or ATTR_TITLE_DEFAULT} notifications (Log"
+                        f" started: {dt_util.utcnow().isoformat()})\n{'-' * 80}\n"
+                    )
+                    file.write(title)
 
                 if self._add_timestamp:
                     text = f"{dt_util.utcnow().isoformat()} {message}\n"

custom_components/file_plusplus/sensor.py

@@ -5,7 +5,7 @@
 import logging
 import os
 
-# from file_read_backwards import FileReadBackwards
+from file_read_backwards import FileReadBackwards
 import voluptuous as vol
 
 from homeassistant.components.sensor import (
@@ -98,50 +98,21 @@ def __init__(
     def update(self) -> None:
         """Get the latest entry from a file and updates the state."""
         try:
-            # with FileReadBackwards(self._file_path, encoding="utf-8") as file_data:
-            #     for line in file_data:
-            #         data = line
-            #         break
-            #     data = data.strip()
-            with open(self._file_path, encoding="utf-8") as f:
-                data = f.read()
-        except (IndexError, FileNotFoundError, IsADirectoryError, UnboundLocalError) as e:
-            _LOGGER.warning(
-                "File or data not present at the moment: %s",
-                os.path.basename(self._file_path),
-            )
-            return
-
-        self._attr_native_value = "Ok"
-
-        # if self._val_tpl is not None:
-        #     self._attr_native_value = (
-        #         self._val_tpl.async_render_with_possible_json_value(data, None)
-        #     )
-        # else:
-        #     self._attr_native_value = data
-    
-    @property
-    def extra_state_attributes(self):
-        """Return device state attributes."""
-
-        try:
-            with open(self._file_path, encoding="utf-8") as f:
-                data = f.read()
-        except (IndexError, FileNotFoundError, IsADirectoryError, UnboundLocalError) as e:
+            with FileReadBackwards(self._file_path, encoding="utf-8") as file_data:
+                for line in file_data:
+                    data = line
+                    break
+                data = data.strip()
+        except (IndexError, FileNotFoundError, IsADirectoryError, UnboundLocalError):
             _LOGGER.warning(
                 "File or data not present at the moment: %s",
                 os.path.basename(self._file_path),
             )
             return
 
         if self._val_tpl is not None:
-            content = (
+            self._attr_native_value = (
                 self._val_tpl.async_render_with_possible_json_value(data, None)
             )
         else:
-            content = data
-
-        return {
-            "content": content,
-        }
+            self._attr_native_value = data