Add integration filtering and error if core options to helpers.frame.report (#60009)

Reduces some existing and upcoming boilerplate.

homeassistant/async_timeout_backcompat.py

@@ -2,19 +2,11 @@
 from __future__ import annotations
 
 import asyncio
-import contextlib
-import logging
 from typing import Any
 
 import async_timeout
 
-from homeassistant.helpers.frame import (
+from homeassistant.helpers.frame import report
-    MissingIntegrationFrame,
-    get_integration_frame,
-    report_integration,
-)
-
-_LOGGER = logging.getLogger(__name__)
 
 
 def timeout(
@@ -24,8 +16,9 @@ def timeout(
     if loop is None:
         loop = asyncio.get_running_loop()
     else:
-        _report(
+        report(
-            "called async_timeout.timeout with loop keyword argument. The loop keyword argument is deprecated and calls will fail after Home Assistant 2022.2"
+            "called async_timeout.timeout with loop keyword argument. The loop keyword argument is deprecated and calls will fail after Home Assistant 2022.2",
+            error_if_core=False,
         )
     if delay is not None:
         deadline: float | None = loop.time() + delay
@@ -36,8 +29,9 @@ def timeout(
 
 def current_task(loop: asyncio.AbstractEventLoop) -> asyncio.Task[Any] | None:
     """Backwards compatible current_task."""
-    _report(
+    report(
-        "called async_timeout.current_task. The current_task call is deprecated and calls will fail after Home Assistant 2022.2; use asyncio.current_task instead"
+        "called async_timeout.current_task. The current_task call is deprecated and calls will fail after Home Assistant 2022.2; use asyncio.current_task instead",
+        error_if_core=False,
     )
     return asyncio.current_task()
 
@@ -46,22 +40,3 @@ def enable() -> None:
     """Enable backwards compat transitions."""
     async_timeout.timeout = timeout
     async_timeout.current_task = current_task  # type: ignore[attr-defined]
-
-
-def _report(what: str) -> None:
-    """Report incorrect usage.
-
-    Async friendly.
-    """
-    integration_frame = None
-
-    with contextlib.suppress(MissingIntegrationFrame):
-        integration_frame = get_integration_frame()
-
-    if not integration_frame:
-        _LOGGER.warning(
-            "Detected code that %s; Please report this issue", what, stack_info=True
-        )
-        return
-
-    report_integration(what, integration_frame)

homeassistant/components/zeroconf/usage.py

@@ -1,28 +1,22 @@
 """Zeroconf usage utility to warn about multiple instances."""
 
-from contextlib import suppress
-import logging
 from typing import Any
 
 import zeroconf
 
-from homeassistant.helpers.frame import (
+from homeassistant.helpers.frame import report
-    MissingIntegrationFrame,
-    get_integration_frame,
-    report_integration,
-)
 
 from .models import HaZeroconf
 
-_LOGGER = logging.getLogger(__name__)
-
 
 def install_multiple_zeroconf_catcher(hass_zc: HaZeroconf) -> None:
     """Wrap the Zeroconf class to return the shared instance if multiple instances are detected."""
 
     def new_zeroconf_new(self: zeroconf.Zeroconf, *k: Any, **kw: Any) -> HaZeroconf:
-        _report(
+        report(
             "attempted to create another Zeroconf instance. Please use the shared Zeroconf via await homeassistant.components.zeroconf.async_get_instance(hass)",
+            exclude_integrations={"zeroconf"},
+            error_if_core=False,
         )
         return hass_zc
 
@@ -31,22 +25,3 @@ def install_multiple_zeroconf_catcher(hass_zc: HaZeroconf) -> None:
 
     zeroconf.Zeroconf.__new__ = new_zeroconf_new  # type: ignore
     zeroconf.Zeroconf.__init__ = new_zeroconf_init  # type: ignore
-
-
-def _report(what: str) -> None:
-    """Report incorrect usage.
-
-    Async friendly.
-    """
-    integration_frame = None
-
-    with suppress(MissingIntegrationFrame):
-        integration_frame = get_integration_frame(exclude_integrations={"zeroconf"})
-
-    if not integration_frame:
-        _LOGGER.warning(
-            "Detected code that %s; Please report this issue", what, stack_info=True
-        )
-        return
-
-    report_integration(what, integration_frame)

homeassistant/helpers/frame.py

@@ -50,18 +50,23 @@ class MissingIntegrationFrame(HomeAssistantError):
     """Raised when no integration is found in the frame."""
 
 
-def report(what: str) -> None:
+def report(
+    what: str, exclude_integrations: set | None = None, error_if_core: bool = True
+) -> None:
     """Report incorrect usage.
 
     Async friendly.
     """
     try:
-        integration_frame = get_integration_frame()
+        integration_frame = get_integration_frame(
+            exclude_integrations=exclude_integrations
+        )
     except MissingIntegrationFrame as err:
-        # Did not source from an integration? Hard error.
+        msg = f"Detected code that {what}. Please report this issue."
-        raise RuntimeError(
+        if error_if_core:
-            f"Detected code that {what}. Please report this issue."
+            raise RuntimeError(msg) from err
-        ) from err
+        _LOGGER.warning(msg, stack_info=True)
+        return
 
     report_integration(what, integration_frame)