init commit

.venv/lib/python3.12/site-packages/telegram/_reaction.py

@@ -0,0 +1,232 @@
+#!/usr/bin/env python
+#
+# A library that provides a Python interface to the Telegram Bot API
+# Copyright (C) 2015-2025
+# Leandro Toledo de Souza <devs@python-telegram-bot.org>
+#
+# 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 objects that represents a Telegram ReactionType."""
+
+from typing import TYPE_CHECKING, Final, Literal, Optional, Union
+
+from telegram import constants
+from telegram._telegramobject import TelegramObject
+from telegram._utils import enum
+from telegram._utils.argumentparsing import de_json_optional
+from telegram._utils.types import JSONDict
+
+if TYPE_CHECKING:
+    from telegram import Bot
+
+
+class ReactionType(TelegramObject):
+    """Base class for Telegram ReactionType Objects.
+    There exist :class:`telegram.ReactionTypeEmoji`, :class:`telegram.ReactionTypeCustomEmoji`
+    and :class:`telegram.ReactionTypePaid`.
+
+    .. versionadded:: 20.8
+    .. versionchanged:: 21.5
+
+        Added paid reaction.
+
+    Args:
+        type (:obj:`str`): Type of the reaction. Can be
+            :attr:`~telegram.ReactionType.EMOJI`, :attr:`~telegram.ReactionType.CUSTOM_EMOJI` or
+            :attr:`~telegram.ReactionType.PAID`.
+    Attributes:
+        type (:obj:`str`): Type of the reaction. Can be
+            :attr:`~telegram.ReactionType.EMOJI`, :attr:`~telegram.ReactionType.CUSTOM_EMOJI` or
+            :attr:`~telegram.ReactionType.PAID`.
+
+    """
+
+    __slots__ = ("type",)
+
+    EMOJI: Final[constants.ReactionType] = constants.ReactionType.EMOJI
+    """:const:`telegram.constants.ReactionType.EMOJI`"""
+    CUSTOM_EMOJI: Final[constants.ReactionType] = constants.ReactionType.CUSTOM_EMOJI
+    """:const:`telegram.constants.ReactionType.CUSTOM_EMOJI`"""
+    PAID: Final[constants.ReactionType] = constants.ReactionType.PAID
+    """:const:`telegram.constants.ReactionType.PAID`
+
+    .. versionadded:: 21.5
+    """
+
+    def __init__(
+        self,
+        type: Union[  # pylint: disable=redefined-builtin
+            Literal["emoji", "custom_emoji", "paid"], constants.ReactionType
+        ],
+        *,
+        api_kwargs: Optional[JSONDict] = None,
+    ):
+        super().__init__(api_kwargs=api_kwargs)
+        # Required by all subclasses
+        self.type: str = enum.get_member(constants.ReactionType, type, type)
+
+        self._freeze()
+
+    @classmethod
+    def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "ReactionType":
+        """See :meth:`telegram.TelegramObject.de_json`."""
+        data = cls._parse_data(data)
+
+        _class_mapping: dict[str, type[ReactionType]] = {
+            cls.EMOJI: ReactionTypeEmoji,
+            cls.CUSTOM_EMOJI: ReactionTypeCustomEmoji,
+            cls.PAID: ReactionTypePaid,
+        }
+
+        if cls is ReactionType and data.get("type") in _class_mapping:
+            return _class_mapping[data.pop("type")].de_json(data, bot)
+
+        return super().de_json(data=data, bot=bot)
+
+
+class ReactionTypeEmoji(ReactionType):
+    """
+    Represents a reaction with a normal emoji.
+
+    Objects of this class are comparable in terms of equality. Two objects of this class are
+    considered equal, if the :attr:`emoji` is equal.
+
+    .. versionadded:: 20.8
+
+    Args:
+        emoji (:obj:`str`): Reaction emoji. It can be one of
+            :const:`telegram.constants.ReactionEmoji`.
+
+    Attributes:
+        type (:obj:`str`): Type of the reaction,
+            always :tg-const:`telegram.ReactionType.EMOJI`.
+        emoji (:obj:`str`): Reaction emoji. It can be one of
+        :const:`telegram.constants.ReactionEmoji`.
+    """
+
+    __slots__ = ("emoji",)
+
+    def __init__(
+        self,
+        emoji: str,
+        *,
+        api_kwargs: Optional[JSONDict] = None,
+    ):
+        super().__init__(type=ReactionType.EMOJI, api_kwargs=api_kwargs)
+
+        with self._unfrozen():
+            self.emoji: str = emoji
+            self._id_attrs = (self.emoji,)
+
+
+class ReactionTypeCustomEmoji(ReactionType):
+    """
+    Represents a reaction with a custom emoji.
+
+    Objects of this class are comparable in terms of equality. Two objects of this class are
+    considered equal, if the :attr:`custom_emoji_id` is equal.
+
+    .. versionadded:: 20.8
+
+    Args:
+        custom_emoji_id (:obj:`str`): Custom emoji identifier.
+
+    Attributes:
+        type (:obj:`str`): Type of the reaction,
+            always :tg-const:`telegram.ReactionType.CUSTOM_EMOJI`.
+        custom_emoji_id (:obj:`str`): Custom emoji identifier.
+
+    """
+
+    __slots__ = ("custom_emoji_id",)
+
+    def __init__(
+        self,
+        custom_emoji_id: str,
+        *,
+        api_kwargs: Optional[JSONDict] = None,
+    ):
+        super().__init__(type=ReactionType.CUSTOM_EMOJI, api_kwargs=api_kwargs)
+
+        with self._unfrozen():
+            self.custom_emoji_id: str = custom_emoji_id
+            self._id_attrs = (self.custom_emoji_id,)
+
+
+class ReactionTypePaid(ReactionType):
+    """
+    The reaction is paid.
+
+    .. versionadded:: 21.5
+
+    Attributes:
+        type (:obj:`str`): Type of the reaction,
+            always :tg-const:`telegram.ReactionType.PAID`.
+    """
+
+    __slots__ = ()
+
+    def __init__(self, *, api_kwargs: Optional[JSONDict] = None):
+        super().__init__(type=ReactionType.PAID, api_kwargs=api_kwargs)
+        self._freeze()
+
+
+class ReactionCount(TelegramObject):
+    """This class represents a reaction added to a message along with the number of times it was
+    added.
+
+    Objects of this class are comparable in terms of equality. Two objects of this class are
+    considered equal, if the :attr:`type` and :attr:`total_count` is equal.
+
+    .. versionadded:: 20.8
+
+    Args:
+        type (:class:`telegram.ReactionType`): Type of the reaction.
+        total_count (:obj:`int`): Number of times the reaction was added.
+
+    Attributes:
+        type (:class:`telegram.ReactionType`): Type of the reaction.
+        total_count (:obj:`int`): Number of times the reaction was added.
+    """
+
+    __slots__ = (
+        "total_count",
+        "type",
+    )
+
+    def __init__(
+        self,
+        type: ReactionType,  # pylint: disable=redefined-builtin
+        total_count: int,
+        *,
+        api_kwargs: Optional[JSONDict] = None,
+    ):
+        super().__init__(api_kwargs=api_kwargs)
+        # Required
+        self.type: ReactionType = type
+        self.total_count: int = total_count
+
+        self._id_attrs = (
+            self.type,
+            self.total_count,
+        )
+        self._freeze()
+
+    @classmethod
+    def de_json(cls, data: JSONDict, bot: Optional["Bot"] = None) -> "ReactionCount":
+        """See :meth:`telegram.TelegramObject.de_json`."""
+        data = cls._parse_data(data)
+
+        data["type"] = de_json_optional(data.get("type"), ReactionType, bot)
+
+        return super().de_json(data=data, bot=bot)