mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-23 17:36:26 +02:00
88 lines
3.5 KiB
Python
88 lines
3.5 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2024
|
|
# 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 Document."""
|
|
from typing import Optional
|
|
|
|
from telegram._files._basethumbedmedium import _BaseThumbedMedium
|
|
from telegram._files.photosize import PhotoSize
|
|
from telegram._utils.types import JSONDict
|
|
|
|
|
|
class Document(_BaseThumbedMedium):
|
|
"""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 :attr:`file_unique_id` is equal.
|
|
|
|
.. versionchanged:: 20.5
|
|
|removed_thumb_note|
|
|
|
|
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_name (:obj:`str`, optional): Original filename as defined by the sender.
|
|
mime_type (:obj:`str`, optional): MIME type of the file as defined by the sender.
|
|
file_size (:obj:`int`, optional): File size in bytes.
|
|
thumbnail (:class:`telegram.PhotoSize`, optional): Document thumbnail as defined by the
|
|
sender.
|
|
|
|
.. versionadded:: 20.2
|
|
|
|
Attributes:
|
|
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_name (:obj:`str`): Optional. Original filename as defined by the sender.
|
|
mime_type (:obj:`str`): Optional. MIME type of the file as defined by the sender.
|
|
file_size (:obj:`int`): Optional. File size in bytes.
|
|
thumbnail (:class:`telegram.PhotoSize`): Optional. Document thumbnail as defined by the
|
|
sender.
|
|
|
|
.. versionadded:: 20.2
|
|
|
|
"""
|
|
|
|
__slots__ = ("file_name", "mime_type")
|
|
|
|
def __init__(
|
|
self,
|
|
file_id: str,
|
|
file_unique_id: str,
|
|
file_name: Optional[str] = None,
|
|
mime_type: Optional[str] = None,
|
|
file_size: Optional[int] = None,
|
|
thumbnail: Optional[PhotoSize] = None,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
super().__init__(
|
|
file_id=file_id,
|
|
file_unique_id=file_unique_id,
|
|
file_size=file_size,
|
|
thumbnail=thumbnail,
|
|
api_kwargs=api_kwargs,
|
|
)
|
|
with self._unfrozen():
|
|
# Optional
|
|
self.mime_type: Optional[str] = mime_type
|
|
self.file_name: Optional[str] = file_name
|