Document

class telegram.Document(file_id, file_unique_id, file_name=None, mime_type=None, file_size=None, thumbnail=None, *, api_kwargs=None)

Bases: telegram.TelegramObject

This object represents a general file (as opposed to photos, voice messages and audio files).

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.

Use In

• telegram.Bot.get_file()

• telegram.Bot.send_document()

Available In

• telegram.BackgroundTypePattern.document

• telegram.BackgroundTypeWallpaper.document

• telegram.ExternalReplyInfo.document

• telegram.InputMediaDocument.media

• telegram.Message.document

• telegram.Message.effective_attachment

Changed in version 20.5: Removed the deprecated argument and attribute thumb.

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_name (str, optional) – Original filename as defined by the sender.

• mime_type (str, optional) – MIME type of the file as defined by the sender.

• file_size (int, optional) – File size in bytes.

• thumbnail (telegram.PhotoSize, optional) –

  Document thumbnail as defined by the sender.

  Added in version 20.2.

file_id

Identifier for this file, which can be used to download or reuse the 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_name

Optional. Original filename as defined by the sender.

Type:

str

mime_type

Optional. MIME type of the file as defined by the sender.

Type:

str

file_size

Optional. File size in bytes.

Type:

int

thumbnail

Optional. Document thumbnail as defined by the sender.

Added in version 20.2.

Type:

telegram.PhotoSize

__dir__()

Default dir() implementation.

__format__(format_spec, /)

Default object formatter.

Return str(self) if format_spec is empty. Raise TypeError otherwise.

__ge__(value, /)

Return self>=value.

__getattribute__(name, /)

Return getattr(self, name).

__gt__(value, /)

Return self>value.

classmethod __init_subclass__()

This method is called when a class is subclassed.

The default implementation does nothing. It may be overridden to extend subclasses.

__le__(value, /)

Return self<=value.

__lt__(value, /)

Return self<value.

__ne__(value, /)

Return self!=value.

classmethod __new__(*args, **kwargs)

__reduce__()

Helper for pickle.

__reduce_ex__(protocol, /)

Helper for pickle.

__sizeof__()

Size of object in memory, in bytes.

__str__()

Return str(self).

classmethod __subclasshook__(object, /)

Abstract classes can override this to customize issubclass().

This is invoked early on by abc.ABCMeta.__subclasscheck__(). It should return True, False or NotImplemented. If it returns NotImplemented, the normal algorithm is used. Otherwise, it overrides the normal algorithm (and the outcome is cached).

classmethod de_json(data, bot=None)

See telegram.TelegramObject.de_json().

async get_file(*, read_timeout=None, write_timeout=None, connect_timeout=None, pool_timeout=None, api_kwargs=None)

Convenience wrapper over telegram.Bot.get_file()

For the documentation of the arguments, please see telegram.Bot.get_file().

Returns:

telegram.File

Raises:

telegram.error.TelegramError –