telegrinder 0.1.dev168__py3-none-any.whl → 0.1.dev170__py3-none-any.whl

telegrinder/__init__.py

@@ -1,6 +1,6 @@
 """Telegrinder
 
-Framework for effective and reliable telegram bot building.
+Modern visionary telegram bot framework.
 
 * Type hinted
 * Customizable and extensible
@@ -51,16 +51,20 @@ from .bot import (
     BaseView,
     CallbackQueryCute,
     CallbackQueryReturnManager,
+    CallbackQueryRule,
     CallbackQueryView,
     ChatJoinRequestCute,
+    ChatJoinRequestRule,
     ChatJoinRequestView,
     ChatMemberUpdatedCute,
     ChatMemberView,
     Checkbox,
+    Choice,
     Dispatch,
     FuncHandler,
     InlineQueryCute,
     InlineQueryReturnManager,
+    InlineQueryRule,
     MessageCute,
     MessageReplyHandler,
     MessageReturnManager,
@@ -69,7 +73,6 @@ from .bot import (
     Polling,
     RawEventView,
     ShortState,
-    SingleChoice,
     Telegrinder,
     UpdateCute,
     ViewBox,
@@ -152,6 +155,9 @@ __all__ = (
     "CallbackQueryView",
     "ChatJoinRequest",
     "ChatJoinRequestCute",
+    "CallbackQueryRule",
+    "ChatJoinRequestRule",
+    "InlineQueryRule",
     "ChatJoinRequestView",
     "ChatMemberUpdated",
     "ChatMemberUpdatedCute",
@@ -190,7 +196,7 @@ __all__ = (
     "ShortState",
     "SimpleI18n",
     "SimpleTranslator",
-    "SingleChoice",
+    "Choice",
     "Telegrinder",
     "Token",
     "Update",

telegrinder/bot/__init__.py

@@ -22,7 +22,6 @@ from .dispatch import (
     CallbackQueryView,
     ChatJoinRequestView,
     ChatMemberView,
-    CompositionDispatch,
     Context,
     Dispatch,
     FuncHandler,
@@ -35,11 +34,12 @@ from .dispatch import (
     ShortState,
     ViewBox,
     WaiterMachine,
+    clear_wm_storage_worker,
     register_manager,
 )
 from .polling import ABCPolling, Polling
-from .rules import ABCRule, CallbackQueryRule, MessageRule
-from .scenario import ABCScenario, Checkbox, SingleChoice
+from .rules import ABCRule, CallbackQueryRule, ChatJoinRequestRule, InlineQueryRule, MessageRule
+from .scenario import ABCScenario, Checkbox, Choice
 
 __all__ = (
     "ABCDispatch",
@@ -59,12 +59,13 @@ __all__ = (
     "CallbackQueryReturnManager",
     "CallbackQueryRule",
     "CallbackQueryView",
+    "ChatJoinRequestRule",
+    "InlineQueryRule",
     "ChatJoinRequestCute",
     "ChatJoinRequestView",
     "ChatMemberUpdatedCute",
     "ChatMemberView",
     "Checkbox",
-    "CompositionDispatch",
     "Context",
     "Dispatch",
     "FuncHandler",
@@ -79,10 +80,11 @@ __all__ = (
     "Polling",
     "RawEventView",
     "ShortState",
-    "SingleChoice",
+    "Choice",
     "Telegrinder",
     "UpdateCute",
     "ViewBox",
     "WaiterMachine",
     "register_manager",
+    "clear_wm_storage_worker",
 )

telegrinder/bot/cute_types/base.py

@@ -9,28 +9,28 @@ from telegrinder.api import ABCAPI, API
 from telegrinder.model import Model, get_params
 
 F = typing.TypeVar("F", bound=typing.Callable[..., typing.Any])
-CuteT = typing.TypeVar("CuteT", bound="BaseCute")
-UpdateT = typing.TypeVar("UpdateT", bound=Model)
+Cute = typing.TypeVar("Cute", bound="BaseCute")
+Update = typing.TypeVar("Update", bound=Model)
 
 Executor: typing.TypeAlias = typing.Callable[
-    [CuteT, str, dict[str, typing.Any]],
+    [Cute, str, dict[str, typing.Any]],
     typing.Awaitable[Result[typing.Any, typing.Any]],
 ]
 
 if typing.TYPE_CHECKING:
 
-    class BaseCute(Model, typing.Generic[UpdateT]):
+    class BaseCute(Model, typing.Generic[Update]):
         api: ABCAPI
 
         @classmethod
-        def from_update(cls, update: UpdateT, bound_api: ABCAPI) -> typing.Self: ...
+        def from_update(cls, update: Update, bound_api: ABCAPI) -> typing.Self: ...
 
         @property
         def ctx_api(self) -> API: ...
 
 else:
 
-    class BaseCute(typing.Generic[UpdateT]):
+    class BaseCute(typing.Generic[Update]):
         @classmethod
         def from_update(cls, update, bound_api):
             return cls(**update.to_dict(), api=bound_api)
@@ -47,13 +47,13 @@ else:
 
 def compose_method_params(
     params: dict[str, typing.Any],
-    update: CuteT,
+    update: Cute,
     *,
     default_params: set[str | tuple[str, str]] | None = None,
-    validators: dict[str, typing.Callable[[CuteT], bool]] | None = None,
+    validators: dict[str, typing.Callable[[Cute], bool]] | None = None,
 ) -> dict[str, typing.Any]:
     """Compose method `params` from `update` by `default_params` and `validators`.
