260 lines
12 KiB
Python
260 lines
12 KiB
Python
# Pyrogram - Telegram MTProto API Client Library for Python
|
|
# Copyright (C) 2017-2021 Dan <https://github.com/delivrance>
|
|
#
|
|
# This file is part of Pyrogram.
|
|
#
|
|
# Pyrogram is free software: you can redistribute it and/or modify
|
|
# it under the terms of the GNU Lesser General Public License as published
|
|
# by the Free Software Foundation, either version 3 of the License, or
|
|
# (at your option) any later version.
|
|
#
|
|
# Pyrogram 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 General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU Lesser General Public License
|
|
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
|
|
|
|
import os
|
|
import re
|
|
from typing import Union, BinaryIO, List, Optional
|
|
|
|
from pyrogram import StopTransmission
|
|
from pyrogram import raw
|
|
from pyrogram import types
|
|
from pyrogram import utils
|
|
from pyrogram.errors import FilePartMissing
|
|
from pyrogram.file_id import FileType
|
|
from pyrogram.scaffold import Scaffold
|
|
|
|
|
|
class SendAnimation(Scaffold):
|
|
async def send_animation(
|
|
self,
|
|
chat_id: Union[int, str],
|
|
animation: Union[str, BinaryIO],
|
|
caption: str = "",
|
|
unsave: bool = False,
|
|
parse_mode: Optional[str] = object,
|
|
caption_entities: List["types.MessageEntity"] = None,
|
|
duration: int = 0,
|
|
width: int = 0,
|
|
height: int = 0,
|
|
thumb: Union[str, BinaryIO] = None,
|
|
file_name: str = None,
|
|
disable_notification: bool = None,
|
|
reply_to_message_id: int = None,
|
|
schedule_date: int = None,
|
|
reply_markup: Union[
|
|
"types.InlineKeyboardMarkup",
|
|
"types.ReplyKeyboardMarkup",
|
|
"types.ReplyKeyboardRemove",
|
|
"types.ForceReply"
|
|
] = None,
|
|
progress: callable = None,
|
|
progress_args: tuple = ()
|
|
) -> Optional["types.Message"]:
|
|
"""Send animation files (animation or H.264/MPEG-4 AVC video without sound).
|
|
|
|
Parameters:
|
|
chat_id (``int`` | ``str``):
|
|
Unique identifier (int) or username (str) of the target chat.
|
|
For your personal cloud (Saved Messages) you can simply use "me" or "self".
|
|
For a contact that exists in your Telegram address book you can use his phone number (str).
|
|
|
|
animation (``str`` | ``BinaryIO``):
|
|
Animation to send.
|
|
Pass a file_id as string to send an animation that exists on the Telegram servers,
|
|
pass an HTTP URL as a string for Telegram to get an animation from the Internet,
|
|
pass a file path as string to upload a new animation that exists on your local machine, or
|
|
pass a binary file-like object with its attribute ".name" set for in-memory uploads.
|
|
|
|
caption (``str``, *optional*):
|
|
Animation caption, 0-1024 characters.
|
|
|
|
unsave (``bool``, *optional*):
|
|
By default, the server will save into your own collection any new animation you send.
|
|
Pass True to automatically unsave the sent animation. Defaults to False.
|
|
|
|
parse_mode (``str``, *optional*):
|
|
By default, texts are parsed using both Markdown and HTML styles.
|
|
You can combine both syntaxes together.
|
|
Pass "markdown" or "md" to enable Markdown-style parsing only.
|
|
Pass "html" to enable HTML-style parsing only.
|
|
Pass None to completely disable style parsing.
|
|
|
|
caption_entities (List of :obj:`~pyrogram.types.MessageEntity`):
|
|
List of special entities that appear in the caption, which can be specified instead of *parse_mode*.
|
|
|
|
duration (``int``, *optional*):
|
|
Duration of sent animation in seconds.
|
|
|
|
width (``int``, *optional*):
|
|
Animation width.
|
|
|
|
height (``int``, *optional*):
|
|
Animation height.
|
|
|
|
thumb (``str`` | ``BinaryIO``, *optional*):
|
|
Thumbnail of the animation file sent.
|
|
The thumbnail should be in JPEG format and less than 200 KB in size.
|
|
A thumbnail's width and height should not exceed 320 pixels.
|
|
Thumbnails can't be reused and can be only uploaded as a new file.
|
|
|
|
file_name (``str``, *optional*):
|
|
File name of the animation sent.
|
|
Defaults to file's path basename.
|
|
|
|
disable_notification (``bool``, *optional*):
|
|
Sends the message silently.
|
|
Users will receive a notification with no sound.
|
|
|
|
reply_to_message_id (``int``, *optional*):
|
|
If the message is a reply, ID of the original message.
|
|
|
|
schedule_date (``int``, *optional*):
|
|
Date when the message will be automatically sent. Unix time.
|
|
|
|
reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardMarkup` | :obj:`~pyrogram.types.ReplyKeyboardRemove` | :obj:`~pyrogram.types.ForceReply`, *optional*):
|
|
Additional interface options. An object for an inline keyboard, custom reply keyboard,
|
|
instructions to remove reply keyboard or to force a reply from the user.
|
|
|
|
progress (``callable``, *optional*):
|
|
Pass a callback function to view the file transmission progress.
|
|
The function must take *(current, total)* as positional arguments (look at Other Parameters below for a
|
|
detailed description) and will be called back each time a new file chunk has been successfully
|
|
transmitted.
|
|
|
|
progress_args (``tuple``, *optional*):
|
|
Extra custom arguments for the progress callback function.
|
|
You can pass anything you need to be available in the progress callback scope; for example, a Message
|
|
object or a Client instance in order to edit the message with the updated progress status.
|
|
|
|
Other Parameters:
|
|
current (``int``):
|
|
The amount of bytes transmitted so far.
|
|
|
|
total (``int``):
|
|
The total size of the file.
|
|
|
|
*args (``tuple``, *optional*):
|
|
Extra custom arguments as defined in the ``progress_args`` parameter.
|
|
You can either keep ``*args`` or add every single extra argument in your function signature.
|
|
|
|
Returns:
|
|
:obj:`~pyrogram.types.Message` | ``None``: On success, the sent animation message is returned, otherwise,
|
|
in case the upload is deliberately stopped with :meth:`~pyrogram.Client.stop_transmission`, None is
|
|
returned.
|
|
|
|
Example:
|
|
.. code-block:: python
|
|
|
|
# Send animation by uploading from local file
|
|
app.send_animation("me", "animation.gif")
|
|
|
|
# Add caption to the animation
|
|
app.send_animation("me", "animation.gif", caption="cat")
|
|
|
|
# Unsave the animation once is sent
|
|
app.send_animation("me", "animation.gif", unsave=True)
|
|
|
|
# Keep track of the progress while uploading
|
|
def progress(current, total):
|
|
print(f"{current * 100 / total:.1f}%")
|
|
|
|
app.send_animation("me", "animation.gif", progress=progress)
|
|
"""
|
|
file = None
|
|
|
|
try:
|
|
if isinstance(animation, str):
|
|
if os.path.isfile(animation):
|
|
thumb = await self.save_file(thumb)
|
|
file = await self.save_file(animation, progress=progress, progress_args=progress_args)
|
|
media = raw.types.InputMediaUploadedDocument(
|
|
mime_type=self.guess_mime_type(animation) or "video/mp4",
|
|
file=file,
|
|
thumb=thumb,
|
|
attributes=[
|
|
raw.types.DocumentAttributeVideo(
|
|
supports_streaming=True,
|
|
duration=duration,
|
|
w=width,
|
|
h=height
|
|
),
|
|
raw.types.DocumentAttributeFilename(file_name=file_name or os.path.basename(animation)),
|
|
raw.types.DocumentAttributeAnimated()
|
|
]
|
|
)
|
|
elif re.match("^https?://", animation):
|
|
media = raw.types.InputMediaDocumentExternal(
|
|
url=animation
|
|
)
|
|
else:
|
|
media = utils.get_input_media_from_file_id(animation, FileType.ANIMATION)
|
|
else:
|
|
thumb = await self.save_file(thumb)
|
|
file = await self.save_file(animation, progress=progress, progress_args=progress_args)
|
|
media = raw.types.InputMediaUploadedDocument(
|
|
mime_type=self.guess_mime_type(animation.name) or "video/mp4",
|
|
file=file,
|
|
thumb=thumb,
|
|
attributes=[
|
|
raw.types.DocumentAttributeVideo(
|
|
supports_streaming=True,
|
|
duration=duration,
|
|
w=width,
|
|
h=height
|
|
),
|
|
raw.types.DocumentAttributeFilename(file_name=animation.name),
|
|
raw.types.DocumentAttributeAnimated()
|
|
]
|
|
)
|
|
|
|
while True:
|
|
try:
|
|
r = await self.send(
|
|
raw.functions.messages.SendMedia(
|
|
peer=await self.resolve_peer(chat_id),
|
|
media=media,
|
|
silent=disable_notification or None,
|
|
reply_to_msg_id=reply_to_message_id,
|
|
random_id=self.rnd_id(),
|
|
schedule_date=schedule_date,
|
|
reply_markup=await reply_markup.write(self) if reply_markup else None,
|
|
**await utils.parse_text_entities(self, caption, parse_mode, caption_entities)
|
|
)
|
|
)
|
|
except FilePartMissing as e:
|
|
await self.save_file(animation, file_id=file.id, file_part=e.x)
|
|
else:
|
|
for i in r.updates:
|
|
if isinstance(i, (raw.types.UpdateNewMessage,
|
|
raw.types.UpdateNewChannelMessage,
|
|
raw.types.UpdateNewScheduledMessage)):
|
|
message = await types.Message._parse(
|
|
self, i.message,
|
|
{i.id: i for i in r.users},
|
|
{i.id: i for i in r.chats},
|
|
is_scheduled=isinstance(i, raw.types.UpdateNewScheduledMessage)
|
|
)
|
|
|
|
if unsave:
|
|
document = message.animation or message.document
|
|
document_id = utils.get_input_media_from_file_id(
|
|
document.file_id, FileType.ANIMATION
|
|
).id
|
|
|
|
await self.send(
|
|
raw.functions.messages.SaveGif(
|
|
id=document_id,
|
|
unsave=True
|
|
)
|
|
)
|
|
|
|
return message
|
|
|
|
except StopTransmission:
|
|
return None
|