Some fixes for checklists

KurimuzonAkuma · KurimuzonAkuma · commit c4b754f87f49 · 2025-07-04T00:39:06.000+03:00
diff --git a/compiler/docs/compiler.py b/compiler/docs/compiler.py
@@ -246,6 +246,7 @@ def get_title_list(s: str) -> list:
             send_reaction
             edit_message_text
             edit_message_caption
+            edit_message_checklist
             edit_message_media
             edit_message_reply_markup
             edit_inline_text
@@ -777,6 +778,7 @@ def get_title_list(s: str) -> list:
         """,
         input_content="""
         Input Content
+            InputChecklist
             InputContactMessageContent
             InputCredentials
             InputCredentialsApplePay
@@ -887,6 +889,7 @@ def get_title_list(s: str) -> list:
             Message.edit_text
             Message.edit_caption
             Message.edit_media
+            Message.edit_checklist
             Message.edit_reply_markup
             Message.reply
             Message.reply_text
diff --git a/compiler/errors/source/400_BAD_REQUEST.tsv b/compiler/errors/source/400_BAD_REQUEST.tsv
@@ -549,6 +549,7 @@ TIMEZONE_INVALID	The specified timezone does not exist.
 TITLE_INVALID	The specified stickerpack title is invalid.
 TMP_PASSWORD_DISABLED	The temporary password is disabled.
 TMP_PASSWORD_INVALID	The temporary password is invalid.
+TODO_ITEM_DUPLICATE	The provided ToDo task already exists.
 TOKEN_EMPTY	The specified token is empty.
 TOKEN_INVALID	The provided token is invalid.
 TOKEN_SECRET_INVALID	The specified token secret is invalid.
diff --git a/pyrogram/methods/messages/__init__.py b/pyrogram/methods/messages/__init__.py
@@ -29,6 +29,7 @@
 from .edit_inline_reply_markup import EditInlineReplyMarkup
 from .edit_inline_text import EditInlineText
 from .edit_message_caption import EditMessageCaption
+from .edit_message_checklist import EditMessageChecklist
 from .edit_message_media import EditMessageMedia
 from .edit_message_reply_markup import EditMessageReplyMarkup
 from .edit_message_text import EditMessageText
