MTPyroger/pyrogram/methods/chats/get_chat_members_count.py

68 lines
2.2 KiB
Python
Raw Normal View History

2020-03-21 14:43:32 +00:00
# Pyrogram - Telegram MTProto API Client Library for Python
2022-01-07 09:23:45 +00:00
# Copyright (C) 2017-present Dan <https://github.com/delivrance>
2018-09-08 17:16:51 +00:00
#
2020-03-21 14:43:32 +00:00
# This file is part of Pyrogram.
2018-09-08 17:16:51 +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-09-08 17:16:51 +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-09-08 17:16:51 +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-09-08 17:16:51 +00:00
from typing import Union
from pyrogram import raw
from pyrogram.scaffold import Scaffold
2018-09-08 17:16:51 +00:00
class GetChatMembersCount(Scaffold):
async def get_chat_members_count(
2019-03-16 18:23:23 +00:00
self,
chat_id: Union[int, str]
) -> int:
"""Get the number of members in a chat.
2018-09-08 17:16:51 +00:00
Parameters:
2018-09-08 17:16:51 +00:00
chat_id (``int`` | ``str``):
Unique identifier (int) or username (str) of the target chat.
Returns:
``int``: On success, the chat members count is returned.
2018-09-08 17:16:51 +00:00
Raises:
ValueError: In case a chat id belongs to user.
2019-07-25 09:22:14 +00:00
Example:
.. code-block:: python
2022-01-07 09:18:51 +00:00
count = app.get_chat_members_count(chat_id)
2019-07-25 09:22:14 +00:00
print(count)
2018-09-08 17:16:51 +00:00
"""
peer = await self.resolve_peer(chat_id)
2018-09-08 17:16:51 +00:00
if isinstance(peer, raw.types.InputPeerChat):
r = await self.send(
raw.functions.messages.GetChats(
2018-09-08 17:16:51 +00:00
id=[peer.chat_id]
)
)
return r.chats[0].participants_count
elif isinstance(peer, raw.types.InputPeerChannel):
r = await self.send(
raw.functions.channels.GetFullChannel(
2018-09-08 17:16:51 +00:00
channel=peer
)
)
return r.full_chat.participants_count
2018-09-08 17:16:51 +00:00
else:
raise ValueError(f'The chat_id "{chat_id}" belongs to a user')