#!/usr/bin/env python # # A library that provides a Python interface to the Telegram Bot API # Copyright (C) 2015-2023 # Leandro Toledo de Souza # # This program is free software: you can redistribute it and/or modify # it under the terms of the GNU Lesser Public License as published by # the Free Software Foundation, either version 3 of the License, or # (at your option) any later version. # # This program is distributed in the hope that it will be useful, # but WITHOUT ANY WARRANTY; without even the implied warranty of # MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the # GNU Lesser Public License for more details. # # You should have received a copy of the GNU Lesser Public License # along with this program. If not, see [http://www.gnu.org/licenses/]. """This module contains the classes that represent Telegram InlineQueryResultGif.""" from typing import TYPE_CHECKING, Optional, Sequence, Tuple from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup from telegram._inline.inlinequeryresult import InlineQueryResult from telegram._messageentity import MessageEntity from telegram._utils.argumentparsing import parse_sequence_arg from telegram._utils.defaultvalue import DEFAULT_NONE from telegram._utils.types import JSONDict, ODVInput from telegram._utils.warnings_transition import ( warn_about_deprecated_arg_return_new_arg, warn_about_deprecated_attr_in_property, ) from telegram.constants import InlineQueryResultType if TYPE_CHECKING: from telegram import InputMessageContent class InlineQueryResultGif(InlineQueryResult): """ Represents a link to an animated GIF file. By default, this animated GIF file will be sent by the user with optional caption. Alternatively, you can use :attr:`input_message_content` to send a message with the specified content instead of the animation. .. seealso:: :wiki:`Working with Files and Media ` Args: id (:obj:`str`): Unique identifier for this result, :tg-const:`telegram.InlineQueryResult.MIN_ID_LENGTH`- :tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes. gif_url (:obj:`str`): A valid URL for the GIF file. File size must not exceed 1MB. gif_width (:obj:`int`, optional): Width of the GIF. gif_height (:obj:`int`, optional): Height of the GIF. gif_duration (:obj:`int`, optional): Duration of the GIF in seconds. thumbnail_url (:obj:`str`, optional): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. Warning: The Bot API does **not** define this as an optional argument. It is formally optional for backwards compatibility with the deprecated :paramref:`thumb_url`. If you pass neither :paramref:`thumbnail_url` nor :paramref:`thumb_url`, :class:`ValueError` will be raised. .. versionadded:: 20.2 thumbnail_mime_type (:obj:`str`, optional): MIME type of the thumbnail, must be one of ``'image/jpeg'``, ``'image/gif'``, or ``'video/mp4'``. Defaults to ``'image/jpeg'``. .. versionadded:: 20.2 title (:obj:`str`, optional): Title for the result. caption (:obj:`str`, optional): Caption of the GIF file to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`, optional): |parse_mode| caption_entities (Sequence[:class:`telegram.MessageEntity`], optional): |caption_entities| .. versionchanged:: 20.0 |sequenceclassargs| reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): Inline keyboard attached to the message. input_message_content (:class:`telegram.InputMessageContent`, optional): Content of the message to be sent instead of the GIF animation. thumb_mime_type (:obj:`str`, optional): MIME type of the thumbnail, must be one of ``'image/jpeg'``, ``'image/gif'``, or ``'video/mp4'``. Defaults to ``'image/jpeg'``. .. deprecated:: 20.2 |thumbargumentdeprecation| :paramref:`thumbnail_mime_type`. thumb_url (:obj:`str`, optional): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. .. deprecated:: 20.2 |thumbargumentdeprecation| :paramref:`thumbnail_url`. Raises: :class:`ValueError`: If neither :paramref:`thumbnail_url` nor :paramref:`thumb_url` is supplied or if both are supplied and are not equal. Attributes: type (:obj:`str`): :tg-const:`telegram.constants.InlineQueryResultType.GIF`. id (:obj:`str`): Unique identifier for this result, :tg-const:`telegram.InlineQueryResult.MIN_ID_LENGTH`- :tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes. gif_url (:obj:`str`): A valid URL for the GIF file. File size must not exceed 1MB. gif_width (:obj:`int`): Optional. Width of the GIF. gif_height (:obj:`int`): Optional. Height of the GIF. gif_duration (:obj:`int`): Optional. Duration of the GIF in seconds. thumbnail_url (:obj:`str`): URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. .. versionadded:: 20.2 thumbnail_mime_type (:obj:`str`): Optional. MIME type of the thumbnail, must be one of ``'image/jpeg'``, ``'image/gif'``, or ``'video/mp4'``. Defaults to ``'image/jpeg'``. .. versionadded:: 20.2 title (:obj:`str`): Optional. Title for the result. caption (:obj:`str`): Optional. Caption of the GIF file to be sent, 0-:tg-const:`telegram.constants.MessageLimit.CAPTION_LENGTH` characters after entities parsing. parse_mode (:obj:`str`): Optional. |parse_mode| caption_entities (Tuple[:class:`telegram.MessageEntity`]): Optional. |captionentitiesattr| .. versionchanged:: 20.0 * |tupleclassattrs| * |alwaystuple| reply_markup (:class:`telegram.InlineKeyboardMarkup`): Optional. Inline keyboard attached to the message. input_message_content (:class:`telegram.InputMessageContent`): Optional. Content of the message to be sent instead of the GIF animation. """ __slots__ = ( "reply_markup", "gif_height", "thumbnail_mime_type", "caption_entities", "gif_width", "title", "caption", "parse_mode", "gif_duration", "input_message_content", "gif_url", "thumbnail_url", ) def __init__( self, id: str, # pylint: disable=redefined-builtin gif_url: str, # thumbnail_url is not optional in Telegram API, but we want to support thumb_url as well, # so thumbnail_url may not be passed. We will raise ValueError manually if neither # thumbnail_url nor thumb_url are passed thumbnail_url: str = None, gif_width: int = None, gif_height: int = None, title: str = None, caption: str = None, reply_markup: InlineKeyboardMarkup = None, input_message_content: "InputMessageContent" = None, gif_duration: int = None, parse_mode: ODVInput[str] = DEFAULT_NONE, thumb_mime_type: str = None, caption_entities: Sequence[MessageEntity] = None, thumbnail_mime_type: str = None, # thumb_url is not optional in Telegram API, but it is here, along with thumbnail_url. thumb_url: str = None, *, api_kwargs: JSONDict = None, ): if not (thumbnail_url or thumb_url): raise ValueError( "You must pass either 'thumbnail_url' or 'thumb_url'. Note that 'thumb_url' is " "deprecated." ) # Required super().__init__(InlineQueryResultType.GIF, id, api_kwargs=api_kwargs) with self._unfrozen(): self.gif_url: str = gif_url self.thumbnail_url: str = warn_about_deprecated_arg_return_new_arg( deprecated_arg=thumb_url, new_arg=thumbnail_url, deprecated_arg_name="thumb_url", new_arg_name="thumbnail_url", bot_api_version="6.6", ) # Optionals self.gif_width: Optional[int] = gif_width self.gif_height: Optional[int] = gif_height self.gif_duration: Optional[int] = gif_duration self.title: Optional[str] = title self.caption: Optional[str] = caption self.parse_mode: ODVInput[str] = parse_mode self.caption_entities: Tuple[MessageEntity, ...] = parse_sequence_arg(caption_entities) self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup self.input_message_content: Optional[InputMessageContent] = input_message_content self.thumbnail_mime_type: Optional[str] = warn_about_deprecated_arg_return_new_arg( deprecated_arg=thumb_mime_type, new_arg=thumbnail_mime_type, deprecated_arg_name="thumb_mime_type", new_arg_name="thumbnail_mime_type", bot_api_version="6.6", ) @property def thumb_url(self) -> str: """:obj:`str`: URL of the static (JPEG or GIF) or animated (MPEG4) thumbnail for the result. .. deprecated:: 20.2 |thumbattributedeprecation| :attr:`thumbnail_url`. """ warn_about_deprecated_attr_in_property( deprecated_attr_name="thumb_url", new_attr_name="thumbnail_url", bot_api_version="6.6", ) return self.thumbnail_url @property def thumb_mime_type(self) -> Optional[str]: """:obj:`str`: Optional. Optional. MIME type of the thumbnail, must be one of ``'image/jpeg'``, ``'image/gif'``, or ``'video/mp4'``. Defaults to ``'image/jpeg'``. .. deprecated:: 20.2 |thumbattributedeprecation| :attr:`thumbnail_mime_type`. """ warn_about_deprecated_attr_in_property( deprecated_attr_name="thumb_mime_type", new_attr_name="thumbnail_mime_type", bot_api_version="6.6", ) return self.thumbnail_mime_type