mirror of
https://github.com/home-assistant/core.git
synced 2025-05-20 22:07:08 +00:00
606a2848db
* Address comments * Remove Name option for File based sensor * Make sure platform schema is applied
85 lines
2.8 KiB
Python
85 lines
2.8 KiB
Python
"""Support for file notification."""
|
|
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import os
|
|
from typing import Any, TextIO
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.notify import (
|
|
ATTR_TITLE,
|
|
ATTR_TITLE_DEFAULT,
|
|
PLATFORM_SCHEMA,
|
|
BaseNotificationService,
|
|
)
|
|
from homeassistant.const import CONF_FILE_PATH, CONF_FILENAME
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.exceptions import ServiceValidationError
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
import homeassistant.util.dt as dt_util
|
|
|
|
from .const import CONF_TIMESTAMP, DOMAIN
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
# The legacy platform schema uses a filename, after import
|
|
# The full file path is stored in the config entry
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_FILENAME): cv.string,
|
|
vol.Optional(CONF_TIMESTAMP, default=False): cv.boolean,
|
|
}
|
|
)
|
|
|
|
|
|
async def async_get_service(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> FileNotificationService | None:
|
|
"""Get the file notification service."""
|
|
if discovery_info is None:
|
|
# We only set up through discovery
|
|
return None
|
|
file_path: str = discovery_info[CONF_FILE_PATH]
|
|
timestamp: bool = discovery_info[CONF_TIMESTAMP]
|
|
|
|
return FileNotificationService(file_path, timestamp)
|
|
|
|
|
|
class FileNotificationService(BaseNotificationService):
|
|
"""Implement the notification service for the File service."""
|
|
|
|
def __init__(self, file_path: str, add_timestamp: bool) -> None:
|
|
"""Initialize the service."""
|
|
self._file_path = file_path
|
|
self.add_timestamp = add_timestamp
|
|
|
|
def send_message(self, message: str = "", **kwargs: Any) -> None:
|
|
"""Send a message to a file."""
|
|
file: TextIO
|
|
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 self.add_timestamp:
|
|
text = f"{dt_util.utcnow().isoformat()} {message}\n"
|
|
else:
|
|
text = f"{message}\n"
|
|
file.write(text)
|
|
except OSError as exc:
|
|
raise ServiceValidationError(
|
|
translation_domain=DOMAIN,
|
|
translation_key="write_access_failed",
|
|
translation_placeholders={"filename": filepath, "exc": f"{exc!r}"},
|
|
) from exc
|