pyrofork/pyrogram/methods/chats/get_chat_members_count.py
wulan17 d906970d99
pyrofork: Add join_requests_count field to class Chat
Signed-off-by: wulan17 <wulan17@nusantararom.org>
2024-08-02 19:48:37 +07:00

78 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/>.
from typing import Union
import pyrogram
from pyrogram import raw
class GetChatMembersCount:
async def get_chat_members_count(
self: "pyrogram.Client",
chat_id: Union[int, str],
join_request: bool = False
) -> int:
"""Get the number of members in a chat.
.. include:: /_includes/usable-by/users-bots.rst
Parameters:
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
You can also use chat public link in form of *t.me/<username>* (str).
join_request (``bool``, *optional*):
If True, will return the count of pending request of users who sent a join request to the chat.
Returns:
``int``: On success, the chat members count is returned.
Raises:
ValueError: In case a chat id belongs to user.
Example:
.. code-block:: python
count = await app.get_chat_members_count(chat_id)
print(count)
"""
peer = await self.resolve_peer(chat_id)
if isinstance(peer, raw.types.InputPeerChat):
r = await self.invoke(
raw.functions.messages.GetChats(
id=[peer.chat_id]
)
)
if not join_request:
return r.chats[0].participants_count
return r.chats[0].requests_pending
elif isinstance(peer, raw.types.InputPeerChannel):
r = await self.invoke(
raw.functions.channels.GetFullChannel(
channel=peer
)
)
if not join_request:
return r.full_chat.participants_count
return r.full_chat.requests_pending
else:
raise ValueError(f'The chat_id "{chat_id}" belongs to a user')