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

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

@@ -1,10 +1,9 @@
 Metadata-Version: 2.3
 Name: botapi-py
-Version: 1.5.3
+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
-Requires-Dist: orjson>=3.11.3 ; extra == 'redis'
 Requires-Dist: redis>=6.4.0 ; extra == 'redis'
 Requires-Python: >=3.12
 Project-URL: Telegram BotAPI Docs, https://core.telegram.org/bots/api

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

@@ -1,6 +1,6 @@
 [project]
 name = "botapi-py"
-version = "1.5.3"
+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 = [
@@ -17,7 +17,6 @@ dependencies = [
 
 [project.optional-dependencies]
 redis = [
-    "orjson>=3.11.3",
     "redis>=6.4.0",
 ]
 
@@ -28,6 +27,7 @@ build-backend = "uv_build"
 [dependency-groups]
 dev = [
     "bs4>=0.0.2",
+    "redis>=6.4.0",
 ]
 
 [tool.uv.build-backend]

botapi_py-1.5.3/src/botapi/dispatchers/__init__.py → botapi_py-1.5.5/src/botapi/dispatchers/__init__.pyi

@@ -1,11 +1,7 @@
 from .common import UpdateHandler
 
 from .get_updates_handler import GetUpdatesAsyncDispatcher
-try:
-	# Fails at runtime if redis-py is not installed
-	from .redis_pubsub_handler import RedisPubSubAsyncDispatcher
-except ImportError:
-	pass
+from .redis_pubsub_handler import RedisPubSubAsyncDispatcher
 
 __all__ = [
 	'UpdateHandler',

{botapi_py-1.5.3 → botapi_py-1.5.5}/src/botapi/dispatchers/redis_pubsub_handler.py

@@ -5,23 +5,27 @@ import inspect
 import json
 import logging
 import signal
-from typing import override
+from typing import TYPE_CHECKING, override
 
-import orjson
 import pydantic
 
-from botapi.types import Update
-
-from .common import BaseAsyncDispatcher, UpdateHandler
-
 try:
 	import redis.asyncio as redis
 	from redis.asyncio.client import PubSub
 	_has_redis = True
 except ImportError as e:
 	_has_redis = False
-	raise e
-	
+	# Fix type checker errors,
+	# but do not stop the library (with confusing errors) from being used without redis-py installed.
+	# Just raise a MEANINGFUL error when the dev tries to create an instance of `RedisPubSubAsyncDispatcher`.
+	if TYPE_CHECKING:
+		raise e
+		
+from botapi.types import Update
+
+from .common import BaseAsyncDispatcher, UpdateHandler
+
+
 logger = logging.getLogger(__name__)
 
 
@@ -29,7 +33,7 @@ class RedisPubSubAsyncDispatcher(BaseAsyncDispatcher):
 	update_handler: UpdateHandler
 	update_handler_argcount: int
 	tasks_shutdown_timeout: float
-	tasks: set[asyncio.Task] # prevent gc from collecting tasks before they finish
+	tasks: set[asyncio.Task[None]] # prevent gc from collecting tasks before they finish
 	redis_client: redis.Redis
 	redis_reconnect_delay: float
 	pubsub: PubSub
@@ -85,7 +89,7 @@ class RedisPubSubAsyncDispatcher(BaseAsyncDispatcher):
 		self.pubsub = self.redis_client.pubsub(ignore_subscribe_messages=True)
 		self.update_handler_argcount = len(inspect.getfullargspec(update_handler).args)
 		
-	def _task_done_callback(self, task: asyncio.Task) -> None:
+	def _task_done_callback(self, task: asyncio.Task[None]) -> None:
 		'''
 		Callback that is called by the event loop when an update_handler task is done.
 		
@@ -106,7 +110,7 @@ class RedisPubSubAsyncDispatcher(BaseAsyncDispatcher):
 		- extracts the bot token from the specified `self.bot_token_json_key` key
 		- validates the update into an `Update` object.
 		'''
-		data: dict = orjson.loads(message)
+		data: dict = json.loads(message)
 		
 		if self.bot_token_json_key not in data:
 			err = f'Missing bot token key "{self.bot_token_json_key}" in the update JSON payload'

{botapi_py-1.5.3 → botapi_py-1.5.5}/src/botapi/enums.py

@@ -71,6 +71,8 @@ class ServiceMessage(enum.StrEnum):
 	'''
 	NEW_CHAT_MEMBERS = 'new_chat_members'
 	LEFT_CHAT_MEMBER = 'left_chat_member'
+	CHAT_OWNER_LEFT = 'chat_owner_left'
+	CHAT_OWNER_CHANGED = 'chat_owner_changed'
 	NEW_CHAT_TITLE = 'new_chat_title'
 	NEW_CHAT_PHOTO = 'new_chat_photo'
 	DELETE_CHAT_PHOTO = 'delete_chat_photo'
@@ -119,6 +121,7 @@ class ServiceMessage(enum.StrEnum):
 	WEB_APP_DATA = 'web_app_data'
 	SUGGESTED_POST = 'suggested_post_info'
 	
+	
 class OtherMessageType(enum.StrEnum):
 	'''
 	Subset of `MessageType`.

{botapi_py-1.5.3 → botapi_py-1.5.5}/src/botapi/methods.py

@@ -38,6 +38,7 @@ from .types import (
 	Audio,
 	Document,
 	Story,
+	VideoQuality,
 	Video,
 	VideoNote,
 	Voice,
@@ -111,6 +112,7 @@ from .types import (
 	SuggestedPostParameters,
 	DirectMessagesTopic,
 	UserProfilePhotos,
+	UserProfileAudios,
 	File,
 	WebAppInfo,
 	ReplyKeyboardMarkup,
@@ -217,6 +219,8 @@ from .types import (
 	ChatBoost,
 	ChatBoostUpdated,
 	ChatBoostRemoved,
+	ChatOwnerLeft,
+	ChatOwnerChanged,
 	UserChatBoosts,
 	BusinessBotRights,
 	BusinessConnection,
@@ -1541,6 +1545,27 @@ class Methods(core.BaseBot):
 		})
 		return UserProfilePhotos.model_validate(response)
 
+	async def get_user_profile_audios(
+		self,
+		user_id: int,
+		offset: Optional[int] = None,
+		limit: Optional[int] = None,
+	) -> UserProfileAudios:
+		'''
+        Use this method to get a list of
+        profile audios for a user. Returns a UserProfileAudios
+        object.
+
+        Reference: https://core.telegram.org/bots/api#getuserprofileaudios
+		'''
+
+		response = await self._send_request('getUserProfileAudios', {
+			'user_id': user_id,
+			'offset': offset,
+			'limit': limit,
+		})
+		return UserProfileAudios.model_validate(response)
+
 	async def set_user_emoji_status(
 		self,
 		user_id: int,
@@ -2326,11 +2351,12 @@ class Methods(core.BaseBot):
 	) -> ForumTopic:
 		'''
         Use this method to create a topic in
-        a forum supergroup chat. The bot must be
-        an administrator in the chat for this to
-        work and must have the can_manage_topics administrator rights.
-        Returns information about the created topic as a
-        ForumTopic object.
+        a forum supergroup chat or a private chat
+        with a user. In the case of a
+        supergroup chat the bot must be an administrator
+        in the chat for this to work and
+        must have the can_manage_topics administrator right. Returns information
+        about the created topic as a ForumTopic object.
 
         Reference: https://core.telegram.org/bots/api#createforumtopic
 		'''
@@ -2818,6 +2844,35 @@ class Methods(core.BaseBot):
 		})
 		return BotShortDescription.model_validate(response)
 
+	async def set_my_profile_photo(
+		self,
+		photo: _InputProfilePhoto,
+	) -> bool:
+		'''
+        Changes the profile photo of the bot. Returns
+        True on success.
+
+        Reference: https://core.telegram.org/bots/api#setmyprofilephoto
+		'''
+
+		response = await self._send_request('setMyProfilePhoto', {
+			'photo': photo,
+		})
+		return BoolAdapter.validate_python(response)
+
+	async def remove_my_profile_photo(
+		self,
+	) -> bool:
+		'''
+        Removes the profile photo of the bot. Requires
+        no parameters. Returns True on success.
+
+        Reference: https://core.telegram.org/bots/api#removemyprofilephoto
+		'''
+
+		response = await self._send_request('removeMyProfilePhoto', {})
+		return BoolAdapter.validate_python(response)
+
 	async def set_chat_menu_button(
 		self,
 		chat_id: Optional[int] = None,

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

@@ -81,6 +81,8 @@ class Message(MaybeInaccessibleMessage):
 	location: Optional[Location] = Field(default=None)
 	new_chat_members: Optional[List[User]] = Field(default=None)
 	left_chat_member: Optional[User] = Field(default=None)
+	chat_owner_left: Optional[ChatOwnerLeft] = Field(default=None)
+	chat_owner_changed: Optional[ChatOwnerChanged] = Field(default=None)
 	new_chat_title: Optional[str] = Field(default=None)
 	new_chat_photo: Optional[List[PhotoSize]] = Field(default=None)
 	delete_chat_photo: Optional[bool] = Field(default=None)
@@ -632,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):
 	'''
@@ -2275,7 +2371,8 @@ class User(BaseModel):
 	supports_inline_queries: Optional[bool] = Field(default=None)
 	can_connect_to_business: Optional[bool] = Field(default=None)
 	has_main_web_app: Optional[bool] = Field(default=None)
-	has_topics_enabled: Optional[bool] = Field(default=None) 
+	has_topics_enabled: Optional[bool] = Field(default=None)
+	allows_users_to_create_topics: Optional[bool] = Field(default=None) 
 
 class Chat(BaseModel):
 	'''
@@ -2348,6 +2445,7 @@ class ChatFullInfo(BaseModel):
 	linked_chat_id: Optional[int] = Field(default=None)
 	location: Optional[ChatLocation] = Field(default=None)
 	rating: Optional[UserRating] = Field(default=None)
+	first_profile_audio: Optional[Audio] = Field(default=None)
 	unique_gift_colors: Optional[UniqueGiftColors] = Field(default=None)
 	paid_message_star_count: Optional[int] = Field(default=None) 
 
@@ -2536,6 +2634,21 @@ class Story(BaseModel):
 	chat: Chat
 	id: int 
 
+class VideoQuality(BaseModel):
+	'''
+    This object represents a video file of a
+    specific quality.
+
+    Reference: https://core.telegram.org/bots/api#videoquality
+	'''
+
+	file_id: str
+	file_unique_id: str
+	width: int
+	height: int
+	codec: str
+	file_size: Optional[int] = Field(default=None) 
+
 class Video(BaseModel):
 	'''
     This object represents a video file.
@@ -2551,6 +2664,7 @@ class Video(BaseModel):
 	thumbnail: Optional[PhotoSize] = Field(default=None)
 	cover: Optional[List[PhotoSize]] = Field(default=None)
 	start_timestamp: Optional[int] = Field(default=None)
+	qualities: Optional[List[VideoQuality]] = Field(default=None)
 	file_name: Optional[str] = Field(default=None)
 	mime_type: Optional[str] = Field(default=None)
 	file_size: Optional[int] = Field(default=None) 
@@ -3214,6 +3328,17 @@ class UserProfilePhotos(BaseModel):
 	total_count: int
 	photos: List[List[PhotoSize]] 
 
+class UserProfileAudios(BaseModel):
+	'''
+    This object represents the audios displayed on a
+    user's profile.
+
+    Reference: https://core.telegram.org/bots/api#userprofileaudios
+	'''
+
+	total_count: int
+	audios: List[Audio] 
+
 class File(BaseModel):
 	'''
     This object represents a file ready to be
@@ -3304,16 +3429,18 @@ class ReplyKeyboardMarkup(BaseModel):
 class KeyboardButton(BaseModel):
 	'''
     This object represents one button of the reply
-    keyboard. At most one of the optional fields
-    must be used to specify type of the
-    button. For simple text buttons, String can be
-    used instead of this object to specify the
-    button text.
+    keyboard. At most one of the fields other
+    than text, icon_custom_emoji_id, and style must be used
+    to specify the type of the button. For
+    simple text buttons, String can be used instead
+    of this object to specify the button text.
 
     Reference: https://core.telegram.org/bots/api#keyboardbutton
 	'''
 
 	text: str
+	icon_custom_emoji_id: Optional[str] = Field(default=None)
+	style: Optional[str] = Field(default=None)
 	request_users: Optional[KeyboardButtonRequestUsers] = Field(default=None)
 	request_chat: Optional[KeyboardButtonRequestChat] = Field(default=None)
 	request_contact: Optional[bool] = Field(default=None)
@@ -3420,13 +3547,16 @@ class InlineKeyboardMarkup(BaseModel):
 class InlineKeyboardButton(BaseModel):
 	'''
     This object represents one button of an inline
-    keyboard. Exactly one of the optional fields must
-    be used to specify type of the button.
+    keyboard. Exactly one of the fields other than
+    text, icon_custom_emoji_id, and style must be used to
+    specify the type of the button.
 
     Reference: https://core.telegram.org/bots/api#inlinekeyboardbutton
 	'''
 
 	text: str
+	icon_custom_emoji_id: Optional[str] = Field(default=None)
+	style: Optional[str] = Field(default=None)
 	url: Optional[str] = Field(default=None)
 	callback_data: Optional[str] = Field(default=None)
 	web_app: Optional[WebAppInfo] = Field(default=None)
@@ -3878,7 +4008,8 @@ class UniqueGiftModel(BaseModel):
 
 	name: str
 	sticker: Sticker
-	rarity_per_mille: int 
+	rarity_per_mille: int
+	rarity: Optional[str] = Field(default=None) 
 
 class UniqueGiftSymbol(BaseModel):
 	'''
@@ -3949,6 +4080,7 @@ class UniqueGift(BaseModel):
 	symbol: UniqueGiftSymbol
 	backdrop: UniqueGiftBackdrop
 	is_premium: Optional[bool] = Field(default=None)
+	is_burned: Optional[bool] = Field(default=None)
 	is_from_blockchain: Optional[bool] = Field(default=None)
 	colors: Optional[UniqueGiftColors] = Field(default=None)
 	publisher_chat: Optional[Chat] = Field(default=None) 
@@ -4098,6 +4230,26 @@ class ChatBoostRemoved(BaseModel):
 	remove_date: int
 	source: _ChatBoostSource 
 
+class ChatOwnerLeft(BaseModel):
+	'''
+    Describes a service message about the chat owner
+    leaving the chat.
+
+    Reference: https://core.telegram.org/bots/api#chatownerleft
+	'''
+
+	new_owner: Optional[User] = Field(default=None) 
+
+class ChatOwnerChanged(BaseModel):
+	'''
+    Describes a service message about an ownership change
+    in the chat.
+
+    Reference: https://core.telegram.org/bots/api#chatownerchanged
+	'''
+
+	new_owner: User 
+
 class UserChatBoosts(BaseModel):
 	'''
     This object represents a list of boosts added