-    
+
     :param params: Method params.
     :param update: Update object.
     :param default_params: Default params. \
@@ -84,21 +84,19 @@ def compose_method_params(
 def shortcut(
     method_name: str,
     *,
-    executor: Executor[CuteT] | None = None,
+    executor: Executor[Cute] | None = None,
     custom_params: set[str] | None = None,
 ):
     def wrapper(func: F) -> F:
         @wraps(func)
         async def inner(
-            self: CuteT,
+            self: Cute,
             *args: typing.Any,
             **kwargs: typing.Any,
         ) -> typing.Any:
             if executor is None:
                 return await func(self, *args, **kwargs)
-            signature_params = {
-                k: p for k, p in inspect.signature(func).parameters.items() if k != "self"
-            }
+            signature_params = {k: p for k, p in inspect.signature(func).parameters.items() if k != "self"}
             params: dict[str, typing.Any] = {}
             index = 0
 

telegrinder/bot/cute_types/callback_query.py

@@ -9,6 +9,7 @@ from telegrinder.model import get_params
 from telegrinder.msgspec_utils import Option, decoder
 from telegrinder.types import (
     CallbackQuery,
+    Chat,
     InlineKeyboardMarkup,
     InputFile,
     InputMedia,
@@ -44,7 +45,7 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
         by the bot with the callback button that originated the query."""
 
         return self.message.map(
-            lambda m: m.only().map(lambda m: m.is_topic_message.unwrap_or(False)).unwrap_or(False)
+            lambda m: m.only().map(lambda m: m.is_topic_message.unwrap_or(False)).unwrap_or(False),
         )
 
     @property
@@ -54,12 +55,7 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
         This will be present if the message is sent
         by the bot with the callback button that originated the query."""
 
-        return (
-            self.message.unwrap()
-            .only()
-            .map(lambda m: m.message_thread_id.unwrap())
-            .cast(Some, Nothing)
-        )
+        return self.message.unwrap().only().map(lambda m: m.message_thread_id.unwrap()).cast(Some, Nothing)
 
     @property
     def message_id(self) -> Option[int]:
@@ -69,6 +65,14 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
 
         return self.message.map(lambda m: m.v.message_id)
 
+    @property
+    def chat(self) -> Option[Chat]:
+        """Optional. Chat the callback query originated from. This will be present
+        if the message is sent by the bot with the callback button that originated the query.
+        """
+
+        return self.message.map(lambda m: m.v.chat)
+
     def decode_callback_data(self) -> Option[dict[str, typing.Any]]:
         if "cached_callback_data" in self.__dict__:
             return self.__dict__["cached_callback_data"]
@@ -78,7 +82,7 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
         self.__dict__["cached_callback_data"] = data
         return data
 
-    @shortcut("answer_callback_query")
+    @shortcut("answer_callback_query", custom_params={"callback_query_id"})
     async def answer(
         self,
         text: str | None = None,
@@ -90,8 +94,8 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
     ) -> Result[bool, APIError]:
         """Shortcut `API.answer_callback_query()`, see the [documentation](https://core.telegram.org/bots/api#answercallbackquery)
 
-        Use this method to send answers to callback queries sent from inline keyboards. 
-        The answer will be displayed to the user as a notification at the top of the 
+        Use this method to send answers to callback queries sent from inline keyboards.
+        The answer will be displayed to the user as a notification at the top of the
         chat screen or as an alert. On success, True is returned.
 
         :param callback_query_id: Unique identifier for the query to be answered.
@@ -119,7 +123,14 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
 
     @shortcut(
         "copy_message",
-        custom_params={"reply_parameters", "message_thread_id"},
+        custom_params={
+            "reply_parameters",
+            "message_thread_id",
+            "chat_id",
+            "message_id",
+            "from_chat_id",
+            "reply_markup",
+        },
     )
     async def copy(
         self,
@@ -138,11 +149,11 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
     ) -> Result[MessageId, APIError]:
         """Shortcut `API.copy_message()`, see the [documentation](https://core.telegram.org/bots/api#copymessage)
 
-        Use this method to copy messages of any kind. Service messages, giveaway 
-        messages, giveaway winners messages, and invoice messages can't be copied. 
-        A quiz poll can be copied only if the value of the field correct_option_id 
-        is known to the bot. The method is analogous to the method forwardMessage, 
-        but the copied message doesn't have a link to the original message. Returns 
+        Use this method to copy messages of any kind. Service messages, giveaway
+        messages, giveaway winners messages, and invoice messages can't be copied.
+        A quiz poll can be copied only if the value of the field correct_option_id
+        is known to the bot. The method is analogous to the method forwardMessage,
+        but the copied message doesn't have a link to the original message. Returns
         the MessageId of the sent message on success.
 
         :param chat_id: Unique identifier for the target chat or username of the target channel \
@@ -178,7 +189,7 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
 
         return await MessageCute.copy(self, **get_params(locals()))  # type: ignore
 
-    @shortcut("delete_message", custom_params={"message_thread_id"})
+    @shortcut("delete_message", custom_params={"message_thread_id", "chat_id", "message_id"})
     async def delete(
         self,
         chat_id: int | None = None,
@@ -188,16 +199,16 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
     ) -> Result[bool, APIError]:
         """Shortcut `API.delete_message()`, see the [documentation](https://core.telegram.org/bots/api#deletemessage)
 
-        Use this method to delete a message, including service messages, with the 
-        following limitations: - A message can only be deleted if it was sent less 
-        than 48 hours ago. - Service messages about a supergroup, channel, or forum 
-        topic creation can't be deleted. - A dice message in a private chat can only 
-        be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing 
-        messages in private chats, groups, and supergroups. - Bots can delete incoming 
-        messages in private chats. - Bots granted can_post_messages permissions 
-        can delete outgoing messages in channels. - If the bot is an administrator 
-        of a group, it can delete any message there. - If the bot has can_delete_messages 
-        permission in a supergroup or a channel, it can delete any message there. 
+        Use this method to delete a message, including service messages, with the
+        following limitations: - A message can only be deleted if it was sent less
+        than 48 hours ago. - Service messages about a supergroup, channel, or forum
+        topic creation can't be deleted. - A dice message in a private chat can only
+        be deleted if it was sent more than 24 hours ago. - Bots can delete outgoing
+        messages in private chats, groups, and supergroups. - Bots can delete incoming
+        messages in private chats. - Bots granted can_post_messages permissions
+        can delete outgoing messages in channels. - If the bot is an administrator
+        of a group, it can delete any message there. - If the bot has can_delete_messages
+        permission in a supergroup or a channel, it can delete any message there.
         Returns True on success.
 
         :param chat_id: Unique identifier for the target chat or username of the target channel \
@@ -230,8 +241,8 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_text()`, see the [documentation](https://core.telegram.org/bots/api#editmessagetext)
 
-        Use this method to edit text and game messages. On success, if the edited 
-        message is not an inline message, the edited Message is returned, otherwise 
+        Use this method to edit text and game messages. On success, if the edited
+        message is not an inline message, the edited Message is returned, otherwise
         True is returned.
 
         :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the \
@@ -281,9 +292,9 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_live_location()`, see the [documentation](https://core.telegram.org/bots/api#editmessagelivelocation)
 
-        Use this method to edit live location messages. A location can be edited 
-        until its live_period expires or editing is explicitly disabled by a call 
-        to stopMessageLiveLocation. On success, if the edited message is not an 
+        Use this method to edit live location messages. A location can be edited
+        until its live_period expires or editing is explicitly disabled by a call
+        to stopMessageLiveLocation. On success, if the edited message is not an
         inline message, the edited Message is returned, otherwise True is returned.
 
         :param inline_message_id: Required if chat_id and message_id are not specified. Identifier of the \
@@ -333,8 +344,8 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_caption()`, see the [documentation](https://core.telegram.org/bots/api#editmessagecaption)
 
-        Use this method to edit captions of messages. On success, if the edited message 
-        is not an inline message, the edited Message is returned, otherwise True 
+        Use this method to edit captions of messages. On success, if the edited message
+        is not an inline message, the edited Message is returned, otherwise True
         is returned.
 
         :param chat_id: Required if inline_message_id is not specified. Unique identifier for \
@@ -388,12 +399,12 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_media()`, see the [documentation](https://core.telegram.org/bots/api#editmessagemedia)
 
-        Use this method to edit animation, audio, document, photo, or video messages. 
-        If a message is part of a message album, then it can be edited only to an audio 
-        for audio albums, only to a document for document albums and to a photo or 
-        a video otherwise. When an inline message is edited, a new file can't be uploaded; 
-        use a previously uploaded file via its file_id or specify a URL. On success, 
-        if the edited message is not an inline message, the edited Message is returned, 
+        Use this method to edit animation, audio, document, photo, or video messages.
+        If a message is part of a message album, then it can be edited only to an audio
+        for audio albums, only to a document for document albums and to a photo or
+        a video otherwise. When an inline message is edited, a new file can't be uploaded;
+        use a previously uploaded file via its file_id or specify a URL. On success,
+        if the edited message is not an inline message, the edited Message is returned,
         otherwise True is returned.
 
         :param chat_id: Required if inline_message_id is not specified. Unique identifier for \
@@ -417,7 +428,7 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
 
         :param caption_entities: A JSON-serialized list of special entities that appear in the caption, \
         which can be specified instead of parse_mode.
-        
+
         :param type: Required if media is not an `str | InputMedia` object. Type of the media, \
         must be one of `photo`, `video`, `animation`, `audio`, `document`.
 
@@ -441,8 +452,8 @@ class CallbackQueryCute(BaseCute[CallbackQuery], CallbackQuery, kw_only=True, di
     ) -> Result[Variative[MessageCute, bool], APIError]:
         """Shortcut `API.edit_message_reply_markup()`, see the [documentation](https://core.telegram.org/bots/api#editmessagereplymarkup)
 
-        Use this method to edit only the reply markup of messages. On success, if 
-        the edited message is not an inline message, the edited Message is returned, 
+        Use this method to edit only the reply markup of messages. On success, if
+        the edited message is not an inline message, the edited Message is returned,
         otherwise True is returned.
 
         :param chat_id: Required if inline_message_id is not specified. Unique identifier for \

telegrinder/bot/cute_types/chat_join_request.py

@@ -9,9 +9,7 @@ from .base import BaseCute, shortcut
 from .chat_member_updated import ChatMemberShortcuts, chat_member_interaction
 
 
-class ChatJoinRequestCute(
-    BaseCute[ChatJoinRequest], ChatJoinRequest, ChatMemberShortcuts, kw_only=True
-):
+class ChatJoinRequestCute(BaseCute[ChatJoinRequest], ChatJoinRequest, ChatMemberShortcuts, kw_only=True):
     api: ABCAPI
 
     @property
@@ -31,8 +29,8 @@ class ChatJoinRequestCute(
     ) -> Result[bool, APIError]:
         """Shortcut `API.approve_chat_join_request()`, see the [documentation](https://core.telegram.org/bots/api#approvechatjoinrequest)
 
-        Use this method to approve a chat join request. The bot must be an administrator 
-        in the chat for this to work and must have the can_invite_users administrator 
+        Use this method to approve a chat join request. The bot must be an administrator
+        in the chat for this to work and must have the can_invite_users administrator
         right. Returns True on success.
 
         :param chat_id: Unique identifier for the target chat or username of the target channel \
@@ -52,8 +50,8 @@ class ChatJoinRequestCute(
     ) -> Result[bool, APIError]:
         """Shortcut `API.decline_chat_join_request()`, see the [documentation](https://core.telegram.org/bots/api#declinechatjoinrequest)
 
-        Use this method to decline a chat join request. The bot must be an administrator 
-        in the chat for this to work and must have the can_invite_users administrator 
+        Use this method to decline a chat join request. The bot must be an administrator
+        in the chat for this to work and must have the can_invite_users administrator
         right. Returns True on success.
 
         :param chat_id: Unique identifier for the target chat or username of the target channel \
@@ -63,3 +61,6 @@ class ChatJoinRequestCute(
         """
 
         ...
+
+
+__all__ = ("ChatJoinRequestCute",)

telegrinder/bot/cute_types/chat_member_updated.py

@@ -40,10 +40,10 @@ class ChatMemberShortcuts:
     ) -> Result[bool, APIError]:
         """Shortcut `API.ban_chat_member()`, see the [documentation](https://core.telegram.org/bots/api#banchatmember)
 
-        Use this method to ban a user in a group, a supergroup or a channel. In the case 
-        of supergroups and channels, the user will not be able to return to the chat 
-        on their own using invite links, etc., unless unbanned first. The bot must 
-        be an administrator in the chat for this to work and must have the appropriate 
+        Use this method to ban a user in a group, a supergroup or a channel. In the case
+        of supergroups and channels, the user will not be able to return to the chat
+        on their own using invite links, etc., unless unbanned first. The bot must
+        be an administrator in the chat for this to work and must have the appropriate
         administrator rights. Returns True on success.
 
         :param chat_id: Unique identifier for the target group or username of the target supergroup \
@@ -72,12 +72,12 @@ class ChatMemberShortcuts:
     ) -> Result[bool, APIError]:
         """Shortcut `API.unban_chat_member()`, see the [documentation](https://core.telegram.org/bots/api#unbanchatmember)
 
-        Use this method to unban a previously banned user in a supergroup or channel. 
-        The user will not return to the group or channel automatically, but will 
-        be able to join via link, etc. The bot must be an administrator for this to 
-        work. By default, this method guarantees that after the call the user is 
-        not a member of the chat, but will be able to join it. So if the user is a member 
-        of the chat they will also be removed from the chat. If you don't want this, 
+        Use this method to unban a previously banned user in a supergroup or channel.
+        The user will not return to the group or channel automatically, but will
+        be able to join via link, etc. The bot must be an administrator for this to
+        work. By default, this method guarantees that after the call the user is
+        not a member of the chat, but will be able to join it. So if the user is a member
+        of the chat they will also be removed from the chat. If you don't want this,
         use the parameter only_if_banned. Returns True on success.
 
         :param chat_id: Unique identifier for the target group or username of the target supergroup \
@@ -106,9 +106,9 @@ class ChatMemberShortcuts:
     ) -> Result[bool, APIError]:
         """Shortcut `API.restrict_chat_member()`, see the [documentation](https://core.telegram.org/bots/api#restrictchatmember)
 
-        Use this method to restrict a user in a supergroup. The bot must be an administrator 
-        in the supergroup for this to work and must have the appropriate administrator 
-        rights. Pass True for all permissions to lift restrictions from a user. 
+        Use this method to restrict a user in a supergroup. The bot must be an administrator
+        in the supergroup for this to work and must have the appropriate administrator
+        rights. Pass True for all permissions to lift restrictions from a user.
         Returns True on success.
 
         :param chat_id: Unique identifier for the target chat or username of the target supergroup \
@@ -155,9 +155,9 @@ class ChatMemberShortcuts:
     ) -> Result[bool, APIError]:
         """Shortcut `API.promote_chat_member()`, see the [documentation](https://core.telegram.org/bots/api#promotechatmember)
 
-        Use this method to promote or demote a user in a supergroup or a channel. The 
-        bot must be an administrator in the chat for this to work and must have the 
-        appropriate administrator rights. Pass False for all boolean parameters 
+        Use this method to promote or demote a user in a supergroup or a channel. The
+        bot must be an administrator in the chat for this to work and must have the
+        appropriate administrator rights. Pass False for all boolean parameters
         to demote a user. Returns True on success.
 
         :param chat_id: Unique identifier for the target chat or username of the target channel \
@@ -217,7 +217,7 @@ class ChatMemberShortcuts:
     ) -> Result[bool, APIError]:
         """Shortcut `API.set_chat_administrator_custom_title()`, see the [documentation](https://core.telegram.org/bots/api#setchatadministratorcustomtitle)
 
-        Use this method to set a custom title for an administrator in a supergroup 
+        Use this method to set a custom title for an administrator in a supergroup
         promoted by the bot. Returns True on success.
 
         :param chat_id: Unique identifier for the target chat or username of the target supergroup \
@@ -244,3 +244,9 @@ class ChatMemberUpdatedCute(
     @property
     def user_id(self) -> int:
         return self.from_user.id
+
+
+__all__ = (
+    "ChatMemberUpdatedCute",
+    "ChatMemberShortcuts",
+)

telegrinder/bot/cute_types/inline_query.py

@@ -34,7 +34,7 @@ class InlineQueryCute(BaseCute[InlineQuery], InlineQuery, kw_only=True):
     ) -> Result[bool, APIError]:
         """Shortcut `API.answer_inline_query()`, see the [documentation](https://core.telegram.org/bots/api#answerinlinequery)
 
-        Use this method to send answers to an inline query. On success, True is returned. 
+        Use this method to send answers to an inline query. On success, True is returned.
         No more than 50 results per query are allowed.
 
         :param inline_query_id: Unique identifier for the answered query.