mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-24 16:17:37 +01:00
208 lines
7.8 KiB
Python
208 lines
7.8 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2024
|
|
# 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 an object that represents a Telegram MessageReaction Update."""
|
|
from datetime import datetime
|
|
from typing import TYPE_CHECKING, Optional, Sequence, Tuple
|
|
|
|
from telegram._chat import Chat
|
|
from telegram._reaction import ReactionCount, ReactionType
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._user import User
|
|
from telegram._utils.argumentparsing import parse_sequence_arg
|
|
from telegram._utils.datetime import extract_tzinfo_from_defaults, from_timestamp
|
|
from telegram._utils.types import JSONDict
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import Bot
|
|
|
|
|
|
class MessageReactionCountUpdated(TelegramObject):
|
|
"""This class represents reaction changes on a message with anonymous reactions.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if the :attr:`chat`, :attr:`message_id`, :attr:`date` and :attr:`reactions`
|
|
is equal.
|
|
|
|
.. versionadded:: 20.8
|
|
|
|
Args:
|
|
chat (:class:`telegram.Chat`): The chat containing the message.
|
|
message_id (:obj:`int`): Unique message identifier inside the chat.
|
|
date (:class:`datetime.datetime`): Date of the change in Unix time
|
|
|datetime_localization|
|
|
reactions (Sequence[:class:`telegram.ReactionCount`]): List of reactions that are present
|
|
on the message
|
|
|
|
Attributes:
|
|
chat (:class:`telegram.Chat`): The chat containing the message.
|
|
message_id (:obj:`int`): Unique message identifier inside the chat.
|
|
date (:class:`datetime.datetime`): Date of the change in Unix time
|
|
|datetime_localization|
|
|
reactions (Tuple[:class:`telegram.ReactionCount`]): List of reactions that are present on
|
|
the message
|
|
"""
|
|
|
|
__slots__ = (
|
|
"chat",
|
|
"date",
|
|
"message_id",
|
|
"reactions",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
chat: Chat,
|
|
message_id: int,
|
|
date: datetime,
|
|
reactions: Sequence[ReactionCount],
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
# Required
|
|
self.chat: Chat = chat
|
|
self.message_id: int = message_id
|
|
self.date: datetime = date
|
|
self.reactions: Tuple[ReactionCount, ...] = parse_sequence_arg(reactions)
|
|
|
|
self._id_attrs = (self.chat, self.message_id, self.date, self.reactions)
|
|
self._freeze()
|
|
|
|
@classmethod
|
|
def de_json(
|
|
cls, data: Optional[JSONDict], bot: Optional["Bot"] = None
|
|
) -> Optional["MessageReactionCountUpdated"]:
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
data = cls._parse_data(data)
|
|
|
|
if not data:
|
|
return None
|
|
|
|
# Get the local timezone from the bot if it has defaults
|
|
loc_tzinfo = extract_tzinfo_from_defaults(bot)
|
|
|
|
data["date"] = from_timestamp(data.get("date"), tzinfo=loc_tzinfo)
|
|
data["chat"] = Chat.de_json(data.get("chat"), bot)
|
|
data["reactions"] = ReactionCount.de_list(data.get("reactions"), bot)
|
|
|
|
return super().de_json(data=data, bot=bot)
|
|
|
|
|
|
class MessageReactionUpdated(TelegramObject):
|
|
"""This class represents a change of a reaction on a message performed by a user.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if the :attr:`chat`, :attr:`message_id`, :attr:`date`, :attr:`old_reaction`
|
|
and :attr:`new_reaction` is equal.
|
|
|
|
.. versionadded:: 20.8
|
|
|
|
Args:
|
|
chat (:class:`telegram.Chat`): The chat containing the message.
|
|
message_id (:obj:`int`): Unique message identifier inside the chat.
|
|
date (:class:`datetime.datetime`): Date of the change in Unix time.
|
|
|datetime_localization|
|
|
old_reaction (Sequence[:class:`telegram.ReactionType`]): Previous list of reaction types
|
|
that were set by the user.
|
|
new_reaction (Sequence[:class:`telegram.ReactionType`]): New list of reaction types that
|
|
were set by the user.
|
|
user (:class:`telegram.User`, optional): The user that changed the reaction, if the user
|
|
isn't anonymous.
|
|
actor_chat (:class:`telegram.Chat`, optional): The chat on behalf of which the reaction was
|
|
changed, if the user is anonymous.
|
|
|
|
Attributes:
|
|
chat (:class:`telegram.Chat`): The chat containing the message.
|
|
message_id (:obj:`int`): Unique message identifier inside the chat.
|
|
date (:class:`datetime.datetime`): Date of the change in Unix time.
|
|
|datetime_localization|
|
|
old_reaction (Tuple[:class:`telegram.ReactionType`]): Previous list of reaction types
|
|
that were set by the user.
|
|
new_reaction (Tuple[:class:`telegram.ReactionType`]): New list of reaction types that
|
|
were set by the user.
|
|
user (:class:`telegram.User`): Optional. The user that changed the reaction, if the user
|
|
isn't anonymous.
|
|
actor_chat (:class:`telegram.Chat`): Optional. The chat on behalf of which the reaction was
|
|
changed, if the user is anonymous.
|
|
"""
|
|
|
|
__slots__ = (
|
|
"actor_chat",
|
|
"chat",
|
|
"date",
|
|
"message_id",
|
|
"new_reaction",
|
|
"old_reaction",
|
|
"user",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
chat: Chat,
|
|
message_id: int,
|
|
date: datetime,
|
|
old_reaction: Sequence[ReactionType],
|
|
new_reaction: Sequence[ReactionType],
|
|
user: Optional[User] = None,
|
|
actor_chat: Optional[Chat] = None,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
# Required
|
|
self.chat: Chat = chat
|
|
self.message_id: int = message_id
|
|
self.date: datetime = date
|
|
self.old_reaction: Tuple[ReactionType, ...] = parse_sequence_arg(old_reaction)
|
|
self.new_reaction: Tuple[ReactionType, ...] = parse_sequence_arg(new_reaction)
|
|
|
|
# Optional
|
|
self.user: Optional[User] = user
|
|
self.actor_chat: Optional[Chat] = actor_chat
|
|
|
|
self._id_attrs = (
|
|
self.chat,
|
|
self.message_id,
|
|
self.date,
|
|
self.old_reaction,
|
|
self.new_reaction,
|
|
)
|
|
self._freeze()
|
|
|
|
@classmethod
|
|
def de_json(
|
|
cls, data: Optional[JSONDict], bot: Optional["Bot"] = None
|
|
) -> Optional["MessageReactionUpdated"]:
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
data = cls._parse_data(data)
|
|
|
|
if not data:
|
|
return None
|
|
|
|
# Get the local timezone from the bot if it has defaults
|
|
loc_tzinfo = extract_tzinfo_from_defaults(bot)
|
|
|
|
data["date"] = from_timestamp(data.get("date"), tzinfo=loc_tzinfo)
|
|
data["chat"] = Chat.de_json(data.get("chat"), bot)
|
|
data["old_reaction"] = ReactionType.de_list(data.get("old_reaction"), bot)
|
|
data["new_reaction"] = ReactionType.de_list(data.get("new_reaction"), bot)
|
|
data["user"] = User.de_json(data.get("user"), bot)
|
|
data["actor_chat"] = Chat.de_json(data.get("actor_chat"), bot)
|
|
|
|
return super().de_json(data=data, bot=bot)
|