Improve dev error message for YAML platform setup missing method (home-assistant#155505)

Co-authored-by: Martin Hjelmare <[email protected]>
Co-authored-by: Joost Lekkerkerker <[email protected]>

Author: 3 people

homeassistant/helpers/entity_platform.py

@@ -330,10 +330,18 @@ async def async_setup(
                 self.domain,
             )
             learn_more_url = None
-            if self.platform and "custom_components" not in self.platform.__file__:  # type: ignore[attr-defined]
-                learn_more_url = (
-                    f"https://www.home-assistant.io/integrations/{self.platform_name}/"
-                )
+            if self.platform:
+                if "custom_components" in self.platform.__file__:  # type: ignore[attr-defined]
+                    self.logger.warning(
+                        (
+                            "The %s platform module for the %s custom integration does not implement"
+                            " async_setup_platform or setup_platform."
+                        ),
+                        self.platform_name,
+                        self.domain,
+                    )
+                else:
+                    learn_more_url = f"https://www.home-assistant.io/integrations/{self.platform_name}/"
             platform_key = f"platform: {self.platform_name}"
             yaml_example = f"```yaml\n{self.domain}:\n  - {platform_key}\n```"
             async_create_issue(

tests/helpers/test_entity_platform.py

@@ -4,6 +4,7 @@
 from collections.abc import Iterable
 from datetime import timedelta
 import logging
+import types
 from typing import Any
 from unittest.mock import ANY, AsyncMock, Mock, patch
 
@@ -1611,6 +1612,32 @@ async def test_platform_with_no_setup(
     }
 
 
+async def test_platform_with_no_setup_custom_component_hint(
+    hass: HomeAssistant,
+    caplog: pytest.LogCaptureFixture,
+    issue_registry: ir.IssueRegistry,
+) -> None:
+    """Test setting up a custom integration platform without setup logs extra warning."""
+    platform_mod = types.ModuleType("custom_components.mock_integration.mock_platform")
+    platform_mod.__file__ = (
+        "/config/custom_components/mock_integration/mock_platform.py"
+    )
+
+    entity_platform = MockEntityPlatform(
+        hass,
+        domain="mock-integration",
+        platform_name="mock-platform",
+        platform=platform_mod,
+    )
+
+    await entity_platform.async_setup(None)
+
+    assert (
+        "The mock-platform platform module for the mock-integration custom integration "
+        "does not implement async_setup_platform or setup_platform." in caplog.text
+    )
+
+
 async def test_platforms_sharing_services(hass: HomeAssistant) -> None:
     """Test platforms share services."""
     entity_platform1 = MockEntityPlatform(