mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-24 09:56:30 +02:00
ebcc40ae92
* Bot.get_file now allows passing a file in addition to file_id * Add .get_file() to Audio, Document, PhotoSize, Sticker, Video, VideoNote and Voice * Add .send_*() methods to User and Chat
89 lines
2.9 KiB
Python
89 lines
2.9 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2018
|
|
# 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 PhotoSize."""
|
|
|
|
from telegram import TelegramObject
|
|
|
|
|
|
class PhotoSize(TelegramObject):
|
|
"""This object represents one size of a photo or a file/sticker thumbnail.
|
|
|
|
Attributes:
|
|
file_id (:obj:`str`): Unique identifier for this file.
|
|
width (:obj:`int`): Photo width.
|
|
height (:obj:`int`): Photo height.
|
|
file_size (:obj:`int`): Optional. File size.
|
|
bot (:class:`telegram.Bot`): Optional. The Bot to use for instance methods.
|
|
|
|
Args:
|
|
file_id (:obj:`str`): Unique identifier for this file.
|
|
width (:obj:`int`): Photo width.
|
|
height (:obj:`int`): Photo height.
|
|
file_size (:obj:`int`, optional): File size.
|
|
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self, file_id, width, height, file_size=None, bot=None, **kwargs):
|
|
# Required
|
|
self.file_id = str(file_id)
|
|
self.width = int(width)
|
|
self.height = int(height)
|
|
# Optionals
|
|
self.file_size = file_size
|
|
self.bot = bot
|
|
|
|
self._id_attrs = (self.file_id,)
|
|
|
|
@classmethod
|
|
def de_json(cls, data, bot):
|
|
if not data:
|
|
return None
|
|
|
|
return cls(bot=bot, **data)
|
|
|
|
@classmethod
|
|
def de_list(cls, data, bot):
|
|
if not data:
|
|
return []
|
|
|
|
photos = list()
|
|
for photo in data:
|
|
photos.append(cls.de_json(photo, bot))
|
|
|
|
return photos
|
|
|
|
def get_file(self, timeout=None, **kwargs):
|
|
"""Convenience wrapper over :attr:`telegram.Bot.get_file`
|
|
|
|
Args:
|
|
timeout (:obj:`int` | :obj:`float`, optional): If this value is specified, use it as
|
|
the read timeout from the server (instead of the one specified during creation of
|
|
the connection pool).
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
Returns:
|
|
:class:`telegram.File`
|
|
|
|
Raises:
|
|
:class:`telegram.TelegramError`
|
|
|
|
"""
|
|
return self.bot.get_file(self.file_id, timeout=timeout, **kwargs)
|