mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2025-03-26 08:32:58 +01:00
8406889179
* Remove usages of python-future lib * Remove python2 datetime.timezone replacement * Remove python2 workaround in InputFile.__init__ * Remove import of str necessary for python2 * Remove urllib2 import necessary for python2 * Remove a mention of python 2 in doc * Remove python 2 from travis config file * Remove python 2 from appveyor config * Remove python2 from debian build rules * Remove unnecessarry aliasing of time.perf_counter * Remove python 2 from github workflow * Remove mention of python 2 in descriptions/readme * Remove version check for queue import * Remove version checks in tests * Adjust docs to correctly mention supported version * Fix indentation * Remove unused 'sys' imports * Fix indentation * Remove references to mq.curtime in tests * Replace super calls by argumentsless version * Remove future dependency * Fix error in de_json declaration * Use python3 metaclass syntax * Use implicit inheriting from object * Remove accidentally committed .vscode folder * Use nameless f-string and raw string * Fix regex string literal syntax * Remove old style classes * Run pyupgrade * Fix leftover from automatic merge * Fix lint errors * Update telegram/files/sticker.py Co-authored-by: Bibo-Joshi <hinrich.mahler@freenet.de>
125 lines
4.3 KiB
Python
125 lines
4.3 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 Encrypted PassportFile."""
|
|
|
|
from telegram import TelegramObject
|
|
|
|
|
|
class PassportFile(TelegramObject):
|
|
"""
|
|
This object represents a file uploaded to Telegram Passport. Currently all Telegram Passport
|
|
files are in JPEG format when decrypted and don't exceed 10MB.
|
|
|
|
Attributes:
|
|
file_id (:obj:`str`): Unique identifier for this file.
|
|
file_unique_id (:obj:`str`): Unique identifier for this file, which
|
|
is supposed to be the same over time and for different bots.
|
|
Can't be used to download or reuse the file.
|
|
file_size (:obj:`int`): File size.
|
|
file_date (:obj:`int`): Unix time when the file was uploaded.
|
|
bot (:class:`telegram.Bot`): Optional. The Bot to use for instance methods.
|
|
|
|
Args:
|
|
file_id (:obj:`str`): Identifier for this file, which can be used to download
|
|
or reuse the file.
|
|
file_unique_id (:obj:`str`): Unique and the same over time and
|
|
for different bots file identifier.
|
|
file_size (:obj:`int`): File size.
|
|
file_date (:obj:`int`): Unix time when the file was uploaded.
|
|
bot (:class:`telegram.Bot`, optional): The Bot to use for instance methods.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
"""
|
|
|
|
def __init__(self,
|
|
file_id,
|
|
file_unique_id,
|
|
file_date,
|
|
file_size=None,
|
|
bot=None,
|
|
credentials=None,
|
|
**kwargs):
|
|
# Required
|
|
self.file_id = file_id
|
|
self.file_unique_id = file_unique_id
|
|
self.file_size = file_size
|
|
self.file_date = file_date
|
|
# Optionals
|
|
self.bot = bot
|
|
self._credentials = credentials
|
|
|
|
self._id_attrs = (self.file_unique_id,)
|
|
|
|
@classmethod
|
|
def de_json(cls, data, bot):
|
|
if not data:
|
|
return None
|
|
|
|
data = super().de_json(data, bot)
|
|
|
|
return cls(bot=bot, **data)
|
|
|
|
@classmethod
|
|
def de_json_decrypted(cls, data, bot, credentials):
|
|
if not data:
|
|
return None
|
|
|
|
data = super().de_json(data, bot)
|
|
|
|
data['credentials'] = credentials
|
|
|
|
return cls(bot=bot, **data)
|
|
|
|
@classmethod
|
|
def de_list(cls, data, bot):
|
|
if not data:
|
|
return []
|
|
|
|
return [cls.de_json(passport_file, bot) for passport_file in data]
|
|
|
|
@classmethod
|
|
def de_list_decrypted(cls, data, bot, credentials):
|
|
if not data:
|
|
return []
|
|
|
|
return [cls.de_json_decrypted(passport_file, bot, credentials[i])
|
|
for i, passport_file in enumerate(data)]
|
|
|
|
def get_file(self, timeout=None, **kwargs):
|
|
"""
|
|
Wrapper over :attr:`telegram.Bot.get_file`. Will automatically assign the correct
|
|
credentials to the returned :class:`telegram.File` if originating from
|
|
:obj:`telegram.PassportData.decrypted_data`.
|
|
|
|
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`
|
|
|
|
"""
|
|
file = self.bot.get_file(self.file_id, timeout=timeout, **kwargs)
|
|
file.set_credentials(self._credentials)
|
|
return file
|