mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
023245c76b
Resolves #302. We decided to use sentinel pattern (https://python-patterns.guide/python/sentinel-object/) as a solution, but got a few problems with plain `object()`, so instead we use unittest.mock.sentinel and we hope it won't cause side effects. Most of work done via tg-codegen (https://github.com/aiogram/tg-codegen/pull/1), so it's good to review only implementation of sentinel, processing sentinel in `prepare_parse_mode`, changes in base method model and little test fixes.
69 lines
3.1 KiB
Python
69 lines
3.1 KiB
Python
from typing import Any, Dict, Optional, Union
|
||
|
||
from ..types import (
|
||
UNSET,
|
||
ForceReply,
|
||
InlineKeyboardMarkup,
|
||
InputFile,
|
||
Message,
|
||
ReplyKeyboardMarkup,
|
||
ReplyKeyboardRemove,
|
||
)
|
||
from .base import Request, TelegramMethod, prepare_file
|
||
|
||
|
||
class SendAnimation(TelegramMethod[Message]):
|
||
"""
|
||
Use this method to send animation files (GIF or H.264/MPEG-4 AVC video without sound). On
|
||
success, the sent Message is returned. Bots can currently send animation files of up to 50 MB
|
||
in size, this limit may be changed in the future.
|
||
|
||
Source: https://core.telegram.org/bots/api#sendanimation
|
||
"""
|
||
|
||
__returning__ = Message
|
||
|
||
chat_id: Union[int, str]
|
||
"""Unique identifier for the target chat or username of the target channel (in the format
|
||
@channelusername)"""
|
||
animation: Union[InputFile, str]
|
||
"""Animation to send. Pass a file_id as String to send an animation that exists on the
|
||
Telegram servers (recommended), pass an HTTP URL as a String for Telegram to get an
|
||
animation from the Internet, or upload a new animation using multipart/form-data."""
|
||
duration: Optional[int] = None
|
||
"""Duration of sent animation in seconds"""
|
||
width: Optional[int] = None
|
||
"""Animation width"""
|
||
height: Optional[int] = None
|
||
"""Animation height"""
|
||
thumb: Optional[Union[InputFile, str]] = None
|
||
"""Thumbnail of the file sent; can be ignored if thumbnail generation for the file is
|
||
supported server-side. The thumbnail should be in JPEG format and less than 200 kB in size.
|
||
A thumbnail‘s width and height should not exceed 320. Ignored if the file is not uploaded
|
||
using multipart/form-data. Thumbnails can’t be reused and can be only uploaded as a new
|
||
file, so you can pass 'attach://<file_attach_name>' if the thumbnail was uploaded using
|
||
multipart/form-data under <file_attach_name>."""
|
||
caption: Optional[str] = None
|
||
"""Animation caption (may also be used when resending animation by file_id), 0-1024 characters
|
||
after entities parsing"""
|
||
parse_mode: Optional[str] = UNSET
|
||
"""Send Markdown or HTML, if you want Telegram apps to show bold, italic, fixed-width text or
|
||
inline URLs in the media caption."""
|
||
disable_notification: Optional[bool] = None
|
||
"""Sends the message silently. Users will receive a notification with no sound."""
|
||
reply_to_message_id: Optional[int] = None
|
||
"""If the message is a reply, ID of the original message"""
|
||
reply_markup: Optional[
|
||
Union[InlineKeyboardMarkup, ReplyKeyboardMarkup, ReplyKeyboardRemove, ForceReply]
|
||
] = None
|
||
"""Additional interface options. A JSON-serialized object for an inline keyboard, custom reply
|
||
keyboard, instructions to remove reply keyboard or to force a reply from the user."""
|
||
|
||
def build_request(self) -> Request:
|
||
data: Dict[str, Any] = self.dict(exclude={"animation", "thumb"})
|
||
|
||
files: Dict[str, InputFile] = {}
|
||
prepare_file(data=data, files=files, name="animation", value=self.animation)
|
||
prepare_file(data=data, files=files, name="thumb", value=self.thumb)
|
||
|
||
return Request(method="sendAnimation", data=data, files=files)
|