From fd4a05fc7a6e519b5e29469d17a2283b7183f52c Mon Sep 17 00:00:00 2001
From: Erik Montnemery <erik@montnemery.com>
Date: Mon, 4 Dec 2023 10:47:49 +0100
Subject: [PATCH] Minor improvements of deprecation helper (#104980)

---
 homeassistant/helpers/deprecation.py | 44 +++++++++++++++++++---------
 tests/util/yaml/test_init.py         |  4 +--
 2 files changed, 32 insertions(+), 16 deletions(-)

diff --git a/homeassistant/helpers/deprecation.py b/homeassistant/helpers/deprecation.py
index c499dd0b6cd..5a0682fdda2 100644
--- a/homeassistant/helpers/deprecation.py
+++ b/homeassistant/helpers/deprecation.py
@@ -99,7 +99,11 @@ def get_deprecated(
 def deprecated_class(
     replacement: str,
 ) -> Callable[[Callable[_P, _R]], Callable[_P, _R]]:
-    """Mark class as deprecated and provide a replacement class to be used instead."""
+    """Mark class as deprecated and provide a replacement class to be used instead.
+
+    If the deprecated function was called from a custom integration, ask the user to
+    report an issue.
+    """
 
     def deprecated_decorator(cls: Callable[_P, _R]) -> Callable[_P, _R]:
         """Decorate class as deprecated."""
@@ -107,7 +111,7 @@ def deprecated_class(
         @functools.wraps(cls)
         def deprecated_cls(*args: _P.args, **kwargs: _P.kwargs) -> _R:
             """Wrap for the original class."""
-            _print_deprecation_warning(cls, replacement, "class")
+            _print_deprecation_warning(cls, replacement, "class", "instantiated")
             return cls(*args, **kwargs)
 
         return deprecated_cls
@@ -118,7 +122,11 @@ def deprecated_class(
 def deprecated_function(
     replacement: str,
 ) -> Callable[[Callable[_P, _R]], Callable[_P, _R]]:
-    """Mark function as deprecated and provide a replacement to be used instead."""
+    """Mark function as deprecated and provide a replacement to be used instead.
+
+    If the deprecated function was called from a custom integration, ask the user to
+    report an issue.
+    """
 
     def deprecated_decorator(func: Callable[_P, _R]) -> Callable[_P, _R]:
         """Decorate function as deprecated."""
@@ -126,7 +134,7 @@ def deprecated_function(
         @functools.wraps(func)
         def deprecated_func(*args: _P.args, **kwargs: _P.kwargs) -> _R:
             """Wrap for the original function."""
-            _print_deprecation_warning(func, replacement, "function")
+            _print_deprecation_warning(func, replacement, "function", "called")
             return func(*args, **kwargs)
 
         return deprecated_func
@@ -134,10 +142,23 @@ def deprecated_function(
     return deprecated_decorator
 
 
-def _print_deprecation_warning(obj: Any, replacement: str, description: str) -> None:
+def _print_deprecation_warning(
+    obj: Any,
+    replacement: str,
+    description: str,
+    verb: str,
+) -> None:
     logger = logging.getLogger(obj.__module__)
     try:
         integration_frame = get_integration_frame()
+    except MissingIntegrationFrame:
+        logger.warning(
+            "%s is a deprecated %s. Use %s instead",
+            obj.__name__,
+            description,
+            replacement,
+        )
+    else:
         if integration_frame.custom_integration:
             hass: HomeAssistant | None = None
             with suppress(HomeAssistantError):
@@ -149,10 +170,11 @@ def _print_deprecation_warning(obj: Any, replacement: str, description: str) ->
             )
             logger.warning(
                 (
-                    "%s was called from %s, this is a deprecated %s. Use %s instead,"
+                    "%s was %s from %s, this is a deprecated %s. Use %s instead,"
                     " please %s"
                 ),
                 obj.__name__,
+                verb,
                 integration_frame.integration,
                 description,
                 replacement,
@@ -160,16 +182,10 @@ def _print_deprecation_warning(obj: Any, replacement: str, description: str) ->
             )
         else:
             logger.warning(
-                "%s was called from %s, this is a deprecated %s. Use %s instead",
+                "%s was %s from %s, this is a deprecated %s. Use %s instead",
                 obj.__name__,
+                verb,
                 integration_frame.integration,
                 description,
                 replacement,
             )
-    except MissingIntegrationFrame:
-        logger.warning(
-            "%s is a deprecated %s. Use %s instead",
-            obj.__name__,
-            description,
-            replacement,
-        )
diff --git a/tests/util/yaml/test_init.py b/tests/util/yaml/test_init.py
index 3a2d9b3734d..6f6f48813ce 100644
--- a/tests/util/yaml/test_init.py
+++ b/tests/util/yaml/test_init.py
@@ -636,8 +636,8 @@ async def test_deprecated_loaders(
     ):
         loader_class()
     assert (
-        f"{loader_class.__name__} was called from hue, this is a deprecated class. "
-        f"Use {new_class} instead"
+        f"{loader_class.__name__} was instantiated from hue, this is a deprecated "
+        f"class. Use {new_class} instead"
     ) in caplog.text