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

64 lines
2.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-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
2018-09-08 17:16:51 +00:00
from pyrogram.api import functions, types
from ...ext import BaseClient
class GetChatMembersCount(BaseClient):
2019-03-16 18:23:23 +00:00
def get_chat_members_count(
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
count = app.get_chat_members_count("pyrogramchat")
print(count)
2018-09-08 17:16:51 +00:00
"""
peer = self.resolve_peer(chat_id)
if isinstance(peer, types.InputPeerChat):
return self.send(
functions.messages.GetChats(
id=[peer.chat_id]
)
).chats[0].participants_count
elif isinstance(peer, types.InputPeerChannel):
return self.send(
functions.channels.GetFullChannel(
channel=peer
)
).full_chat.participants_count
else:
raise ValueError("The chat_id \"{}\" belongs to a user".format(chat_id))