mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 01:46:22 +02:00
92b9370c23
* Make pre-commit more strict * Get pylint to read setup.cfg * Make pylint & mypy happy aka ignore all the things * use LogRecord.getMessage() in tests * Make noam happy * Update both pylint & mypy while we're at it * Bring reqs-dev and makefile up to speed * try making pre-commit happy * fix jobqueue tests on the fly
64 lines
2.1 KiB
Python
64 lines
2.1 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2020
|
|
# 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 GameHighScore."""
|
|
|
|
from typing import TYPE_CHECKING, Optional
|
|
|
|
from telegram import TelegramObject, User
|
|
from telegram.utils.types import JSONDict
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import Bot
|
|
|
|
|
|
class GameHighScore(TelegramObject):
|
|
"""This object represents one row of the high scores table for a game.
|
|
|
|
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.
|
|
|
|
Attributes:
|
|
position (:obj:`int`): Position in high score table for the game.
|
|
user (:class:`telegram.User`): User.
|
|
score (:obj:`int`): Score.
|
|
|
|
Args:
|
|
position (:obj:`int`): Position in high score table for the game.
|
|
user (:class:`telegram.User`): User.
|
|
score (:obj:`int`): Score.
|
|
|
|
"""
|
|
|
|
def __init__(self, position: int, user: User, score: int):
|
|
self.position = position
|
|
self.user = user
|
|
self.score = score
|
|
|
|
self._id_attrs = (self.position, self.user, self.score)
|
|
|
|
@classmethod
|
|
def de_json(cls, data: Optional[JSONDict], bot: 'Bot') -> Optional['GameHighScore']:
|
|
data = cls.parse_data(data)
|
|
|
|
if not data:
|
|
return None
|
|
|
|
data['user'] = User.de_json(data.get('user'), bot)
|
|
|
|
return cls(**data)
|