mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-22 15:17:00 +01:00
234 lines
9.7 KiB
Python
234 lines
9.7 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2022
|
|
# 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 File."""
|
|
import shutil
|
|
import urllib.parse as urllib_parse
|
|
from base64 import b64decode
|
|
from pathlib import Path
|
|
from typing import IO, TYPE_CHECKING, Any, Optional, Union
|
|
|
|
from telegram._passport.credentials import decrypt
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._utils.defaultvalue import DEFAULT_NONE
|
|
from telegram._utils.files import is_local_file
|
|
from telegram._utils.types import FilePathInput, ODVInput
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import Bot, FileCredentials
|
|
|
|
|
|
class File(TelegramObject):
|
|
"""
|
|
This object represents a file ready to be downloaded. The file can be downloaded with
|
|
:attr:`download`. It is guaranteed that the link will be valid for at least 1 hour. When the
|
|
link expires, a new one can be requested by calling :meth:`telegram.Bot.get_file`.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`file_unique_id` is equal.
|
|
|
|
Note:
|
|
* Maximum file size to download is
|
|
:tg-const:`telegram.constants.FileSizeLimit.FILESIZE_DOWNLOAD`.
|
|
* If you obtain an instance of this class from :attr:`telegram.PassportFile.get_file`,
|
|
then it will automatically be decrypted as it downloads when you call :meth:`download()`.
|
|
|
|
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 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`, optional): Optional. File size in bytes, if known.
|
|
file_path (:obj:`str`, optional): File path. Use :attr:`download` to get the file.
|
|
bot (:obj:`telegram.Bot`, optional): Bot to use with shortcut method.
|
|
**kwargs (:obj:`dict`): Arbitrary keyword arguments.
|
|
|
|
Attributes:
|
|
file_id (:obj:`str`): 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:`str`): Optional. File size in bytes.
|
|
file_path (:obj:`str`): Optional. File path. Use :meth:`download` to get the file.
|
|
|
|
"""
|
|
|
|
__slots__ = (
|
|
"file_id",
|
|
"file_size",
|
|
"file_unique_id",
|
|
"file_path",
|
|
"_credentials",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
file_id: str,
|
|
file_unique_id: str,
|
|
bot: "Bot" = None,
|
|
file_size: int = None,
|
|
file_path: str = None,
|
|
**_kwargs: Any,
|
|
):
|
|
# Required
|
|
self.file_id = str(file_id)
|
|
self.file_unique_id = str(file_unique_id)
|
|
# Optionals
|
|
self.file_size = file_size
|
|
self.file_path = file_path
|
|
self.set_bot(bot)
|
|
self._credentials: Optional["FileCredentials"] = None
|
|
|
|
self._id_attrs = (self.file_unique_id,)
|
|
|
|
async def download(
|
|
self,
|
|
custom_path: FilePathInput = None,
|
|
out: IO = None,
|
|
read_timeout: ODVInput[float] = DEFAULT_NONE,
|
|
write_timeout: ODVInput[float] = DEFAULT_NONE,
|
|
connect_timeout: ODVInput[float] = DEFAULT_NONE,
|
|
pool_timeout: ODVInput[float] = DEFAULT_NONE,
|
|
) -> Union[Path, IO]:
|
|
"""
|
|
Download this file. By default, the file is saved in the current working directory with its
|
|
original filename as reported by Telegram. If the file has no filename, it the file ID will
|
|
be used as filename. If a :paramref:`custom_path` is supplied, it will be saved to that
|
|
path instead. If :paramref:`out` is defined, the file contents will be saved to that object
|
|
using the ``out.write`` method.
|
|
|
|
Note:
|
|
* :paramref:`custom_path` and :paramref:`out` are mutually exclusive.
|
|
* If neither :paramref:`custom_path` nor :paramref:`out` is provided and
|
|
:attr:`file_path` is the path of a local file (which is the case when a Bot API
|
|
Server is running in local mode), this method will just return the path.
|
|
|
|
.. versionchanged:: 20.0
|
|
|
|
* :paramref:`custom_path` parameter now also accepts :class:`pathlib.Path` as argument.
|
|
* Returns :class:`pathlib.Path` object in cases where previously a :obj:`str` was
|
|
returned.
|
|
|
|
Args:
|
|
custom_path (:class:`pathlib.Path` | :obj:`str`, optional): Custom path.
|
|
out (:obj:`io.BufferedWriter`, optional): A file-like object. Must be opened for
|
|
writing in binary mode, if applicable.
|
|
read_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to
|
|
:paramref:`telegram.request.BaseRequest.post.read_timeout`. Defaults to
|
|
:attr:`~telegram.request.BaseRequest.DEFAULT_NONE`.
|
|
write_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to
|
|
:paramref:`telegram.request.BaseRequest.post.write_timeout`. Defaults to
|
|
:attr:`~telegram.request.BaseRequest.DEFAULT_NONE`.
|
|
connect_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to
|
|
:paramref:`telegram.request.BaseRequest.post.connect_timeout`. Defaults to
|
|
:attr:`~telegram.request.BaseRequest.DEFAULT_NONE`.
|
|
pool_timeout (:obj:`float` | :obj:`None`, optional): Value to pass to
|
|
:paramref:`telegram.request.BaseRequest.post.pool_timeout`. Defaults to
|
|
:attr:`~telegram.request.BaseRequest.DEFAULT_NONE`.
|
|
|
|
Returns:
|
|
:class:`pathlib.Path` | :obj:`io.BufferedWriter`: The same object as :paramref:`out` if
|
|
specified. Otherwise, returns the filename downloaded to or the file path of the
|
|
local file.
|
|
|
|
Raises:
|
|
ValueError: If both :paramref:`custom_path` and :paramref:`out` are passed.
|
|
|
|
"""
|
|
if custom_path is not None and out is not None:
|
|
raise ValueError("`custom_path` and `out` are mutually exclusive")
|
|
|
|
local_file = is_local_file(self.file_path)
|
|
url = None if local_file else self._get_encoded_url()
|
|
path = Path(self.file_path) if local_file else None
|
|
|
|
if out:
|
|
if local_file:
|
|
buf = path.read_bytes()
|
|
else:
|
|
buf = await self.get_bot().request.retrieve(url)
|
|
if self._credentials:
|
|
buf = decrypt(
|
|
b64decode(self._credentials.secret), b64decode(self._credentials.hash), buf
|
|
)
|
|
out.write(buf)
|
|
return out
|
|
|
|
if custom_path is not None and local_file:
|
|
shutil.copyfile(self.file_path, str(custom_path))
|
|
return Path(custom_path)
|
|
|
|
if custom_path:
|
|
filename = Path(custom_path)
|
|
elif local_file:
|
|
return Path(self.file_path)
|
|
elif self.file_path:
|
|
filename = Path(Path(self.file_path).name)
|
|
else:
|
|
filename = Path.cwd() / self.file_id
|
|
|
|
buf = await self.get_bot().request.retrieve(
|
|
url,
|
|
read_timeout=read_timeout,
|
|
write_timeout=write_timeout,
|
|
connect_timeout=connect_timeout,
|
|
pool_timeout=pool_timeout,
|
|
)
|
|
if self._credentials:
|
|
buf = decrypt(
|
|
b64decode(self._credentials.secret), b64decode(self._credentials.hash), buf
|
|
)
|
|
filename.write_bytes(buf)
|
|
return filename
|
|
|
|
def _get_encoded_url(self) -> str:
|
|
"""Convert any UTF-8 char in :obj:`File.file_path` into a url encoded ASCII string."""
|
|
sres = urllib_parse.urlsplit(str(self.file_path))
|
|
return urllib_parse.urlunsplit(
|
|
urllib_parse.SplitResult(
|
|
sres.scheme, sres.netloc, urllib_parse.quote(sres.path), sres.query, sres.fragment
|
|
)
|
|
)
|
|
|
|
async def download_as_bytearray(self, buf: bytearray = None) -> bytearray:
|
|
"""Download this file and return it as a bytearray.
|
|
|
|
Args:
|
|
buf (:obj:`bytearray`, optional): Extend the given bytearray with the downloaded data.
|
|
|
|
Returns:
|
|
:obj:`bytearray`: The same object as :paramref:`buf` if it was specified. Otherwise a
|
|
newly allocated :obj:`bytearray`.
|
|
|
|
"""
|
|
if buf is None:
|
|
buf = bytearray()
|
|
if is_local_file(self.file_path):
|
|
buf.extend(Path(self.file_path).read_bytes())
|
|
else:
|
|
buf.extend(await self.get_bot().request.retrieve(self._get_encoded_url()))
|
|
return buf
|
|
|
|
def set_credentials(self, credentials: "FileCredentials") -> None:
|
|
"""Sets the passport credentials for the file.
|
|
|
|
Args:
|
|
credentials (:class:`telegram.FileCredentials`): The credentials.
|
|
"""
|
|
self._credentials = credentials
|