Remove deprecated yaml import from Telegram bot (home-assistant#158520)

Author: hanwg

homeassistant/components/telegram_bot/__init__.py

@@ -2,28 +2,22 @@
 
 from __future__ import annotations
 
-from ipaddress import IPv4Network, ip_network
 import logging
 from types import ModuleType
-from typing import Any
 
 from telegram import Bot
 from telegram.constants import InputMediaType
 from telegram.error import InvalidToken, TelegramError
 import voluptuous as vol
 
 from homeassistant.components.script import DOMAIN as SCRIPT_DOMAIN
-from homeassistant.config_entries import SOURCE_IMPORT
 from homeassistant.const import (
     ATTR_DOMAIN,
     ATTR_ENTITY_ID,
     ATTR_LATITUDE,
     ATTR_LONGITUDE,
     ATTR_SERVICE,
-    CONF_API_KEY,
     CONF_PLATFORM,
-    CONF_SOURCE,
-    CONF_URL,
     Platform,
 )
 from homeassistant.core import (
@@ -89,14 +83,8 @@
     CHAT_ACTION_UPLOAD_VIDEO,
     CHAT_ACTION_UPLOAD_VIDEO_NOTE,
     CHAT_ACTION_UPLOAD_VOICE,
-    CONF_ALLOWED_CHAT_IDS,
-    CONF_BOT_COUNT,
     CONF_CONFIG_ENTRY_ID,
-    CONF_PROXY_URL,
-    CONF_TRUSTED_NETWORKS,
-    DEFAULT_TRUSTED_NETWORKS,
     DOMAIN,
-    PARSER_MD,
     PLATFORM_BROADCAST,
     PLATFORM_POLLING,
     PLATFORM_WEBHOOKS,
@@ -122,34 +110,7 @@
 
 _LOGGER = logging.getLogger(__name__)
 
-CONFIG_SCHEMA = vol.Schema(
-    {
-        DOMAIN: vol.All(
-            cv.ensure_list,
-            [
-                vol.Schema(
-                    {
-                        vol.Required(CONF_PLATFORM): vol.In(
-                            (PLATFORM_BROADCAST, PLATFORM_POLLING, PLATFORM_WEBHOOKS)
-                        ),
-                        vol.Required(CONF_API_KEY): cv.string,
-                        vol.Required(CONF_ALLOWED_CHAT_IDS): vol.All(
-                            cv.ensure_list, [vol.Coerce(int)]
-                        ),
-                        vol.Optional(ATTR_PARSER, default=PARSER_MD): cv.string,
-                        vol.Optional(CONF_PROXY_URL): cv.string,
-                        # webhooks
-                        vol.Optional(CONF_URL): cv.url,
-                        vol.Optional(
-                            CONF_TRUSTED_NETWORKS, default=DEFAULT_TRUSTED_NETWORKS
-                        ): vol.All(cv.ensure_list, [ip_network]),
-                    }
-                )
-            ],
-        )
-    },
-    extra=vol.ALLOW_EXTRA,
-)
+CONFIG_SCHEMA = cv.config_entry_only_config_schema(DOMAIN)
 
 BASE_SERVICE_SCHEMA = vol.Schema(
     {
@@ -385,34 +346,6 @@
 async def async_setup(hass: HomeAssistant, config: ConfigType) -> bool:
     """Set up the Telegram bot component."""
 
-    # import the last YAML config since existing behavior only works with the last config
-    domain_config: list[dict[str, Any]] | None = config.get(DOMAIN)
-    if domain_config:
-        trusted_networks: list[IPv4Network] = domain_config[-1].get(
-            CONF_TRUSTED_NETWORKS, []
-        )
-        trusted_networks_str: list[str] = (
-            [str(trusted_network) for trusted_network in trusted_networks]
-            if trusted_networks
-            else []
-        )
-        hass.async_create_task(
-            hass.config_entries.flow.async_init(
-                DOMAIN,
-                context={CONF_SOURCE: SOURCE_IMPORT},
-                data={
-                    CONF_PLATFORM: domain_config[-1][CONF_PLATFORM],
-                    CONF_API_KEY: domain_config[-1][CONF_API_KEY],
-                    CONF_ALLOWED_CHAT_IDS: domain_config[-1][CONF_ALLOWED_CHAT_IDS],
-                    ATTR_PARSER: domain_config[-1][ATTR_PARSER],
-                    CONF_PROXY_URL: domain_config[-1].get(CONF_PROXY_URL),
-                    CONF_URL: domain_config[-1].get(CONF_URL),
-                    CONF_TRUSTED_NETWORKS: trusted_networks_str,
-                    CONF_BOT_COUNT: len(domain_config),
-                },
-            )
-        )
-
     async def async_send_telegram_message(service: ServiceCall) -> ServiceResponse:
         """Handle sending Telegram Bot message service calls."""
 

homeassistant/components/telegram_bot/config_flow.py

@@ -11,20 +11,17 @@
 import voluptuous as vol
 
 from homeassistant.config_entries import (
-    SOURCE_IMPORT,
     SOURCE_RECONFIGURE,
     ConfigFlow,
     ConfigFlowResult,
-    ConfigSubentryData,
     ConfigSubentryFlow,
     OptionsFlow,
     SubentryFlowResult,
 )
 from homeassistant.const import CONF_API_KEY, CONF_PLATFORM, CONF_URL
 from homeassistant.core import callback
-from homeassistant.data_entry_flow import AbortFlow, section
+from homeassistant.data_entry_flow import section
 from homeassistant.helpers import config_validation as cv
-from homeassistant.helpers.issue_registry import IssueSeverity, async_create_issue
 from homeassistant.helpers.network import NoURLAvailableError, get_url
 from homeassistant.helpers.selector import (
     SelectSelector,
@@ -39,18 +36,13 @@
 from .const import (
     ATTR_PARSER,
     BOT_NAME,
-    CONF_ALLOWED_CHAT_IDS,
-    CONF_BOT_COUNT,
     CONF_CHAT_ID,
     CONF_PROXY_URL,
     CONF_TRUSTED_NETWORKS,
     DEFAULT_TRUSTED_NETWORKS,
     DOMAIN,
     ERROR_FIELD,
     ERROR_MESSAGE,
-    ISSUE_DEPRECATED_YAML,
-    ISSUE_DEPRECATED_YAML_HAS_MORE_PLATFORMS,
-    ISSUE_DEPRECATED_YAML_IMPORT_ISSUE_ERROR,
     PARSER_HTML,
     PARSER_MD,
     PARSER_MD2,
@@ -208,111 +200,6 @@ def __init__(self) -> None:
         # for passing data between steps
         self._step_user_data: dict[str, Any] = {}
 
-    # triggered by async_setup() from __init__.py
-    async def async_step_import(self, import_data: dict[str, Any]) -> ConfigFlowResult:
-        """Handle import of config entry from configuration.yaml."""
-
-        telegram_bot: str = f"{import_data[CONF_PLATFORM]} Telegram bot"
-        bot_count: int = import_data[CONF_BOT_COUNT]
-
-        import_data[CONF_TRUSTED_NETWORKS] = ",".join(
-            import_data[CONF_TRUSTED_NETWORKS]
-        )
-        import_data[SECTION_ADVANCED_SETTINGS] = {
-            CONF_PROXY_URL: import_data.get(CONF_PROXY_URL)
-        }
-        try:
-            config_flow_result: ConfigFlowResult = await self.async_step_user(
-                import_data
-            )
-        except AbortFlow:
-            # this happens if the config entry is already imported
-            self._create_issue(ISSUE_DEPRECATED_YAML, telegram_bot, bot_count)
-            raise
-        else:
-            errors: dict[str, str] | None = config_flow_result.get("errors")
-            if errors:
-                error: str = errors.get("base", "unknown")
-                self._create_issue(
-                    error,
-                    telegram_bot,
-                    bot_count,
-                    config_flow_result["description_placeholders"],
-                )
-                return self.async_abort(reason="import_failed")
-
-            subentries: list[ConfigSubentryData] = []
-            allowed_chat_ids: list[int] = import_data[CONF_ALLOWED_CHAT_IDS]
-            assert self._bot is not None, "Bot should be initialized during import"
-            for chat_id in allowed_chat_ids:
-                chat_name: str = await _async_get_chat_name(self._bot, chat_id)
-                subentry: ConfigSubentryData = ConfigSubentryData(
-                    data={CONF_CHAT_ID: chat_id},
-                    subentry_type=CONF_ALLOWED_CHAT_IDS,
-                    title=f"{chat_name} ({chat_id})",
-                    unique_id=str(chat_id),
-                )
-                subentries.append(subentry)
-            config_flow_result["subentries"] = subentries
-
-            self._create_issue(
-                ISSUE_DEPRECATED_YAML,
-                telegram_bot,
-                bot_count,
-                config_flow_result["description_placeholders"],
-            )
-            return config_flow_result
-
-    def _create_issue(
-        self,
-        issue: str,
-        telegram_bot_type: str,
-        bot_count: int,
-        description_placeholders: Mapping[str, str] | None = None,
-    ) -> None:
-        translation_key: str = (
-            ISSUE_DEPRECATED_YAML
-            if bot_count == 1
-            else ISSUE_DEPRECATED_YAML_HAS_MORE_PLATFORMS
-        )
-        if issue != ISSUE_DEPRECATED_YAML:
-            translation_key = ISSUE_DEPRECATED_YAML_IMPORT_ISSUE_ERROR
-
-        telegram_bot = (
-            description_placeholders.get(BOT_NAME, telegram_bot_type)
-            if description_placeholders
-            else telegram_bot_type
-        )
-        error_field = (
-            description_placeholders.get(ERROR_FIELD, "Unknown error")
-            if description_placeholders
-            else "Unknown error"
-        )
-        error_message = (
-            description_placeholders.get(ERROR_MESSAGE, "Unknown error")
-            if description_placeholders
-            else "Unknown error"
-        )
-
-        async_create_issue(
-            self.hass,
-            DOMAIN,
-            ISSUE_DEPRECATED_YAML,
-            breaks_in_ha_version="2025.12.0",
-            is_fixable=False,
-            issue_domain=DOMAIN,
-            severity=IssueSeverity.WARNING,
-            translation_key=translation_key,
-            translation_placeholders={
-                "domain": DOMAIN,
-                "integration_title": "Telegram Bot",
-                "telegram_bot": telegram_bot,
-                ERROR_FIELD: error_field,
-                ERROR_MESSAGE: error_message,
-            },
-            learn_more_url="https://github.com/home-assistant/core/pull/144617",
-        )
-
     async def async_step_user(
         self, user_input: dict[str, Any] | None = None
     ) -> ConfigFlowResult:
@@ -361,23 +248,13 @@ async def async_step_user(
                         CONF_PROXY_URL
                     ),
                 },
-                options={
-                    # this value may come from yaml import
-                    ATTR_PARSER: user_input.get(ATTR_PARSER, PARSER_MD)
-                },
+                options={ATTR_PARSER: PARSER_MD},
                 description_placeholders=description_placeholders,
             )
 
         self._bot_name = bot_name
         self._step_user_data.update(user_input)
 
-        if self.source == SOURCE_IMPORT:
-            return await self.async_step_webhooks(
-                {
-                    CONF_URL: user_input.get(CONF_URL),
-                    CONF_TRUSTED_NETWORKS: user_input[CONF_TRUSTED_NETWORKS],
-                }
-            )
         return await self.async_step_webhooks()
 
     async def _shutdown_bot(self) -> None:

homeassistant/components/telegram_bot/const.py

@@ -10,7 +10,6 @@
 SECTION_ADVANCED_SETTINGS = "advanced_settings"
 SUBENTRY_TYPE_ALLOWED_CHAT_IDS = "allowed_chat_ids"
 
-CONF_BOT_COUNT = "bot_count"
 CONF_ALLOWED_CHAT_IDS = "allowed_chat_ids"
 CONF_CONFIG_ENTRY_ID = "config_entry_id"
 
@@ -24,12 +23,6 @@
 ERROR_FIELD = "error_field"
 ERROR_MESSAGE = "error_message"
 
-ISSUE_DEPRECATED_YAML = "deprecated_yaml"
-ISSUE_DEPRECATED_YAML_HAS_MORE_PLATFORMS = (
-    "deprecated_yaml_import_issue_has_more_platforms"
-)
-ISSUE_DEPRECATED_YAML_IMPORT_ISSUE_ERROR = "deprecated_yaml_import_issue_error"
-
 DEFAULT_TRUSTED_NETWORKS = [ip_network("149.154.160.0/20"), ip_network("91.108.4.0/22")]
 
 SERVICE_SEND_CHAT_ACTION = "send_chat_action"

homeassistant/components/telegram_bot/strings.json

@@ -220,18 +220,6 @@
         }
       },
       "title": "The `timeout` parameter for {integration_title} is being removed"
-    },
-    "deprecated_yaml": {
-      "description": "Configuring {integration_title} using YAML is being removed.\n\nYour existing YAML configuration has been imported into the UI automatically.\n\nRemove the `{domain}` configuration from your configuration.yaml file and restart Home Assistant to fix this issue.",
-      "title": "The {integration_title} YAML configuration is being removed"
-    },
-    "deprecated_yaml_import_issue_error": {
-      "description": "Configuring {integration_title} using YAML is being removed but there was an error while importing your existing configuration ({telegram_bot}): {error_message}.\nSetup will not proceed.\n\nVerify that your {telegram_bot} is operating correctly and restart Home Assistant to attempt the import again.\n\nAlternatively, you may remove the `{domain}` configuration from your configuration.yaml entirely, restart Home Assistant, and add the {integration_title} integration manually.",
-      "title": "YAML import failed due to invalid {error_field}"
-    },
-    "deprecated_yaml_import_issue_has_more_platforms": {
-      "description": "Configuring {integration_title} using YAML is being removed.\n\nThe last entry of your existing YAML configuration ({telegram_bot}) has been imported into the UI automatically.\n\nRemove the `{domain}` configuration from your configuration.yaml file and restart Home Assistant to fix this issue. The other Telegram bots will need to be configured manually in the UI.",
-      "title": "The {integration_title} YAML configuration is being removed"
     }
   },
   "options": {