telegram.File¶
-
class
telegram.
File
(file_id, file_unique_id, bot=None, file_size=None, file_path=None, **_kwargs)¶ Bases:
telegram.base.TelegramObject
This object represents a file ready to be downloaded. The file can be downloaded with
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 callingtelegram.Bot.get_file()
.Objects of this class are comparable in terms of equality. Two objects of this class are considered equal, if their
file_unique_id
is equal.Note
Maximum file size to download is 20 MB.
If you obtain an instance of this class from
telegram.PassportFile.get_file
, then it will automatically be decrypted as it downloads when you calldownload()
.
- Parameters
file_id (
str
) – Identifier for this file, which can be used to download or reuse the file.file_unique_id (
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 (
int
, optional) – Optional. File size, if known.file_path (
str
, optional) – File path. Usedownload
to get the file.bot (
telegram.Bot
, optional) – Bot to use with shortcut method.**kwargs (
dict
) – Arbitrary keyword arguments.
-
file_id
¶ Identifier for this file.
- Type
str
-
file_unique_id
¶ 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.
- Type
str
-
file_size
¶ Optional. File size.
- Type
str
-
download
(custom_path=None, out=None, timeout=None)¶ 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
custom_path
is supplied, it will be saved to that path instead. Ifout
is defined, the file contents will be saved to that object using theout.write
method.Note
custom_path
andout
are mutually exclusive.If neither
custom_path
norout
is provided andfile_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.
- Parameters
custom_path (
str
, optional) – Custom path.out (
io.BufferedWriter
, optional) – A file-like object. Must be opened for writing in binary mode, if applicable.timeout (
int
|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).
- Returns
The same object as
out
if specified. Otherwise, returns the filename downloaded to or the file path of the local file.- Return type
str
|io.BufferedWriter
- Raises
ValueError – If both
custom_path
andout
are passed.
-
download_as_bytearray
(buf=None)¶ Download this file and return it as a bytearray.
- Parameters
buf (
bytearray
, optional) – Extend the given bytearray with the downloaded data.- Returns
The same object as
buf
if it was specified. Otherwise a newly allocatedbytearray
.- Return type
bytearray