03eea7bd3f
* use posix spawn on alpine * Avoid subprocess memory copy when c library supports posix_spawn By default python 3.10 will use the fork() which has to copy all the memory of the parent process (in our case this can be huge since Home Assistant core can use hundreds of megabytes of RAM). By using posix_spawn this is avoided. In python 3.11 vfork will also be available https://github.com/python/cpython/issues/80004#issuecomment-1093810689 https://github.com/python/cpython/pull/11671 but we won't always be able to use it and posix_spawn is considered safer https://bugzilla.kernel.org/show_bug.cgi?id=215813#c14 The subprocess library doesn't know about musl though even though it supports posix_spawn https://git.musl-libc.org/cgit/musl/log/src/process/posix_spawn.c so we have to teach it since it only has checks for glibc1b736838e6/Lib/subprocess.py (L745)The constant is documented as being able to be flipped here: https://docs.python.org/3/library/subprocess.html#disabling-use-of-vfork-or-posix-spawn * Avoid subprocess memory copy when c library supports posix_spawn By default python 3.10 will use the fork() which has to copy memory of the parent process (in our case this can be huge since Home Assistant core can use hundreds of megabytes of RAM). By using posix_spawn this is avoided and subprocess creation does not get discernibly slow the larger the Home Assistant python process grows. In python 3.11 vfork will also be available https://github.com/python/cpython/issues/80004#issuecomment-1093810689 https://github.com/python/cpython/pull/11671 but we won't always be able to use it and posix_spawn is considered safer https://bugzilla.kernel.org/show_bug.cgi?id=215813#c14 The subprocess library doesn't know about musl though even though it supports posix_spawn https://git.musl-libc.org/cgit/musl/log/src/process/posix_spawn.c so we have to teach it since it only has checks for glibc1b736838e6/Lib/subprocess.py (L745)The constant is documented as being able to be flipped here: https://docs.python.org/3/library/subprocess.html#disabling-use-of-vfork-or-posix-spawn * missed some * adjust more tests * coverage
70 lines
2.4 KiB
Python
70 lines
2.4 KiB
Python
"""Support for command line notification services."""
|
|
from __future__ import annotations
|
|
|
|
import logging
|
|
import subprocess
|
|
|
|
import voluptuous as vol
|
|
|
|
from homeassistant.components.notify import PLATFORM_SCHEMA, BaseNotificationService
|
|
from homeassistant.const import CONF_COMMAND, CONF_NAME
|
|
from homeassistant.core import HomeAssistant
|
|
import homeassistant.helpers.config_validation as cv
|
|
from homeassistant.helpers.typing import ConfigType, DiscoveryInfoType
|
|
from homeassistant.util.process import kill_subprocess
|
|
|
|
from .const import CONF_COMMAND_TIMEOUT, DEFAULT_TIMEOUT
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
PLATFORM_SCHEMA = PLATFORM_SCHEMA.extend(
|
|
{
|
|
vol.Required(CONF_COMMAND): cv.string,
|
|
vol.Optional(CONF_NAME): cv.string,
|
|
vol.Optional(CONF_COMMAND_TIMEOUT, default=DEFAULT_TIMEOUT): cv.positive_int,
|
|
}
|
|
)
|
|
|
|
|
|
def get_service(
|
|
hass: HomeAssistant,
|
|
config: ConfigType,
|
|
discovery_info: DiscoveryInfoType | None = None,
|
|
) -> CommandLineNotificationService:
|
|
"""Get the Command Line notification service."""
|
|
command: str = config[CONF_COMMAND]
|
|
timeout: int = config[CONF_COMMAND_TIMEOUT]
|
|
|
|
return CommandLineNotificationService(command, timeout)
|
|
|
|
|
|
class CommandLineNotificationService(BaseNotificationService):
|
|
"""Implement the notification service for the Command Line service."""
|
|
|
|
def __init__(self, command: str, timeout: int) -> None:
|
|
"""Initialize the service."""
|
|
self.command = command
|
|
self._timeout = timeout
|
|
|
|
def send_message(self, message="", **kwargs) -> None:
|
|
"""Send a message to a command line."""
|
|
with subprocess.Popen(
|
|
self.command,
|
|
universal_newlines=True,
|
|
stdin=subprocess.PIPE,
|
|
close_fds=False, # required for posix_spawn
|
|
shell=True, # nosec # shell by design
|
|
) as proc:
|
|
try:
|
|
proc.communicate(input=message, timeout=self._timeout)
|
|
if proc.returncode != 0:
|
|
_LOGGER.error(
|
|
"Command failed (with return code %s): %s",
|
|
proc.returncode,
|
|
self.command,
|
|
)
|
|
except subprocess.TimeoutExpired:
|
|
_LOGGER.error("Timeout for command: %s", self.command)
|
|
kill_subprocess(proc)
|
|
except subprocess.SubprocessError:
|
|
_LOGGER.error("Error trying to exec command: %s", self.command)
|