telegrinder 0.2.1__py3-none-any.whl → 0.3.0__py3-none-any.whl

telegrinder/bot/cute_types/chat_join_request.py

@@ -19,7 +19,11 @@ class ChatJoinRequestCute(BaseCute[ChatJoinRequest], ChatJoinRequest, ChatMember
     def user_id(self) -> int:
         return self.from_user.id
 
-    @shortcut("approve_chat_join_request", executor=chat_member_interaction)
+    @shortcut(
+        "approve_chat_join_request",
+        executor=chat_member_interaction,
+        custom_params={"chat_id", "user_id"},
+    )
     async def approve(
         self,
         chat_id: int | str | None = None,
@@ -30,17 +34,15 @@ class ChatJoinRequestCute(BaseCute[ChatJoinRequest], ChatJoinRequest, ChatMember
 
         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 \
-        (in the format @channelusername).
-
-        :param user_id: Unique identifier of the target user.
-        """
+        right. Returns True on success."""
 
         ...
 
-    @shortcut("decline_chat_join_request", executor=chat_member_interaction)
+    @shortcut(
+        "decline_chat_join_request",
+        executor=chat_member_interaction,
+        custom_params={"chat_id", "user_id"},
+    )
     async def decline(
         self,
         chat_id: int | str | None = None,
@@ -51,13 +53,7 @@ class ChatJoinRequestCute(BaseCute[ChatJoinRequest], ChatJoinRequest, ChatMember
 
         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 \
-        (in the format @channelusername).
-
-        :param user_id: Unique identifier of the target user.
-        """
+        right. Returns True on success."""
 
         ...
 

telegrinder/bot/cute_types/chat_member_updated.py

@@ -27,7 +27,7 @@ async def chat_member_interaction(
 class ChatMemberShortcuts:
     """Shortcut methods for `ChatMemberUpdatedCute`, `ChatJoinRequestCute` objects."""
 
-    @shortcut("ban_chat_member", executor=chat_member_interaction)
+    @shortcut("ban_chat_member", executor=chat_member_interaction, custom_params={"chat_id", "user_id"})
     async def ban_chat_member(
         self,
         chat_id: int | str | None = None,
@@ -42,25 +42,11 @@ class ChatMemberShortcuts:
         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 \
-        or channel (in the format @channelusername).
-
-        :param user_id: Unique identifier of the target user.
-
-        :param until_date: Date when the user will be unbanned; Unix time. If user is banned for more \
-        than 366 days or less than 30 seconds from the current time they are considered \
-        to be banned forever. Applied for supergroups and channels only.
-
-        :param revoke_messages: Pass True to delete all messages from the chat for the user that is being removed. \
-        If False, the user will be able to see messages in the group that were sent \
-        before the user was removed. Always True for supergroups and channels. \
-        """
+        administrator rights. Returns True on success."""
 
         ...
 
-    @shortcut("unban_chat_member", executor=chat_member_interaction)
+    @shortcut("unban_chat_member", executor=chat_member_interaction, custom_params={"chat_id", "user_id"})
     async def unban_chat_member(
         self,
         chat_id: int | str | None = None,
@@ -76,22 +62,14 @@ class ChatMemberShortcuts:
         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 \
-        or channel (in the format @channelusername).
-
-        :param user_id: Unique identifier of the target user.
-
-        :param only_if_banned: Do nothing if the user is not banned.
-        """
+        use the parameter only_if_banned. Returns True on success."""
 
         ...
 
     @shortcut(
         "restrict_chat_member",
         executor=chat_member_interaction,
-        custom_params={"permissions"},
+        custom_params={"permissions", "chat_id", "user_id"},
     )
     async def restrict_chat_member(
         self,
@@ -107,29 +85,11 @@ class ChatMemberShortcuts:
         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 \
-        (in the format @supergroupusername).
-
-        :param user_id: Unique identifier of the target user.
-
-        :param permissions: A JSON-serialized object for new user permissions.
-
-        :param use_independent_chat_permissions: Pass True if chat permissions are set independently. Otherwise, the can_send_other_messages \
-        and can_add_web_page_previews permissions will imply the can_send_messages, \
-        can_send_audios, can_send_documents, can_send_photos, can_send_videos, \
-        can_send_video_notes, and can_send_voice_notes permissions; the can_send_polls \
-        permission will imply the can_send_messages permission.
-
-        :param until_date: Date when restrictions will be lifted for the user; Unix time. If user is \
-        restricted for more than 366 days or less than 30 seconds from the current \
-        time, they are considered to be restricted forever.
-        """
+        Returns True on success."""
 
         ...
 
-    @shortcut("promote_chat_member", executor=chat_member_interaction)
+    @shortcut("promote_chat_member", executor=chat_member_interaction, custom_params={"chat_id", "user_id"})
     async def promote_chat_member(
         self,
         chat_id: int | str | None = None,
@@ -156,56 +116,15 @@ class ChatMemberShortcuts:
         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 \
-        (in the format @channelusername).
-
-        :param user_id: Unique identifier of the target user.
-
-        :param is_anonymous: Pass True if the administrator's presence in the chat is hidden.
-
-        :param can_manage_chat: Pass True if the administrator can access the chat event log, get boost list, \
-        see hidden supergroup and channel members, report spam messages and ignore \
-        slow mode. Implied by any other administrator privilege.
-
-        :param can_delete_messages: Pass True if the administrator can delete messages of other users.
-
-        :param can_manage_video_chats: Pass True if the administrator can manage video chats.
-
-        :param can_restrict_members: Pass True if the administrator can restrict, ban or unban chat members, \
-        or access supergroup statistics.
-
-        :param can_promote_members: Pass True if the administrator can add new administrators with a subset \
-        of their own privileges or demote administrators that they have promoted, \
-        directly or indirectly (promoted by administrators that were appointed \
-        by him).
-
-        :param can_change_info: Pass True if the administrator can change chat title, photo and other settings. \
-
-        :param can_invite_users: Pass True if the administrator can invite new users to the chat.
-
-        :param can_post_stories: Pass True if the administrator can post stories to the chat.
-
-        :param can_edit_stories: Pass True if the administrator can edit stories posted by other users.
-
-        :param can_delete_stories: Pass True if the administrator can delete stories posted by other users. \
-
-        :param can_post_messages: Pass True if the administrator can post messages in the channel, or access \
-        channel statistics; for channels only.
-
-        :param can_edit_messages: Pass True if the administrator can edit messages of other users and can pin \
-        messages; for channels only.
-
-        :param can_pin_messages: Pass True if the administrator can pin messages; for supergroups only. \
-
-        :param can_manage_topics: Pass True if the user is allowed to create, rename, close, and reopen forum \
-        topics; for supergroups only.
-        """
+        to demote a user. Returns True on success."""
 
         ...
 
-    @shortcut("set_chat_administrator_custom_title", executor=chat_member_interaction)
+    @shortcut(
+        "set_chat_administrator_custom_title",
+        executor=chat_member_interaction,
+        custom_params={"chat_id", "user_id"},
+    )
     async def set_chat_administrator_custom_title(
         self,
         custom_title: str,
@@ -216,16 +135,7 @@ class ChatMemberShortcuts:
         """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
-        promoted by the bot. Returns True on success.
-
-        :param chat_id: Unique identifier for the target chat or username of the target supergroup \
-        (in the format @supergroupusername).
-
-        :param user_id: Unique identifier of the target user.
-
-        :param custom_title: New custom title for the administrator; 0-16 characters, emoji are not \
-        allowed.
-        """
+        promoted by the bot. Returns True on success."""
 
         ...
 
@@ -245,6 +155,6 @@ class ChatMemberUpdatedCute(
 
 
 __all__ = (
-    "ChatMemberUpdatedCute",
     "ChatMemberShortcuts",
+    "ChatMemberUpdatedCute",
 )

telegrinder/bot/cute_types/inline_query.py

@@ -24,7 +24,7 @@ class InlineQueryCute(BaseCute[InlineQuery], InlineQuery, kw_only=True):
     async def answer(
         self,
         results: InlineQueryResult | list[InlineQueryResult],
-        inline_query_id: str | None = None,
+        inline_query_id: str,
         cache_time: int | None = None,
         is_personal: bool | None = None,
         next_offset: str | None = None,
@@ -35,25 +35,16 @@ class InlineQueryCute(BaseCute[InlineQuery], InlineQuery, kw_only=True):
 
         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.
 
         :param results: A JSON-serialized array of results for the inline query.
 
-        :param cache_time: The maximum amount of time in seconds that the result of the inline query \
-        may be cached on the server. Defaults to 300.
-
-        :param is_personal: Pass True if results may be cached on the server side only for the user that \
-        sent the query. By default, results may be returned to any user who sends \
-        the same query.
+        :param cache_time: The maximum amount of time in seconds that the result of the inline querymay be cached on the server. Defaults to 300.
 
-        :param next_offset: Pass the offset that a client should send in the next query with the same text \
-        to receive more results. Pass an empty string if there are no more results \
-        or if you don't support pagination. Offset length can't exceed 64 bytes. \
+        :param is_personal: Pass True if results may be cached on the server side only for the user thatsent the query. By default, results may be returned to any user who sendsthe same query.
 
-        :param button: A JSON-serialized object describing a button to be shown above inline query \
-        results.
-        """
+        :param next_offset: Pass the offset that a client should send in the next query with the same textto receive more results. Pass an empty string if there are no more resultsor if you don't support pagination. Offset length can't exceed 64 bytes.
+        :param button: A JSON-serialized object describing a button to be shown above inline queryresults."""
 
         params = compose_method_params(
             get_params(locals()),