Remove timeout parameter for Telegram bot actions (home-assistant#155198)

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

Author: hanwg

homeassistant/components/telegram_bot/__init__.py

@@ -12,10 +12,14 @@
 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,
@@ -34,8 +38,8 @@
     HomeAssistantError,
     ServiceValidationError,
 )
-from homeassistant.helpers import config_validation as cv
-from homeassistant.helpers.typing import ConfigType
+from homeassistant.helpers import config_validation as cv, issue_registry as ir
+from homeassistant.helpers.typing import ConfigType, VolSchemaType
 
 from . import broadcast, polling, webhooks
 from .bot import TelegramBotConfigEntry, TelegramNotificationService, initialize_bot
@@ -165,31 +169,37 @@
     extra=vol.ALLOW_EXTRA,
 )
 
-SERVICE_SCHEMA_SEND_MESSAGE = BASE_SERVICE_SCHEMA.extend(
-    {vol.Required(ATTR_MESSAGE): cv.string, vol.Optional(ATTR_TITLE): cv.string}
+SERVICE_SCHEMA_SEND_MESSAGE = vol.All(
+    cv.deprecated(ATTR_TIMEOUT),
+    BASE_SERVICE_SCHEMA.extend(
+        {vol.Required(ATTR_MESSAGE): cv.string, vol.Optional(ATTR_TITLE): cv.string}
+    ),
 )
 
-SERVICE_SCHEMA_SEND_CHAT_ACTION = BASE_SERVICE_SCHEMA.extend(
-    {
-        vol.Required(ATTR_CHAT_ACTION): vol.In(
-            (
-                CHAT_ACTION_TYPING,
-                CHAT_ACTION_UPLOAD_PHOTO,
-                CHAT_ACTION_RECORD_VIDEO,
-                CHAT_ACTION_UPLOAD_VIDEO,
-                CHAT_ACTION_RECORD_VOICE,
-                CHAT_ACTION_UPLOAD_VOICE,
-                CHAT_ACTION_UPLOAD_DOCUMENT,
-                CHAT_ACTION_CHOOSE_STICKER,
-                CHAT_ACTION_FIND_LOCATION,
-                CHAT_ACTION_RECORD_VIDEO_NOTE,
-                CHAT_ACTION_UPLOAD_VIDEO_NOTE,
-            )
-        ),
-    }
+SERVICE_SCHEMA_SEND_CHAT_ACTION = vol.All(
+    cv.deprecated(ATTR_TIMEOUT),
+    BASE_SERVICE_SCHEMA.extend(
+        {
+            vol.Required(ATTR_CHAT_ACTION): vol.In(
+                (
+                    CHAT_ACTION_TYPING,
+                    CHAT_ACTION_UPLOAD_PHOTO,
+                    CHAT_ACTION_RECORD_VIDEO,
+                    CHAT_ACTION_UPLOAD_VIDEO,
+                    CHAT_ACTION_RECORD_VOICE,
+                    CHAT_ACTION_UPLOAD_VOICE,
+                    CHAT_ACTION_UPLOAD_DOCUMENT,
+                    CHAT_ACTION_CHOOSE_STICKER,
+                    CHAT_ACTION_FIND_LOCATION,
+                    CHAT_ACTION_RECORD_VIDEO_NOTE,
+                    CHAT_ACTION_UPLOAD_VIDEO_NOTE,
+                )
+            ),
+        }
+    ),
 )
 
-SERVICE_SCHEMA_SEND_FILE = BASE_SERVICE_SCHEMA.extend(
+SERVICE_SCHEMA_BASE_SEND_FILE = BASE_SERVICE_SCHEMA.extend(
     {
         vol.Optional(ATTR_URL): cv.string,
         vol.Optional(ATTR_FILE): cv.string,
@@ -201,68 +211,83 @@
     }
 )
 
-SERVICE_SCHEMA_SEND_STICKER = SERVICE_SCHEMA_SEND_FILE.extend(
-    {vol.Optional(ATTR_STICKER_ID): cv.string}
+SERVICE_SCHEMA_SEND_FILE = vol.All(
+    cv.deprecated(ATTR_TIMEOUT), SERVICE_SCHEMA_BASE_SEND_FILE
 )
 
-SERVICE_SCHEMA_SEND_LOCATION = BASE_SERVICE_SCHEMA.extend(
-    {
-        vol.Required(ATTR_LONGITUDE): cv.string,
-        vol.Required(ATTR_LATITUDE): cv.string,
-    }
+
+SERVICE_SCHEMA_SEND_STICKER = vol.All(
+    cv.deprecated(ATTR_TIMEOUT),
+    SERVICE_SCHEMA_BASE_SEND_FILE.extend({vol.Optional(ATTR_STICKER_ID): cv.string}),
 )
 
-SERVICE_SCHEMA_SEND_POLL = vol.Schema(
-    {
-        vol.Optional(CONF_CONFIG_ENTRY_ID): cv.string,
-        vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [vol.Coerce(int)]),
-        vol.Required(ATTR_QUESTION): cv.string,
-        vol.Required(ATTR_OPTIONS): vol.All(cv.ensure_list, [cv.string]),
-        vol.Optional(ATTR_OPEN_PERIOD): cv.positive_int,
-        vol.Optional(ATTR_IS_ANONYMOUS, default=True): cv.boolean,
-        vol.Optional(ATTR_ALLOWS_MULTIPLE_ANSWERS, default=False): cv.boolean,
-        vol.Optional(ATTR_DISABLE_NOTIF): cv.boolean,
-        vol.Optional(ATTR_TIMEOUT): cv.positive_int,
-        vol.Optional(ATTR_MESSAGE_THREAD_ID): vol.Coerce(int),
-    }
+SERVICE_SCHEMA_SEND_LOCATION = vol.All(
+    cv.deprecated(ATTR_TIMEOUT),
+    BASE_SERVICE_SCHEMA.extend(
+        {
+            vol.Required(ATTR_LONGITUDE): cv.string,
+            vol.Required(ATTR_LATITUDE): cv.string,
+        }
+    ),
 )
 
-SERVICE_SCHEMA_EDIT_MESSAGE = SERVICE_SCHEMA_SEND_MESSAGE.extend(
-    {
-        vol.Required(ATTR_MESSAGEID): vol.Any(
-            cv.positive_int, vol.All(cv.string, "last")
-        ),
-        vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
-    }
+SERVICE_SCHEMA_SEND_POLL = vol.All(
+    cv.deprecated(ATTR_TIMEOUT),
+    vol.Schema(
+        {
+            vol.Optional(CONF_CONFIG_ENTRY_ID): cv.string,
+            vol.Optional(ATTR_TARGET): vol.All(cv.ensure_list, [vol.Coerce(int)]),
+            vol.Required(ATTR_QUESTION): cv.string,
+            vol.Required(ATTR_OPTIONS): vol.All(cv.ensure_list, [cv.string]),
+            vol.Optional(ATTR_OPEN_PERIOD): cv.positive_int,
+            vol.Optional(ATTR_IS_ANONYMOUS, default=True): cv.boolean,
+            vol.Optional(ATTR_ALLOWS_MULTIPLE_ANSWERS, default=False): cv.boolean,
+            vol.Optional(ATTR_DISABLE_NOTIF): cv.boolean,
+            vol.Optional(ATTR_MESSAGE_THREAD_ID): vol.Coerce(int),
+        }
+    ),
 )
 
-SERVICE_SCHEMA_EDIT_MESSAGE_MEDIA = vol.Schema(
-    {
-        vol.Optional(CONF_CONFIG_ENTRY_ID): cv.string,
-        vol.Required(ATTR_MESSAGEID): vol.Any(
-            cv.positive_int, vol.All(cv.string, "last")
-        ),
-        vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
-        vol.Optional(ATTR_TIMEOUT): cv.positive_int,
-        vol.Optional(ATTR_CAPTION): cv.string,
-        vol.Required(ATTR_MEDIA_TYPE): vol.In(
-            (
-                str(InputMediaType.ANIMATION),
-                str(InputMediaType.AUDIO),
-                str(InputMediaType.VIDEO),
-                str(InputMediaType.DOCUMENT),
-                str(InputMediaType.PHOTO),
-            )
-        ),
-        vol.Optional(ATTR_URL): cv.string,
-        vol.Optional(ATTR_FILE): cv.string,
-        vol.Optional(ATTR_USERNAME): cv.string,
-        vol.Optional(ATTR_PASSWORD): cv.string,
-        vol.Optional(ATTR_AUTHENTICATION): cv.string,
-        vol.Optional(ATTR_VERIFY_SSL): cv.boolean,
-        vol.Optional(ATTR_KEYBOARD_INLINE): cv.ensure_list,
-    },
-    extra=vol.ALLOW_EXTRA,
+SERVICE_SCHEMA_EDIT_MESSAGE = vol.All(
+    cv.deprecated(ATTR_TIMEOUT),
+    SERVICE_SCHEMA_BASE_SEND_FILE.extend(
+        {
+            vol.Required(ATTR_MESSAGEID): vol.Any(
+                cv.positive_int, vol.All(cv.string, "last")
+            ),
+            vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
+        }
+    ),
+)
+
+SERVICE_SCHEMA_EDIT_MESSAGE_MEDIA = vol.All(
+    cv.deprecated(ATTR_TIMEOUT),
+    vol.Schema(
+        {
+            vol.Optional(CONF_CONFIG_ENTRY_ID): cv.string,
+            vol.Required(ATTR_MESSAGEID): vol.Any(
+                cv.positive_int, vol.All(cv.string, "last")
+            ),
+            vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
+            vol.Optional(ATTR_CAPTION): cv.string,
+            vol.Required(ATTR_MEDIA_TYPE): vol.In(
+                (
+                    str(InputMediaType.ANIMATION),
+                    str(InputMediaType.AUDIO),
+                    str(InputMediaType.VIDEO),
+                    str(InputMediaType.DOCUMENT),
+                    str(InputMediaType.PHOTO),
+                )
+            ),
+            vol.Optional(ATTR_URL): cv.string,
+            vol.Optional(ATTR_FILE): cv.string,
+            vol.Optional(ATTR_USERNAME): cv.string,
+            vol.Optional(ATTR_PASSWORD): cv.string,
+            vol.Optional(ATTR_AUTHENTICATION): cv.string,
+            vol.Optional(ATTR_VERIFY_SSL): cv.boolean,
+            vol.Optional(ATTR_KEYBOARD_INLINE): cv.ensure_list,
+        }
+    ),
 )
 
 SERVICE_SCHEMA_EDIT_CAPTION = vol.Schema(
@@ -274,8 +299,7 @@
         vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
         vol.Required(ATTR_CAPTION): cv.string,
         vol.Optional(ATTR_KEYBOARD_INLINE): cv.ensure_list,
-    },
-    extra=vol.ALLOW_EXTRA,
+    }
 )
 
 SERVICE_SCHEMA_EDIT_REPLYMARKUP = vol.Schema(
@@ -286,8 +310,7 @@
         ),
         vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
         vol.Required(ATTR_KEYBOARD_INLINE): cv.ensure_list,
-    },
-    extra=vol.ALLOW_EXTRA,
+    }
 )
 
 SERVICE_SCHEMA_ANSWER_CALLBACK_QUERY = vol.Schema(
@@ -296,8 +319,7 @@
         vol.Required(ATTR_MESSAGE): cv.string,
         vol.Required(ATTR_CALLBACK_QUERY_ID): vol.Coerce(int),
         vol.Optional(ATTR_SHOW_ALERT): cv.boolean,
-    },
-    extra=vol.ALLOW_EXTRA,
+    }
 )
 
 SERVICE_SCHEMA_DELETE_MESSAGE = vol.Schema(
@@ -307,8 +329,7 @@
         vol.Required(ATTR_MESSAGEID): vol.Any(
             cv.positive_int, vol.All(cv.string, "last")
         ),
-    },
-    extra=vol.ALLOW_EXTRA,
+    }
 )
 
 SERVICE_SCHEMA_LEAVE_CHAT = vol.Schema(
@@ -327,11 +348,10 @@
         vol.Required(ATTR_CHAT_ID): vol.Coerce(int),
         vol.Required(ATTR_REACTION): cv.string,
         vol.Optional(ATTR_IS_BIG, default=False): cv.boolean,
-    },
-    extra=vol.ALLOW_EXTRA,
+    }
 )
 
