LonamiWebs/Telethon
1
1
Fork 0
mirror of https://github.com/LonamiWebs/Telethon.git synced 2025-03-03 19:00:21 +03:00
Code Issues Packages Projects Releases Wiki Activity

Fix-up #565 with some rewording/behaviour changes

Browse Source 
Such as not waiting unless strictly needed and better wording.
This commit is contained in:
Lonami Exo 2018-01-27 21:37:57 +01:00
parent 067006d248
commit 700b4c3169
1 changed files with 18 additions and 21 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

39
telethon/telegram_client.py
View File

@ -647,7 +647,7 @@ class TelegramClient(TelegramBareClient):
def get_message_history(self, entity, limit=20, offset_date=None, def get_message_history(self, entity, limit=20, offset_date=None,
offset_id=0, max_id=0, min_id=0, add_offset=0, offset_id=0, max_id=0, min_id=0, add_offset=0,
batch_size=100, wait_time=1): batch_size=100, wait_time=None):
""" """
Gets the message history for the specified entity Gets the message history for the specified entity
@ -683,13 +683,15 @@ class TelegramClient(TelegramBareClient):
this offset = older messages). this offset = older messages).
batch_size (:obj:`int`): batch_size (:obj:`int`):
Number of messages to be returned by each Telegram API Messages will be returned in chunks of this size (100 is
"getHistory" request. Notice that Telegram has a hard limit the maximum). While it makes no sense to modify this value,
of 100 messages per API call. you are still free to do so.
wait_time (:obj:`int`): wait_time (:obj:`int`):
Wait time between different "getHistory" requests. Use this Wait time between different ``GetHistoryRequest``. Use this
parameter to avoid hitting the "FloodWaitError" (see note below). parameter to avoid hitting the ``FloodWaitError`` as needed.
If left to ``None``, it will default to 1 second only if
the limit is higher than 3000.
Returns: Returns:
A list of messages with extra attributes: A list of messages with extra attributes:
@ -701,13 +703,11 @@ class TelegramClient(TelegramBareClient):
* ``.to`` = entity to which the message was sent. * ``.to`` = entity to which the message was sent.
Notes: Notes:
Telegram limit for "getHistory" requests seems to be 3000 messages Telegram's flood wait limit for ``GetHistoryRequest`` seems to
within 30 seconds. Therefore, please adjust "batch_size" and be around 30 seconds per 3000 messages, therefore a sleep of 1
"wait_time" parameters accordingly to avoid incurring into a second is the default for this limit (or above). You may need
"FloodWaitError". For example, if you plan to retrieve more than 3000 an higher limit, so you're free to set the ``batch_size`` that
messages (i.e. limit=3000 or None) in batches of 100 messages you think may be good.
(i.e. batch_size=100) please make sure to select a wait time of at
least one second (i.e. wait_time=1).
""" """
entity = self.get_input_entity(entity) entity = self.get_input_entity(entity)
@ -720,12 +720,16 @@ class TelegramClient(TelegramBareClient):
)) ))
return getattr(result, 'count', len(result.messages)), [], [] return getattr(result, 'count', len(result.messages)), [], []
if wait_time is None:
wait_time = 1 if limit > 3000 else 0
batch_size = min(max(batch_size, 1), 100)
total_messages = 0 total_messages = 0
messages = UserList() messages = UserList()
entities = {} entities = {}
while len(messages) < limit: while len(messages) < limit:
# Telegram has a hard limit of 100 # Telegram has a hard limit of 100
real_limit = min(limit - len(messages), min(batch_size,100)) real_limit = min(limit - len(messages), batch_size)
result = self(GetHistoryRequest( result = self(GetHistoryRequest(
peer=entity, peer=entity,
limit=real_limit, limit=real_limit,
@ -741,8 +745,6 @@ class TelegramClient(TelegramBareClient):
) )
total_messages = getattr(result, 'count', len(result.messages)) total_messages = getattr(result, 'count', len(result.messages))
# TODO We can potentially use self.session.database, but since
# it might be disabled, use a local dictionary.
for u in result.users: for u in result.users:
entities[utils.get_peer_id(u)] = u entities[utils.get_peer_id(u)] = u
for c in result.chats: for c in result.chats:
@ -753,11 +755,6 @@ class TelegramClient(TelegramBareClient):
offset_id = result.messages[-1].id offset_id = result.messages[-1].id
offset_date = result.messages[-1].date offset_date = result.messages[-1].date
# Telegram limit seems to be 3000 messages within 30 seconds in
# batches of 100 messages each request (since the FloodWait was
# of 30 seconds). If the limit is greater than that, we will
# sleep 1s between each request.
time.sleep(wait_time) time.sleep(wait_time)
# Add a few extra attributes to the Message to make it friendlier. # Add a few extra attributes to the Message to make it friendlier.