Source code for pyrogram.methods.users.get_chat_photos
# 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 GetChatPhotos:
async def get_chat_photos(
self: pyrogram.Client,
chat_id: int | str,
limit: int = 0,
) -> AsyncGenerator[types.Photo, None] | None:
"""Get a chat or a user profile photos sequentially.
.. 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).
limit (``int``, *optional*):
Limits the number of profile photos to be retrieved.
By default, no limit is applied and all profile photos are returned.
Returns:
``Generator``: A generator yielding :obj:`~pyrogram.types.Photo` objects.
Example:
.. code-block:: python
async for photo in app.get_chat_photos("me"):
print(photo)
"""
peer_id = await self.resolve_peer(chat_id)
if isinstance(
peer_id,
(
raw.types.InputPeerChannel,
raw.types.InputPeerChannelFromMessage,
raw.types.InputPeerChat,
),
):
if isinstance(peer_id, raw.types.InputPeerChat):
r = await self.invoke(raw.functions.messages.GetFullChat(chat_id=peer_id.chat_id))
else:
r = await self.invoke(
raw.functions.channels.GetFullChannel(channel=utils.get_input_channel(peer_id))
)
chat_photo = types.Photo._parse(self, r.full_chat.chat_photo)
if self.me.is_bot:
if chat_photo:
yield chat_photo
return
current = 0
total = limit or (1 << 31) - 1
limit = min(100, total)
offset_id = 0
first = True
while True:
messages = await utils.parse_messages(
self,
await self.invoke(
raw.functions.messages.Search(
peer=peer_id,
q="",
filter=raw.types.InputMessagesFilterChatPhotos(),
min_date=0,
max_date=0,
offset_id=offset_id,
add_offset=0,
limit=limit,
max_id=0,
min_id=0,
hash=0,
)
),
)
photos = [message.new_chat_photo for message in messages if message.new_chat_photo]
if first:
first = False
if chat_photo and (
not photos or chat_photo.file_unique_id != photos[0].file_unique_id
):
photos.insert(0, chat_photo)
for photo in photos:
yield photo
current += 1
if current >= total:
return
if not messages:
return
offset_id = messages[-1].id
else:
current = 0
total = limit or (1 << 31)
limit = min(100, total)
offset = 0
while True:
r = await self.invoke(
raw.functions.photos.GetUserPhotos(
user_id=peer_id, offset=offset, max_id=0, limit=limit
)
)
photos = [types.Photo._parse(self, photo) for photo in r.photos]
if not photos:
return
offset += len(photos)
for photo in photos:
yield photo
current += 1
if current >= total:
return