MTPyroger/pyrogram/client/methods/chats/get_chat_member.py

90 lines
3.1 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
# Copyright (C) 2017-2020 Dan <https://github.com/delivrance>
2018-07-19 21:26:20 +00:00
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
2018-07-19 21:26:20 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2018-07-19 21:26:20 +00:00
#
2020-03-21 14:43:32 +00:00
# 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.
2018-07-19 21:26:20 +00:00
#
2020-03-21 14:43:32 +00:00
# You should have received a copy of the GNU Lesser General Public License
# along with Pyrogram. If not, see <http://www.gnu.org/licenses/>.
2018-07-19 21:26:20 +00:00
from typing import Union
2018-12-18 08:50:39 +00:00
import pyrogram
from pyrogram.api import functions, types
from pyrogram.errors import UserNotParticipant
from ...ext import BaseClient
2018-07-19 21:26:20 +00:00
class GetChatMember(BaseClient):
2019-03-16 18:23:23 +00:00
def get_chat_member(
self,
chat_id: Union[int, str],
user_id: Union[int, str]
) -> "pyrogram.ChatMember":
"""Get information about one member of a chat.
2018-07-22 00:07:44 +00:00
Parameters:
2018-07-22 00:07:44 +00:00
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
user_id (``int`` | ``str``)::
2019-06-05 11:58:32 +00:00
Unique identifier (int) or username (str) of the target user.
For you yourself you can simply use "me" or "self".
2018-07-22 00:07:44 +00:00
For a contact that exists in your Telegram address book you can use his phone number (str).
Returns:
:obj:`ChatMember`: On success, a chat member is returned.
2018-07-22 00:07:44 +00:00
2019-07-25 09:22:14 +00:00
Example:
.. code-block:: python
dan = app.get_chat_member("pyrogramchat", "haskell")
print(dan)
2018-07-22 00:07:44 +00:00
"""
chat = self.resolve_peer(chat_id)
user = self.resolve_peer(user_id)
2018-07-19 21:26:20 +00:00
if isinstance(chat, types.InputPeerChat):
2019-06-08 11:49:01 +00:00
r = self.send(
2018-07-19 21:26:20 +00:00
functions.messages.GetFullChat(
chat_id=chat.chat_id
2018-07-19 21:26:20 +00:00
)
)
members = getattr(r.full_chat.participants, "participants", [])
2019-06-08 11:49:01 +00:00
users = {i.id: i for i in r.users}
for member in members:
member = pyrogram.ChatMember._parse(self, member, users)
if isinstance(user, types.InputPeerSelf):
if member.user.is_self:
return member
else:
if member.user.id == user.user_id:
return member
2018-07-19 21:26:20 +00:00
else:
raise UserNotParticipant
elif isinstance(chat, types.InputPeerChannel):
2018-07-19 21:26:20 +00:00
r = self.send(
functions.channels.GetParticipant(
channel=chat,
user_id=user
2018-07-19 21:26:20 +00:00
)
)
users = {i.id: i for i in r.users}
return pyrogram.ChatMember._parse(self, r.participant, users)
2018-07-19 21:26:20 +00:00
else:
raise ValueError("The chat_id \"{}\" belongs to a user".format(chat_id))