mirror of
https://github.com/aiogram/aiogram.git
synced 2026-04-08 16:37:47 +00:00
cd4e811856
* Refactor: Introduce Union types for streamlined type handling Implemented Union types across various modules to consolidate and simplify type annotations. This change replaces repetitive union declarations with reusable Union aliases, improving code readability and maintainability. Updates applied to affected classes, methods, and imports accordingly. * Refactor unions into type aliases for better reusability Replaced inline `Union` types with predefined aliases like `MediaUnion`, `ReplyMarkupUnion`, and `ChatIdUnion`. Simplifies type annotations, improves code readability, and reduces duplication. Added `media_union.py` for grouping related media types. * Refactor type unions with ResultChatMemberUnion and ResultMenuButtonUnion Replaced verbose type definitions of chat member and menu button unions with `ResultChatMemberUnion` and `ResultMenuButtonUnion` for improved readability and maintainability. Updated relevant methods, modules, and documentation to use the new type aliases consistently. * Added changelog
94 lines
4.9 KiB
Python
94 lines
4.9 KiB
Python
from __future__ import annotations
|
|
|
|
from typing import TYPE_CHECKING, Any, Optional, Union
|
|
|
|
from pydantic import Field
|
|
|
|
from ..client.default import Default
|
|
from ..types import ChatIdUnion, Message, ReplyMarkupUnion, ReplyParameters
|
|
from .base import TelegramMethod
|
|
|
|
|
|
class SendDice(TelegramMethod[Message]):
|
|
"""
|
|
Use this method to send an animated emoji that will display a random value. On success, the sent :class:`aiogram.types.message.Message` is returned.
|
|
|
|
Source: https://core.telegram.org/bots/api#senddice
|
|
"""
|
|
|
|
__returning__ = Message
|
|
__api_method__ = "sendDice"
|
|
|
|
chat_id: ChatIdUnion
|
|
"""Unique identifier for the target chat or username of the target channel (in the format :code:`@channelusername`)"""
|
|
business_connection_id: Optional[str] = None
|
|
"""Unique identifier of the business connection on behalf of which the message will be sent"""
|
|
message_thread_id: Optional[int] = None
|
|
"""Unique identifier for the target message thread (topic) of the forum; for forum supergroups only"""
|
|
emoji: Optional[str] = None
|
|
"""Emoji on which the dice throw animation is based. Currently, must be one of '🎲', '🎯', '🏀', '⚽', '🎳', or '🎰'. Dice can have values 1-6 for '🎲', '🎯' and '🎳', values 1-5 for '🏀' and '⚽', and values 1-64 for '🎰'. Defaults to '🎲'"""
|
|
disable_notification: Optional[bool] = None
|
|
"""Sends the message `silently <https://telegram.org/blog/channels-2-0#silent-messages>`_. Users will receive a notification with no sound."""
|
|
protect_content: Optional[Union[bool, Default]] = Default("protect_content")
|
|
"""Protects the contents of the sent message from forwarding"""
|
|
allow_paid_broadcast: Optional[bool] = None
|
|
"""Pass :code:`True` to allow up to 1000 messages per second, ignoring `broadcasting limits <https://core.telegram.org/bots/faq#how-can-i-message-all-of-my-bot-39s-subscribers-at-once>`_ for a fee of 0.1 Telegram Stars per message. The relevant Stars will be withdrawn from the bot's balance"""
|
|
message_effect_id: Optional[str] = None
|
|
"""Unique identifier of the message effect to be added to the message; for private chats only"""
|
|
reply_parameters: Optional[ReplyParameters] = None
|
|
"""Description of the message to reply to"""
|
|
reply_markup: Optional[ReplyMarkupUnion] = None
|
|
"""Additional interface options. A JSON-serialized object for an `inline keyboard <https://core.telegram.org/bots/features#inline-keyboards>`_, `custom reply keyboard <https://core.telegram.org/bots/features#keyboards>`_, instructions to remove a reply keyboard or to force a reply from the user"""
|
|
allow_sending_without_reply: Optional[bool] = Field(
|
|
None, json_schema_extra={"deprecated": True}
|
|
)
|
|
"""Pass :code:`True` if the message should be sent even if the specified replied-to message is not found
|
|
|
|
.. deprecated:: API:7.0
|
|
https://core.telegram.org/bots/api-changelog#december-29-2023"""
|
|
reply_to_message_id: Optional[int] = Field(None, json_schema_extra={"deprecated": True})
|
|
"""If the message is a reply, ID of the original message
|
|
|
|
.. deprecated:: API:7.0
|
|
https://core.telegram.org/bots/api-changelog#december-29-2023"""
|
|
|
|
if TYPE_CHECKING:
|
|
# DO NOT EDIT MANUALLY!!!
|
|
# This section was auto-generated via `butcher`
|
|
|
|
def __init__(
|
|
__pydantic__self__,
|
|
*,
|
|
chat_id: ChatIdUnion,
|
|
business_connection_id: Optional[str] = None,
|
|
message_thread_id: Optional[int] = None,
|
|
emoji: Optional[str] = None,
|
|
disable_notification: Optional[bool] = None,
|
|
protect_content: Optional[Union[bool, Default]] = Default("protect_content"),
|
|
allow_paid_broadcast: Optional[bool] = None,
|
|
message_effect_id: Optional[str] = None,
|
|
reply_parameters: Optional[ReplyParameters] = None,
|
|
reply_markup: Optional[ReplyMarkupUnion] = None,
|
|
allow_sending_without_reply: Optional[bool] = None,
|
|
reply_to_message_id: Optional[int] = None,
|
|
**__pydantic_kwargs: Any,
|
|
) -> None:
|
|
# DO NOT EDIT MANUALLY!!!
|
|
# This method was auto-generated via `butcher`
|
|
# Is needed only for type checking and IDE support without any additional plugins
|
|
|
|
super().__init__(
|
|
chat_id=chat_id,
|
|
business_connection_id=business_connection_id,
|
|
message_thread_id=message_thread_id,
|
|
emoji=emoji,
|
|
disable_notification=disable_notification,
|
|
protect_content=protect_content,
|
|
allow_paid_broadcast=allow_paid_broadcast,
|
|
message_effect_id=message_effect_id,
|
|
reply_parameters=reply_parameters,
|
|
reply_markup=reply_markup,
|
|
allow_sending_without_reply=allow_sending_without_reply,
|
|
reply_to_message_id=reply_to_message_id,
|
|
**__pydantic_kwargs,
|
|
)
|