-SERVICE_MAP = {
+SERVICE_MAP: dict[str, VolSchemaType] = {
     SERVICE_SEND_MESSAGE: SERVICE_SCHEMA_SEND_MESSAGE,
     SERVICE_SEND_CHAT_ACTION: SERVICE_SCHEMA_SEND_CHAT_ACTION,
     SERVICE_SEND_PHOTO: SERVICE_SCHEMA_SEND_FILE,
@@ -400,6 +420,9 @@ async def async_send_telegram_message(service: ServiceCall) -> ServiceResponse:
         kwargs = dict(service.data)
         _LOGGER.debug("New telegram message %s: %s", msgtype, kwargs)
 
+        if ATTR_TIMEOUT in service.data:
+            _deprecate_timeout(hass, service)
+
         config_entry_id: str | None = service.data.get(CONF_CONFIG_ENTRY_ID)
         config_entry: TelegramBotConfigEntry | None = None
         if config_entry_id:
@@ -532,6 +555,36 @@ async def async_send_telegram_message(service: ServiceCall) -> ServiceResponse:
     return True
 
 
+def _deprecate_timeout(hass: HomeAssistant, service: ServiceCall) -> None:
+    # default: service was called using frontend such as developer tools or automation editor
+    service_call_origin = "call_service"
+
+    origin = service.context.origin_event
+    if origin and ATTR_ENTITY_ID in origin.data:
+        # automation
+        service_call_origin = origin.data[ATTR_ENTITY_ID]
+    elif origin and origin.data.get(ATTR_DOMAIN) == SCRIPT_DOMAIN:
+        # script
+        service_call_origin = f"{origin.data[ATTR_DOMAIN]}.{origin.data[ATTR_SERVICE]}"
+
+    ir.async_create_issue(
+        hass,
+        DOMAIN,
+        "deprecated_timeout_parameter",
+        breaks_in_ha_version="2026.7.0",
+        is_fixable=True,
+        is_persistent=True,
+        severity=ir.IssueSeverity.WARNING,
+        translation_key="deprecated_timeout_parameter",
+        translation_placeholders={
+            "integration_title": "Telegram Bot",
+            "action": f"{DOMAIN}.{service.service}",
+            "action_origin": service_call_origin,
+        },
+        learn_more_url="https://github.com/home-assistant/core/pull/155198",
+    )
+
+
 async def async_setup_entry(hass: HomeAssistant, entry: TelegramBotConfigEntry) -> bool:
     """Create the Telegram bot from config entry."""
     bot: Bot = await hass.async_add_executor_job(initialize_bot, hass, entry.data)

homeassistant/components/telegram_bot/bot.py

@@ -448,7 +448,7 @@ def _make_row_inline_keyboard(row_keyboard: Any) -> list[InlineKeyboardButton]:
                 params[ATTR_MESSAGE_THREAD_ID] = data[ATTR_MESSAGE_THREAD_ID]
             # Keyboards:
             if ATTR_KEYBOARD in data:
-                keys = data.get(ATTR_KEYBOARD)
+                keys = data[ATTR_KEYBOARD]
                 keys = keys if isinstance(keys, list) else [keys]
                 if keys:
                     params[ATTR_REPLYMARKUP] = ReplyKeyboardMarkup(