pyrofork/pyrogram/methods/users/get_users.py
wulan17 1b3f0933c7
Pyrofork: Update Copyright headers
Signed-off-by: wulan17 <wulan17@nusantararom.org>
2024-02-07 20:25:08 +07:00

73 lines
2.7 KiB
Python

# Pyrofork - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
# Copyright (C) 2022-present Mayuri-Chan <https://github.com/Mayuri-Chan>
#
# This file is part of Pyrofork.
#
# Pyrofork 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.
#
# Pyrofork 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 Pyrofork. If not, see <http://www.gnu.org/licenses/>.
import asyncio
from typing import Union, List, Iterable
import pyrogram
from pyrogram import raw
from pyrogram import types
class GetUsers:
async def get_users(
self: "pyrogram.Client",
user_ids: Union[int, str, Iterable[Union[int, str]]]
) -> Union["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).
You can also use user profile link in form of *t.me/<username>* (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.
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]
user_ids = await asyncio.gather(*[self.resolve_peer(i) for i in user_ids])
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]