pyrofork/pyrogram/methods/users/get_users.py
DevOps117 6e1425ada3
Drop support for iterators where they are not needed (#969)
* delete_messages: Drop support for generators

Since we used a list there anyway, this approach will lead to more localized errors and can reduce function overhead.

Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com>

* delete_messages: Return pts_count:int

An example usecase would be for a normal bot which uses range based on message ids
instead of keeping a track of messages and using the DeletedMessagesHandler.

Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com>

* Drop support for Iterators and update docstrings and some cleanups.

Signed-off-by: devops117 <55235206+devops117@users.noreply.github.com>

* Update get_users.py

* Update get_messages.py

* Update delete_messages.py

* Update forward_messages.py

* Update get_messages.py

Co-authored-by: Dan <14043624+delivrance@users.noreply.github.com>
2022-05-14 08:58:30 +02:00

70 lines
2.4 KiB
Python

# 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/>.
import asyncio
from typing import Union, List
import pyrogram
from pyrogram import raw
from pyrogram import types
class GetUsers:
async def get_users(
self: "pyrogram.Client",
user_ids: Union[int, str, List[Union[int, str]]]
) -> Union["types.User", List["types.User"]]:
"""Get information about a user.
You can retrieve up to 200 users at once.
Parameters:
user_ids (``int`` | ``str`` | List 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.
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_list = isinstance(user_ids, list)
if not is_list:
user_ids = [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_list else users[0]