Source code for pyrogram.methods.chats.get_dialogs
# 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 __future__ import annotations
import pyrogram
from pyrogram import raw, types, utils
from typing import TYPE_CHECKING
if TYPE_CHECKING:
from collections.abc import AsyncGenerator
class GetDialogs:
async def get_dialogs(
self: pyrogram.Client,
limit: int = 0,
exclude_pinned: bool | None = None,
from_archive: bool | None = None,
) -> AsyncGenerator[types.Dialog, None] | None:
"""Get a user's dialogs sequentially.
.. include:: /_includes/usable-by/users.rst
Parameters:
limit (``int``, *optional*):
Limits the number of dialogs to be retrieved.
By default, no limit is applied and all dialogs are returned.
exclude_pinned (``bool``, *optional*):
Pass True to exclude the pinned dialogs.
from_archive (``bool``, *optional*):
Pass True to get the archived dialogs, False for the unarchived ones.
By default, dialogs from both lists are returned.
Returns:
``Generator``: A generator yielding :obj:`~pyrogram.types.Dialog` objects.
Example:
.. code-block:: python
# Iterate through all dialogs
async for dialog in app.get_dialogs():
print(dialog.chat.first_name or dialog.chat.title)
"""
current = 0
total = limit or (1 << 31) - 1
limit = min(100, total)
offset_date = 0
offset_id = 0
offset_peer = raw.types.InputPeerEmpty()
while True:
r = await self.invoke(
raw.functions.messages.GetDialogs(
offset_date=offset_date,
offset_id=offset_id,
offset_peer=offset_peer,
limit=limit,
hash=0,
exclude_pinned=exclude_pinned,
folder_id=None if from_archive is None else 1 if from_archive else 0,
),
sleep_threshold=60,
)
users = {i.id: i for i in r.users}
chats = {i.id: i for i in r.chats}
messages = {}
for message in r.messages:
if isinstance(message, raw.types.MessageEmpty):
continue
chat_id = utils.get_peer_id(message.peer_id)
messages[chat_id] = await types.Message._parse(self, message, users, chats)
dialogs = []
for dialog in r.dialogs:
if not isinstance(dialog, raw.types.Dialog):
continue
dialogs.append(types.Dialog._parse(self, dialog, messages, users, chats))
if not dialogs:
return
last = next((x.top_message for x in reversed(dialogs) if x.top_message), None)
offset_id = last.id if last else 0
offset_date = utils.datetime_to_timestamp(last.date) if last else 0
offset_peer = await self.resolve_peer(dialogs[-1].chat.id)
for dialog in dialogs:
yield dialog
current += 1
if current >= total:
return