Source code for pyrogram.methods.users.get_users

#  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 asyncio

import pyrogram
from pyrogram import raw, types, utils
from typing import TYPE_CHECKING

if TYPE_CHECKING:
    from collections.abc import Iterable


class GetUsers:
    async def get_users(
        self: pyrogram.Client, user_ids: int | str | Iterable[int | str]
    ) -> types.User | list[types.User]:
        """Get information about a user.
        You can retrieve up to 200 users at once.

        .. include:: /_includes/usable-by/users-bots.rst

        Parameters:
            user_ids (``int`` | ``str`` | Iterable of ``int`` or ``str``):
                A list of User identifiers (id or username) or a single user id/username.
                For a contact that exists in your Telegram address book you can use his phone number (str).

        Returns:
            :obj:`~pyrogram.types.User` | List of :obj:`~pyrogram.types.User`: In case *user_ids* was not a list,
            a single user is returned, otherwise a list of users is returned.

        Raises:
            ValueError: If a user_id doesn't belong to a user.

        Example:
            .. code-block:: python

                # Get information about one user
                await app.get_users("me")

                # Get information about multiple users at once
                await app.get_users([user_id1, user_id2, user_id3])
        """

        is_iterable = not isinstance(user_ids, (int, str))
        user_ids = list(user_ids) if is_iterable else [user_ids]
        peers = await asyncio.gather(*[self.resolve_peer(i) for i in user_ids])

        for user_id, peer in zip(user_ids, peers):
            if not isinstance(
                peer,
                (
                    raw.types.InputPeerUser,
                    raw.types.InputPeerSelf,
                    raw.types.InputPeerUserFromMessage,
                    raw.types.InputUser,
                    raw.types.InputUserSelf,
                    raw.types.InputUserFromMessage,
                ),
            ):
                raise ValueError(f'The user_id "{user_id}" doesn\'t belong to a user')

        user_ids = [
            utils.get_input_user(p) if isinstance(p, raw.types.InputPeerUserFromMessage) else p
            for p in peers
        ]

        r = await self.invoke(raw.functions.users.GetUsers(id=user_ids))

        users = types.List()

        for i in r:
            users.append(types.User._parse(self, i))

        return users if is_iterable else users[0] if users else None