@@ -95,6 +96,7 @@ class Messages(
     AddToGifs,
     DeleteMessages,
     EditMessageCaption,
+    EditMessageChecklist,
     EditMessageReplyMarkup,
     EditMessageMedia,
     EditMessageText,
diff --git a/pyrogram/methods/messages/edit_message_checklist.py b/pyrogram/methods/messages/edit_message_checklist.py
@@ -0,0 +1,106 @@
+#  Pyrogram - Telegram MTProto API Client Library for Python
+#  Copyright (C) 2017-present 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/>.
+
+from typing import Optional, Union
+
+import pyrogram
+from pyrogram import raw, types, utils
+
+
+class EditMessageChecklist:
+    async def edit_message_checklist(
+        self: "pyrogram.Client",
+        chat_id: Union[int, str],
+        message_id: int,
+        checklist: "types.InputChecklist",
+        business_connection_id: Optional[str] = None,
+        reply_markup: Optional["types.InlineKeyboardMarkup"] = None,
+    ) -> "types.Message":
+        """Use this method to edit a checklist.
+
+        .. include:: /_includes/usable-by/users-bots.rst
+
+        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).
+
+            message_id (``int``):
+                Message identifier in the chat specified in chat_id.
+
+            checklist (:obj:`~pyrogram.types.InputChecklist`):
+                New checklist.
+
+            business_connection_id (``str``, *optional*):
+                Unique identifier of the business connection on behalf of which the message will be sent.
+
+            reply_markup (:obj:`~pyrogram.types.InlineKeyboardMarkup`, *optional*):
+                An InlineKeyboardMarkup object.
+
+        Returns:
+            :obj:`~pyrogram.types.Message`: On success, the edited message is returned.
+
+        Example:
+            .. code-block:: python
+
+                # Replace the current checklist with a new one
+                await app.edit_message_checklist(
+                    chat_id=chat_id,
+                    message_id=message_id,
+                    checklist=types.InputChecklist(
+                        title="Checklist",
+                        tasks=[
+                            types.InputChecklistTask(id=1, text="Task 1"),
+                            types.InputChecklistTask(id=2, text="Task 2")
+                        ]
+                    )
+                )
+        """
+        title, entities = (await utils.parse_text_entities(
+            self, checklist.title, checklist.parse_mode, checklist.entities
+        )).values()
+
+        r = await self.invoke(
+            raw.functions.messages.EditMessage(
+                peer=await self.resolve_peer(chat_id),
+                id=message_id,
+                media=raw.types.InputMediaTodo(
+                    todo=raw.types.TodoList(
+                        title=raw.types.TextWithEntities(
+                            text=title,
+                            entities=entities or []
+                        ),
+                        list=[await task.write(self) for task in checklist.tasks],
+                        others_can_append=checklist.others_can_add_tasks,
+                        others_can_complete=checklist.others_can_mark_tasks_as_done
+                    )
+                ),
+                reply_markup=await reply_markup.write(self) if reply_markup else None,
+                entities=entities
+            ),
+            business_connection_id=business_connection_id
+        )
+
+        for i in r.updates:
+            if isinstance(i, (raw.types.UpdateEditMessage, raw.types.UpdateEditChannelMessage)):
+                return await types.Message._parse(
+                    self, i.message,
+                    {i.id: i for i in r.users},
+                    {i.id: i for i in r.chats}
+                )
diff --git a/pyrogram/methods/messages/mark_checklist_tasks_as_done.py b/pyrogram/methods/messages/mark_checklist_tasks_as_done.py
@@ -19,17 +19,19 @@
 from typing import List, Union
 
 import pyrogram
-from pyrogram import raw, types
+from pyrogram import raw
 
 
 class MarkChecklistTasksAsDone:
     async def mark_checklist_tasks_as_done(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
         message_id: int,
-        tasks: List["types.InputChecklistTask"]
+        *,
+        marked_as_done_task_ids: List[int] = None,
+        marked_as_not_done_task_ids: List[int] = None,
     ) -> int:
-        """Add tasks to a checklist in a message.
+        """Add tasks of a checklist in a message as done or not done.
 
         .. include:: /_includes/usable-by/users.rst
 
@@ -42,31 +44,30 @@ async def mark_checklist_tasks_as_done(
             message_id (``int``):
                 Identifier of the message containing the checklist.
 
-            tasks (List of :obj:`~pyrogram.types.InputChecklistTask`):
-                List of tasks to add to the checklist.
+            marked_as_done_task_ids (List of ``int``):
+                Identifiers of tasks that were marked as done.
+
+            marked_as_not_done_task_ids (List of ``int``):
+                Identifiers of tasks that were marked as not done.
 
         Returns:
             ``bool``: On success, True is returned.
 
         Example:
             .. code-block:: python
 
-                await app.add_checklist_tasks(
+                await app.mark_checklist_tasks_as_done(
                     chat_id,
                     message_id,
-                    tasks=[
-                        types.InputChecklistTask(
-                            id=2,
-                            text="Task 2"
-                        )
-                    ]
+                    marked_as_done_task_ids=[1, 2, 3]
                 )
         """
         await self.invoke(
-            raw.functions.messages.AppendTodoList(
+            raw.functions.messages.ToggleTodoCompleted(
                 peer=await self.resolve_peer(chat_id),
                 msg_id=message_id,
-                list=[await task.write(self) for task in tasks]
+                completed=marked_as_done_task_ids or [],
+                incompleted=marked_as_not_done_task_ids or [],
             )
         )
 
diff --git a/pyrogram/methods/messages/send_checklist.py b/pyrogram/methods/messages/send_checklist.py
@@ -29,47 +29,36 @@ class SendChecklist:
     async def send_checklist(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
-        title: str,
-        tasks: List["types.InputChecklistTask"],
-        parse_mode: Optional["enums.ParseMode"] = None,
-        entities: Optional[List["types.MessageEntity"]] = None,
-        others_can_add_tasks: Optional[bool] = None,
-        others_can_mark_tasks_as_done: Optional[bool] = None,
+        checklist: "types.InputChecklist",
         disable_notification: Optional[bool] = None,
         protect_content: Optional[bool] = None,
         message_thread_id: Optional[int] = None,
         effect_id: Optional[int] = None,
         reply_parameters: Optional["types.ReplyParameters"] = None,
         schedule_date: Optional[datetime] = None,
-        paid_message_star_count: int = None
+        business_connection_id: Optional[str] = None,
+        paid_message_star_count: int = None,
+        reply_markup: Optional[
+            Union[
+                "types.InlineKeyboardMarkup",
+                "types.ReplyKeyboardMarkup",
+                "types.ReplyKeyboardRemove",
+                "types.ForceReply"
+            ]
+        ] = None,
     ) -> "types.Message":
         """Send a new checklist.
 
-        .. include:: /_includes/usable-by/users.rst
+        .. include:: /_includes/usable-by/users-bots.rst
 
         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).
 
-            title (``str``):
-                Title of the checklist.
-
-            tasks (List of ``str``):
-                List of tasks in the checklist, 1-30 tasks.
-
-            parse_mode (:obj:`~pyrogram.enums.ParseMode`, *optional*):
-                The parse mode to use for the checklist.
-
-            entities (List of :obj:`~pyrogram.types.MessageEntity`, *optional*):
-                List of special entities that appear in the checklist title.
-
-            others_can_add_tasks (``bool``, *optional*):
-                True, if other users can add tasks to the list.
-
-            others_can_mark_tasks_as_done (``bool``, *optional*):
-                True, if other users can mark tasks as done or not done.
+            checklist (:obj:`~pyrogram.types.InputChecklist`):
+                Checklist to send.
 
             disable_notification (``bool``, *optional*):
                 Sends the message silently.
@@ -92,9 +81,16 @@ async def send_checklist(
             schedule_date (:py:obj:`~datetime.datetime`, *optional*):
                 Date when the message will be automatically sent.
 
+            business_connection_id (``str``, *optional*):
+                Unique identifier of the business connection on behalf of which the message will be sent.
+
             paid_message_star_count (``int``, *optional*):
                 The number of Telegram Stars the user agreed to pay to send the messages.
 
+            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.
+
         Returns:
             :obj:`~pyrogram.types.Message`: On success, the sent checklist message is returned.
 
@@ -111,7 +107,7 @@ async def send_checklist(
                 )
         """
         title, entities = (await utils.parse_text_entities(
-            self, title, parse_mode, entities
+            self, checklist.title, checklist.parse_mode, checklist.entities
         )).values()
 
         r = await self.invoke(
@@ -123,9 +119,9 @@ async def send_checklist(
                             text=title,
                             entities=entities or []
                         ),
-                        list=[await task.write(self) for task in tasks],
-                        others_can_append=others_can_add_tasks,
-                        others_can_complete=others_can_mark_tasks_as_done
+                        list=[await task.write(self) for task in checklist.tasks],
+                        others_can_append=checklist.others_can_add_tasks,
+                        others_can_complete=checklist.others_can_mark_tasks_as_done
                     )
                 ),
                 message="",
@@ -139,8 +135,10 @@ async def send_checklist(
                 schedule_date=utils.datetime_to_timestamp(schedule_date),
                 noforwards=protect_content,
                 allow_paid_stars=paid_message_star_count,
+                reply_markup=await reply_markup.write(self) if reply_markup else None,
                 effect=effect_id
-            )
+            ),
+            business_connection_id=business_connection_id
         )
 
         messages = await utils.parse_messages(client=self, messages=r)
diff --git a/pyrogram/types/input_content/__init__.py b/pyrogram/types/input_content/__init__.py
@@ -16,6 +16,7 @@
 #  You should have received a copy of the GNU Lesser General Public License
 #  along with Pyrogram.  If not, see <http://www.gnu.org/licenses/>.
 
+from .input_checklist import InputChecklist
 from .input_contact_message_content import InputContactMessageContent
 from .input_credentials import InputCredentials
 from .input_credentials_apple_pay import InputCredentialsApplePay
@@ -52,6 +53,7 @@
 from .input_venue_message_content import InputVenueMessageContent
 
 __all__ = [
+    "InputChecklist",
     "InputContactMessageContent",
     "InputCredentials",
     "InputCredentialsApplePay",
diff --git a/pyrogram/types/input_content/input_checklist.py b/pyrogram/types/input_content/input_checklist.py
diff --git a/pyrogram/types/messages_and_media/checklist_tasks_added.py b/pyrogram/types/messages_and_media/checklist_tasks_added.py
diff --git a/pyrogram/types/messages_and_media/message.py b/pyrogram/types/messages_and_media/message.py
