botapi-py 1.5.4__tar.gz → 1.5.5__tar.gz

{botapi_py-1.5.4 → botapi_py-1.5.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.3
 Name: botapi-py
-Version: 1.5.4
+Version: 1.5.5
 Summary: A simple and flexible Python library to conveniently build fast Telegram bots using the Bot API.
 Requires-Dist: httpx>=0.28.1
 Requires-Dist: pydantic>=2.12.0

{botapi_py-1.5.4 → botapi_py-1.5.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "botapi-py"
-version = "1.5.4"
+version = "1.5.5"
 description = "A simple and flexible Python library to conveniently build fast Telegram bots using the Bot API."
 # readme = "README.md"
 # authors = [

{botapi_py-1.5.4 → botapi_py-1.5.5}/src/botapi/types.py

@@ -634,6 +634,100 @@ BackgroundTypeAdapter = TypeAdapter[_BackgroundType](_BackgroundType)
 class ChatMember(BaseModel):	
 	status: Literal['creator', 'administrator', 'member', 'restricted', 'left', 'kicked']	
 	user: User
+	
+	# @property
+	async def is_participant(self) -> bool:
+		'''
+		Returns a boolean indicating if the user is currently part of of the chat (i.e. not left/banned).
+	
+		This function handles special cases, like `ChatMemberRestricted` with the `is_member` flag.
+		'''
+		if isinstance(self, ChatMemberRestricted):
+			return self.is_member # this `ChatMemberRestricted` flag indicates whether it's a member or it has left
+	
+		if isinstance(self, (
+			ChatMemberLeft,
+			ChatMemberBanned
+		)):
+			return False
+	
+		return True
+	
+	async def ban(
+		self,
+		bot: bot.Bot,
+		chat_id: Union[int, str],
+		until_date: Optional[int] = None
+	) -> bool:
+		'''
+		Bans this chat member.
+		'''
+		return await bot.ban_chat_member(
+			chat_id=chat_id,
+			user_id=self.user.id,
+			until_date=until_date,
+			# revoke_messages=revoke_messages
+		)
+	
+	async def unban(
+		self,
+		bot: bot.Bot,
+		chat_id: Union[int, str],
+		only_if_banned: Optional[bool] = None
+	) -> bool:
+		'''
+		Unbans this chat member.
+		'''
+		return await bot.unban_chat_member(
+			chat_id=chat_id,
+			user_id=self.user.id,
+			only_if_banned=only_if_banned
+		)
+	
+	async def kick(
+		self,
+		bot: bot.Bot,
+		chat_id: Union[int, str]
+	) -> bool:
+		'''
+		Kicks this chat member (bans and immediately unbans).
+		'''
+		return await bot.unban_chat_member(
+			chat_id=chat_id,
+			user_id=self.user.id,
+			only_if_banned=False # ... "guarantees that after the call the user is not a member of the chat, but will be able to join it"
+		)
+	
+	async def mute(
+		self,
+		bot: bot.Bot,
+		chat_id: Union[int, str],
+		until_date: Optional[int] = None
+	) -> bool:
+		'''
+		Mutes (restricts) this chat member.
+		'''
+		return await bot.restrict_chat_member(
+			chat_id=chat_id,
+			user_id=self.user.id,
+			permissions=ChatPermissions(
+				can_send_messages=False,
+				can_send_audios=False,
+				can_send_documents=False,
+				can_send_photos=False,
+				can_send_videos=False,
+				can_send_video_notes=False,
+				can_send_voice_notes=False,
+				can_send_polls=False,
+				can_send_other_messages=False,
+				can_add_web_page_previews=False,
+				can_change_info=False,
+				can_invite_users=False,
+				can_pin_messages=False
+			),
+			until_date=until_date
+	)
+	
 
 class ChatMemberOwner(ChatMember):
 	'''