Refactor get_chat_history method (KurimuzonAkuma#209)

Author: Danipulok

pyrogram/methods/messages/get_chat_history.py

@@ -18,25 +18,27 @@
 
 import logging
 from datetime import datetime
-from typing import AsyncGenerator, Union
+from typing import AsyncIterator, Union, List
 
 import pyrogram
 from pyrogram import raw, types, utils
 
 log = logging.getLogger(__name__)
 
+
 async def get_chunk(
-    *,
     client: "pyrogram.Client",
     chat_id: Union[int, str],
+    *,
     limit: int = 0,
     offset: int = 0,
     offset_id: int = 0,
     from_date: datetime = utils.zero_datetime(),
-    min_id: int = 0,
-    max_id: int = 0,
-    reverse: bool = False
-):
+    min_id: int = 0,  # Inclusive
+    max_id: int = 0,  # Inclusive
+    reverse: bool = False,
+) -> List["types.Message"]:
+    # Telegram API requires `offset_id` as starting point, boundaries alone don't work
     if (min_id or max_id) and not offset_id:
         if max_id:
             offset_id = max_id + 1
@@ -46,7 +48,7 @@ async def get_chunk(
     if min_id and max_id and not offset_id:
         offset_id = max_id + 1
 
-    messages = await client.invoke(
+    history: raw.base.messages.Messages = await client.invoke(
         raw.functions.messages.GetHistory(
             peer=await client.resolve_peer(chat_id),
             offset_id=offset_id,
@@ -60,25 +62,26 @@ async def get_chunk(
         sleep_threshold=60
     )
 
-    messages = await utils.parse_messages(client, messages, replies=0)
+    messages = await utils.parse_messages(client, history, replies=0)
 
     if reverse:
         messages.reverse()
-
+        
     return messages
 
+
 class GetChatHistory:
     async def get_chat_history(
         self: "pyrogram.Client",
         chat_id: Union[int, str],
         limit: int = 0,
         offset: int = 0,
+        offset_id: int = None,
         offset_date: datetime = utils.zero_datetime(),
         min_id: int = 0,
         max_id: int = 0,
         reverse: bool = False,
-        offset_id: int = None
-    ) -> AsyncGenerator["types.Message", None]:
+    ) -> AsyncIterator["types.Message"]:
         """Get messages from a chat history.
 
         The messages are returned in reverse chronological order.
@@ -99,14 +102,21 @@ async def get_chat_history(
                 Sequential number of the first message to be returned.
                 Negative values are also accepted and become useful in case you set offset_id or offset_date.
 
+            offset_id (``int``, *optional*):
+                Identifier of the first message to be returned.
+                This parameter is deprecated and should not be used.
+                Use `min_id` / `max_id` instead for proper filtering.
+
             offset_date (:py:obj:`~datetime.datetime`, *optional*):
                 Pass a date as offset to retrieve only older messages starting from that date.
 
             min_id (``int``, *optional*):
-                If a positive value was provided, the method will return only messages with IDs more than min_id (inclusive).
+                If a positive value was provided, the method will return only messages
+                with IDs more than or equal to min_id (inclusive).
 
             max_id (``int``, *optional*):
-                If a positive value was provided, the method will return only messages with IDs less than max_id (inclusive).
+                If a positive value was provided, the method will return only messages
+                with IDs less than or equal to max_id (inclusive).
 
             reverse (``bool``, *optional*):
                 Pass True to retrieve the messages from oldest to newest.
@@ -120,13 +130,15 @@ async def get_chat_history(
                 async for message in app.get_chat_history(chat_id):
                     print(message.text)
         """
-        log.warning(
-            "`offset_id` is deprecated and will be removed in future updates. Use `min_id` or `max_id` instead."
-        )
+        if offset_id is not None:
+            log.warning(
+                "`offset_id` is deprecated and will be removed in future updates. " \
+                "Use `min_id` or `max_id` instead."
+            )
 
-        current = 0
-        total = limit or (1 << 31) - 1
-        limit = min(100, total)
+        current: int = 0
+        total: int = limit or (1 << 31) - 1
+        limit: int = min(100, total)  # We can only retrieve up to 100 messages at a time
 
         min_id = (min_id - 1) if min_id else 0  # Make `min_id` inclusive
         max_id = (max_id + 1) if max_id else 0  # Make `max_id` inclusive
@@ -149,16 +161,15 @@ async def get_chat_history(
                 min_id=min_id,
                 reverse=reverse
             )
-
+            
             if not messages:
                 return
 
             offset_id = messages[-1].id + (1 if reverse else 0)
-
             for message in messages:
                 yield message
 
                 current += 1
-
+                
                 if current >= total:
                     return