2016-10-03 20:09:57 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2023-01-01 21:31:29 +01:00
|
|
|
# Copyright (C) 2015-2023
|
2016-10-03 20:09:57 +02:00
|
|
|
# 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/].
|
2016-10-17 00:22:40 +02:00
|
|
|
"""This module contains an object that represents a Telegram GameHighScore."""
|
2016-10-03 20:09:57 +02:00
|
|
|
|
2020-10-31 16:33:34 +01:00
|
|
|
from typing import TYPE_CHECKING, Optional
|
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram._telegramobject import TelegramObject
|
|
|
|
from telegram._user import User
|
2021-10-10 15:10:21 +02:00
|
|
|
from telegram._utils.types import JSONDict
|
2020-10-09 17:22:07 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
if TYPE_CHECKING:
|
|
|
|
from telegram import Bot
|
2016-10-03 20:09:57 +02:00
|
|
|
|
|
|
|
|
|
|
|
class GameHighScore(TelegramObject):
|
2017-09-01 08:43:08 +02:00
|
|
|
"""This object represents one row of the high scores table for a game.
|
2016-10-04 01:01:06 +02:00
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
|
|
considered equal, if their :attr:`position`, :attr:`user` and :attr:`score` are equal.
|
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
Args:
|
2017-07-23 22:33:08 +02:00
|
|
|
position (:obj:`int`): Position in high score table for the game.
|
|
|
|
user (:class:`telegram.User`): User.
|
|
|
|
score (:obj:`int`): Score.
|
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
Attributes:
|
2017-07-23 22:33:08 +02:00
|
|
|
position (:obj:`int`): Position in high score table for the game.
|
|
|
|
user (:class:`telegram.User`): User.
|
|
|
|
score (:obj:`int`): Score.
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2016-10-04 01:01:06 +02:00
|
|
|
"""
|
2016-10-03 20:09:57 +02:00
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
__slots__ = ("position", "user", "score")
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2023-05-18 07:57:59 +02:00
|
|
|
def __init__(
|
|
|
|
self, position: int, user: User, score: int, *, api_kwargs: Optional[JSONDict] = None
|
|
|
|
):
|
2022-10-07 11:51:53 +02:00
|
|
|
super().__init__(api_kwargs=api_kwargs)
|
2023-02-02 18:55:07 +01:00
|
|
|
self.position: int = position
|
|
|
|
self.user: User = user
|
|
|
|
self.score: int = score
|
2016-10-03 20:09:57 +02:00
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
self._id_attrs = (self.position, self.user, self.score)
|
|
|
|
|
2022-12-15 15:00:36 +01:00
|
|
|
self._freeze()
|
|
|
|
|
2017-07-23 21:14:38 +02:00
|
|
|
@classmethod
|
2022-05-05 17:40:22 +02:00
|
|
|
def de_json(cls, data: Optional[JSONDict], bot: "Bot") -> Optional["GameHighScore"]:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
|
|
data = cls._parse_data(data)
|
2020-10-06 19:28:40 +02:00
|
|
|
|
2016-10-03 20:09:57 +02:00
|
|
|
if not data:
|
|
|
|
return None
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
data["user"] = User.de_json(data.get("user"), bot)
|
2016-10-03 20:09:57 +02:00
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
return super().de_json(data=data, bot=bot)
|