# Hydrogram - Telegram MTProto API Client Library for Python

# Copyright (C) 2017-2023 Dan <https://github.com/delivrance>

# Copyright (C) 2023-present Hydrogram <https://hydrogram.org>

#

# This file is part of Hydrogram.

#

# Hydrogram 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.

#

# Hydrogram 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 Hydrogram. If not, see <http://www.gnu.org/licenses/>.

from __future__ import annotations

from typing import TYPE_CHECKING

import hydrogram

from hydrogram import raw, types, utils

if TYPE_CHECKING:

from datetime import datetime

class BanChatMember:

async def ban_chat_member(

self: hydrogram.Client,

chat_id: int | str,

user_id: int | str,

until_date: datetime = utils.zero_datetime(),

) -> types.Message | bool:

"""Ban a user from a group, a supergroup or a channel.

In the case of supergroups and channels, the user will not be able to return to the group on their own using

invite links, etc., unless unbanned first. You must be an administrator in the chat for this to work and must

have the appropriate admin rights.

Note:

In regular groups (non-supergroups), this method will only work if the "All Members Are Admins" setting is

off in the target group. Otherwise members may only be removed by the group's creator or by the member

that added them.

.. include:: /_includes/usable-by/users-bots.rst

Parameters:

chat_id (``int`` | ``str``):

Unique identifier (int) or username (str) of the target chat.

user_id (``int`` | ``str``):

Unique identifier (int) or username (str) of the target user.

For a contact that exists in your Telegram address book you can use his phone number (str).

until_date (:py:obj:`~datetime.datetime`, *optional*):

Date when the user will be unbanned.

If user is banned for more than 366 days or less than 30 seconds from the current time they are

considered to be banned forever. Defaults to epoch (ban forever).

Returns:

:obj:`~hydrogram.types.Message` | ``bool``: On success, a service message will be returned (when applicable),

otherwise, in case a message object couldn't be returned, True is returned.

Example:

.. code-block:: python

from datetime import datetime, timedelta

# Ban chat member forever

await app.ban_chat_member(chat_id, user_id)

# Ban chat member and automatically unban after 24h

await app.ban_chat_member(chat_id, user_id, datetime.now() + timedelta(days=1))

"""

chat_peer = await self.resolve_peer(chat_id)

user_peer = await self.resolve_peer(user_id)

if isinstance(chat_peer, raw.types.InputPeerChannel):

r = await self.invoke(

raw.functions.channels.EditBanned(

channel=chat_peer,

participant=user_peer,

banned_rights=raw.types.ChatBannedRights(

until_date=utils.datetime_to_timestamp(until_date),

view_messages=True,

send_messages=True,

send_media=True,

send_stickers=True,

send_gifs=True,

send_games=True,

send_inline=True,

embed_links=True,

),

)

)

else:

r = await self.invoke(

raw.functions.messages.DeleteChatUser(chat_id=abs(chat_id), user_id=user_peer)

)

for i in r.updates:

if isinstance(i, (raw.types.UpdateNewMessage, raw.types.UpdateNewChannelMessage)):

return await types.Message._parse(

client=self,

message=i.message,

users={i.id: i for i in r.users},

chats={i.id: i for i in r.chats},

)

return True