110 lines
3.5 KiB
Python
110 lines
3.5 KiB
Python
"""Helper to gather system info."""
|
|
|
|
from __future__ import annotations
|
|
|
|
from functools import cache
|
|
from getpass import getuser
|
|
import logging
|
|
import os
|
|
import platform
|
|
from typing import TYPE_CHECKING, Any
|
|
|
|
from homeassistant.const import __version__ as current_version
|
|
from homeassistant.core import HomeAssistant
|
|
from homeassistant.loader import bind_hass
|
|
from homeassistant.util.package import is_docker_env, is_virtual_env
|
|
|
|
from .hassio import is_hassio
|
|
from .importlib import async_import_module
|
|
from .singleton import singleton
|
|
|
|
_LOGGER = logging.getLogger(__name__)
|
|
|
|
_DATA_MAC_VER = "system_info_mac_ver"
|
|
|
|
|
|
@cache
|
|
def is_official_image() -> bool:
|
|
"""Return True if Home Assistant is running in an official container."""
|
|
return os.path.isfile("/OFFICIAL_IMAGE")
|
|
|
|
|
|
@singleton(_DATA_MAC_VER)
|
|
async def async_get_mac_ver(hass: HomeAssistant) -> str:
|
|
"""Return the macOS version."""
|
|
return (await hass.async_add_executor_job(platform.mac_ver))[0]
|
|
|
|
|
|
# Cache the result of getuser() because it can call getpwuid() which
|
|
# can do blocking I/O to look up the username in /etc/passwd.
|
|
cached_get_user = cache(getuser)
|
|
|
|
|
|
@bind_hass
|
|
async def async_get_system_info(hass: HomeAssistant) -> dict[str, Any]:
|
|
"""Return info about the system."""
|
|
# Local import to avoid circular dependencies
|
|
# We use the import helper because hassio
|
|
# may not be loaded yet and we don't want to
|
|
# do blocking I/O in the event loop to import it.
|
|
if TYPE_CHECKING:
|
|
# pylint: disable-next=import-outside-toplevel
|
|
from homeassistant.components import hassio
|
|
else:
|
|
hassio = await async_import_module(hass, "homeassistant.components.hassio")
|
|
|
|
is_hassio_ = is_hassio(hass)
|
|
|
|
info_object = {
|
|
"installation_type": "Unknown",
|
|
"version": current_version,
|
|
"dev": "dev" in current_version,
|
|
"hassio": is_hassio_,
|
|
"virtualenv": is_virtual_env(),
|
|
"python_version": platform.python_version(),
|
|
"docker": False,
|
|
"arch": platform.machine(),
|
|
"timezone": str(hass.config.time_zone),
|
|
"os_name": platform.system(),
|
|
"os_version": platform.release(),
|
|
}
|
|
|
|
try:
|
|
info_object["user"] = cached_get_user()
|
|
except KeyError:
|
|
info_object["user"] = None
|
|
|
|
if platform.system() == "Darwin":
|
|
info_object["os_version"] = await async_get_mac_ver(hass)
|
|
elif platform.system() == "Linux":
|
|
info_object["docker"] = is_docker_env()
|
|
|
|
# Determine installation type on current data
|
|
if info_object["docker"]:
|
|
if info_object["user"] == "root" and is_official_image():
|
|
info_object["installation_type"] = "Home Assistant Container"
|
|
else:
|
|
info_object["installation_type"] = "Unsupported Third Party Container"
|
|
|
|
elif is_virtual_env():
|
|
info_object["installation_type"] = "Home Assistant Core"
|
|
|
|
# Enrich with Supervisor information
|
|
if is_hassio_:
|
|
if not (info := hassio.get_info(hass)):
|
|
_LOGGER.warning("No Home Assistant Supervisor info available")
|
|
info = {}
|
|
|
|
host = hassio.get_host_info(hass) or {}
|
|
info_object["supervisor"] = info.get("supervisor")
|
|
info_object["host_os"] = host.get("operating_system")
|
|
info_object["docker_version"] = info.get("docker")
|
|
info_object["chassis"] = host.get("chassis")
|
|
|
|
if info.get("hassos") is not None:
|
|
info_object["installation_type"] = "Home Assistant OS"
|
|
else:
|
|
info_object["installation_type"] = "Home Assistant Supervised"
|
|
|
|
return info_object
|