147 lines
4.1 KiB
Python
147 lines
4.1 KiB
Python
import mimetypes
|
|
import os
|
|
|
|
from ... import utils
|
|
from ...tl import types
|
|
|
|
|
|
class File:
|
|
"""
|
|
Convenience class over media like photos or documents, which
|
|
supports accessing the attributes in a more convenient way.
|
|
|
|
If any of the attributes are not present in the current media,
|
|
the properties will be `None`.
|
|
|
|
The original media is available through the ``media`` attribute.
|
|
"""
|
|
def __init__(self, media):
|
|
self.media = media
|
|
|
|
@property
|
|
def id(self):
|
|
"""
|
|
The old bot-API style ``file_id`` representing this file.
|
|
|
|
.. warning::
|
|
|
|
This feature has not been maintained for a long time and
|
|
may not work. It will be removed in future versions.
|
|
|
|
.. note::
|
|
|
|
This file ID may not work under user accounts,
|
|
but should still be usable by bot accounts.
|
|
|
|
You can, however, still use it to identify
|
|
a file in for example a database.
|
|
"""
|
|
return utils.pack_bot_file_id(self.media)
|
|
|
|
@property
|
|
def name(self):
|
|
"""
|
|
The file name of this document.
|
|
"""
|
|
return self._from_attr(types.DocumentAttributeFilename, 'file_name')
|
|
|
|
@property
|
|
def ext(self):
|
|
"""
|
|
The extension from the mime type of this file.
|
|
|
|
If the mime type is unknown, the extension
|
|
from the file name (if any) will be used.
|
|
"""
|
|
return (
|
|
mimetypes.guess_extension(self.mime_type)
|
|
or os.path.splitext(self.name or '')[-1]
|
|
or None
|
|
)
|
|
|
|
@property
|
|
def mime_type(self):
|
|
"""
|
|
The mime-type of this file.
|
|
"""
|
|
if isinstance(self.media, types.Photo):
|
|
return 'image/jpeg'
|
|
elif isinstance(self.media, types.Document):
|
|
return self.media.mime_type
|
|
|
|
@property
|
|
def width(self):
|
|
"""
|
|
The width in pixels of this media if it's a photo or a video.
|
|
"""
|
|
if isinstance(self.media, types.Photo):
|
|
return max(getattr(s, 'w', 0) for s in self.media.sizes)
|
|
|
|
return self._from_attr((
|
|
types.DocumentAttributeImageSize, types.DocumentAttributeVideo), 'w')
|
|
|
|
@property
|
|
def height(self):
|
|
"""
|
|
The height in pixels of this media if it's a photo or a video.
|
|
"""
|
|
if isinstance(self.media, types.Photo):
|
|
return max(getattr(s, 'h', 0) for s in self.media.sizes)
|
|
|
|
return self._from_attr((
|
|
types.DocumentAttributeImageSize, types.DocumentAttributeVideo), 'h')
|
|
|
|
@property
|
|
def duration(self):
|
|
"""
|
|
The duration in seconds of the audio or video.
|
|
"""
|
|
return self._from_attr((
|
|
types.DocumentAttributeAudio, types.DocumentAttributeVideo), 'duration')
|
|
|
|
@property
|
|
def title(self):
|
|
"""
|
|
The title of the song.
|
|
"""
|
|
return self._from_attr(types.DocumentAttributeAudio, 'title')
|
|
|
|
@property
|
|
def performer(self):
|
|
"""
|
|
The performer of the song.
|
|
"""
|
|
return self._from_attr(types.DocumentAttributeAudio, 'performer')
|
|
|
|
@property
|
|
def emoji(self):
|
|
"""
|
|
A string with all emoji that represent the current sticker.
|
|
"""
|
|
return self._from_attr(types.DocumentAttributeSticker, 'alt')
|
|
|
|
@property
|
|
def sticker_set(self):
|
|
"""
|
|
The :tl:`InputStickerSet` to which the sticker file belongs.
|
|
"""
|
|
return self._from_attr(types.DocumentAttributeSticker, 'stickerset')
|
|
|
|
@property
|
|
def size(self):
|
|
"""
|
|
The size in bytes of this file.
|
|
|
|
For photos, this is the heaviest thumbnail, as it often repressents the largest dimensions.
|
|
"""
|
|
if isinstance(self.media, types.Photo):
|
|
return max(filter(None, map(utils._photo_size_byte_count, self.media.sizes)), default=None)
|
|
elif isinstance(self.media, types.Document):
|
|
return self.media.size
|
|
|
|
def _from_attr(self, cls, field):
|
|
if isinstance(self.media, types.Document):
|
|
for attr in self.media.attributes:
|
|
if isinstance(attr, cls):
|
|
return getattr(attr, field, None)
|