botapi-py 1.1.1__tar.gz → 1.2.1__tar.gz

{botapi_py-1.1.1 → botapi_py-1.2.1}/PKG-INFO

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

{botapi_py-1.1.1 → botapi_py-1.2.1}/pyproject.toml

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

{botapi_py-1.1.1 → botapi_py-1.2.1}/src/botapi/api.py

@@ -1,4 +1,6 @@
-# This is an autogenerated file. Do not edit this file directly.
+# WARNING!
+# This is an autogenerated file.
+# Do NOT edit this file directly, your changes will be overwritten.
 
 from __future__ import annotations
 
@@ -15,10 +17,14 @@ from .types import (
 	Message,
 	MessageId,
 	InaccessibleMessage,
+	MaybeInaccessibleMessage,
+	MaybeInaccessibleMessageAdapter,
 	MessageEntity,
 	TextQuote,
 	ExternalReplyInfo,
 	ReplyParameters,
+	MessageOrigin,
+	MessageOriginAdapter,
 	MessageOriginUser,
 	MessageOriginHiddenUser,
 	MessageOriginChat,
@@ -32,6 +38,8 @@ from .types import (
 	VideoNote,
 	Voice,
 	PaidMediaInfo,
+	PaidMedia,
+	PaidMediaAdapter,
 	PaidMediaPreview,
 	PaidMediaPhoto,
 	PaidMediaVideo,
@@ -53,9 +61,13 @@ from .types import (
 	ProximityAlertTriggered,
 	MessageAutoDeleteTimerChanged,
 	ChatBoostAdded,
+	BackgroundFill,
+	BackgroundFillAdapter,
 	BackgroundFillSolid,
 	BackgroundFillGradient,
 	BackgroundFillFreeformGradient,
+	BackgroundType,
+	BackgroundTypeAdapter,
 	BackgroundTypeFill,
 	BackgroundTypeWallpaper,
 	BackgroundTypePattern,
@@ -111,6 +123,8 @@ from .types import (
 	ChatInviteLink,
 	ChatAdministratorRights,
 	ChatMemberUpdated,
+	ChatMember,
+	ChatMemberAdapter,
 	ChatMemberOwner,
 	ChatMemberAdministrator,
 	ChatMemberMember,
@@ -126,6 +140,8 @@ from .types import (
 	BusinessOpeningHours,
 	StoryAreaPosition,
 	LocationAddress,
+	StoryAreaType,
+	StoryAreaTypeAdapter,
 	StoryAreaTypeLocation,
 	StoryAreaTypeSuggestedReaction,
 	StoryAreaTypeLink,
@@ -133,6 +149,8 @@ from .types import (
 	StoryAreaTypeUniqueGift,
 	StoryArea,
 	ChatLocation,
+	ReactionType,
+	ReactionTypeAdapter,
 	ReactionTypeEmoji,
 	ReactionTypeCustomEmoji,
 	ReactionTypePaid,
@@ -149,12 +167,16 @@ from .types import (
 	UniqueGift,
 	GiftInfo,
 	UniqueGiftInfo,
+	OwnedGift,
+	OwnedGiftAdapter,
 	OwnedGiftRegular,
 	OwnedGiftUnique,
 	OwnedGifts,
 	AcceptedGiftTypes,
 	StarAmount,
 	BotCommand,
+	BotCommandScope,
+	BotCommandScopeAdapter,
 	BotCommandScopeDefault,
 	BotCommandScopeAllPrivateChats,
 	BotCommandScopeAllGroupChats,
@@ -165,9 +187,13 @@ from .types import (
 	BotName,
 	BotDescription,
 	BotShortDescription,
+	MenuButton,
+	MenuButtonAdapter,
 	MenuButtonCommands,
 	MenuButtonWebApp,
 	MenuButtonDefault,
+	ChatBoostSource,
+	ChatBoostSourceAdapter,
 	ChatBoostSourcePremium,
 	ChatBoostSourceGiftCode,
 	ChatBoostSourceGiveaway,
@@ -179,16 +205,24 @@ from .types import (
 	BusinessConnection,
 	BusinessMessagesDeleted,
 	ResponseParameters,
+	InputMedia,
+	InputMediaAdapter,
 	InputMediaPhoto,
 	InputMediaVideo,
 	InputMediaAnimation,
 	InputMediaAudio,
 	InputMediaDocument,
 	InputFile,
+	InputPaidMedia,
+	InputPaidMediaAdapter,
 	InputPaidMediaPhoto,
 	InputPaidMediaVideo,
+	InputProfilePhoto,
+	InputProfilePhotoAdapter,
 	InputProfilePhotoStatic,
 	InputProfilePhotoAnimated,
+	InputStoryContent,
+	InputStoryContentAdapter,
 	InputStoryContentPhoto,
 	InputStoryContentVideo,
 	Sticker,
@@ -197,6 +231,8 @@ from .types import (
 	InputSticker,
 	InlineQuery,
 	InlineQueryResultsButton,
+	InlineQueryResult,
+	InlineQueryResultAdapter,
 	InlineQueryResultArticle,
 	InlineQueryResultPhoto,
 	InlineQueryResultGif,
@@ -217,6 +253,8 @@ from .types import (
 	InlineQueryResultCachedVideo,
 	InlineQueryResultCachedVoice,
 	InlineQueryResultCachedAudio,
+	InputMessageContent,
+	InputMessageContentAdapter,
 	InputTextMessageContent,
 	InputLocationMessageContent,
 	InputVenueMessageContent,
@@ -235,10 +273,14 @@ from .types import (
 	ShippingQuery,
 	PreCheckoutQuery,
 	PaidMediaPurchased,
+	RevenueWithdrawalState,
+	RevenueWithdrawalStateAdapter,
 	RevenueWithdrawalStatePending,
 	RevenueWithdrawalStateSucceeded,
 	RevenueWithdrawalStateFailed,
 	AffiliateInfo,
+	TransactionPartner,
+	TransactionPartnerAdapter,
 	TransactionPartnerUser,
 	TransactionPartnerChat,
 	TransactionPartnerAffiliateProgram,
@@ -252,6 +294,8 @@ from .types import (
 	PassportFile,
 	EncryptedPassportElement,
 	EncryptedCredentials,
+	PassportElementError,
+	PassportElementErrorAdapter,
 	PassportElementErrorDataField,
 	PassportElementErrorFrontSide,
 	PassportElementErrorReverseSide,
@@ -264,48 +308,6 @@ from .types import (
 	Game,
 	CallbackGame,
 	GameHighScore,
-	MaybeInaccessibleMessage,
-	MaybeInaccessibleMessageAdapter,
-	MessageOrigin,
-	MessageOriginAdapter,
-	PaidMedia,
-	PaidMediaAdapter,
-	BackgroundFill,
-	BackgroundFillAdapter,
-	BackgroundType,
-	BackgroundTypeAdapter,
-	ChatMember,
-	ChatMemberAdapter,
-	StoryAreaType,
-	StoryAreaTypeAdapter,
-	ReactionType,
-	ReactionTypeAdapter,
-	OwnedGift,
-	OwnedGiftAdapter,
-	BotCommandScope,
-	BotCommandScopeAdapter,
-	MenuButton,
-	MenuButtonAdapter,
-	ChatBoostSource,
-	ChatBoostSourceAdapter,
-	InputMedia,
-	InputMediaAdapter,
-	InputPaidMedia,
-	InputPaidMediaAdapter,
-	InputProfilePhoto,
-	InputProfilePhotoAdapter,
-	InputStoryContent,
-	InputStoryContentAdapter,
-	InlineQueryResult,
-	InlineQueryResultAdapter,
-	InputMessageContent,
-	InputMessageContentAdapter,
-	RevenueWithdrawalState,
-	RevenueWithdrawalStateAdapter,
-	TransactionPartner,
-	TransactionPartnerAdapter,
-	PassportElementError,
-	PassportElementErrorAdapter,
 	IntAdapter,
 	StrAdapter,
 	FloatAdapter,

botapi_py-1.2.1/src/botapi/boilerplate.py

@@ -0,0 +1,20 @@
+import enum
+
+from typing import TypeVar, Callable
+
+# Enums
+E = TypeVar('E', bound=enum.Enum)
+
+def extend_enum(*sources: type[E]) -> Callable[..., type[E]]:
+	'''
+	Decorator that extends an Enum class with members
+	from one or more source Enum classes.
+	'''
+	def decorator(target: type[E]) -> type[E]:
+		for source in sources:
+			for member in source:
+				if member.name not in target.__members__:
+					target._member_map_[member.name] = member
+		return target
+	return decorator
+	

botapi_py-1.2.1/src/botapi/enums.py

@@ -0,0 +1,164 @@
+import enum
+
+from . import boilerplate
+
+class ChatType(enum.StrEnum):
+	PRIVATE = 'private'
+	GROUP = 'group'
+	SUPERGROUP = 'supergroup'
+	CHANNEL = 'channel'
+	
+class UpdateType(enum.StrEnum):
+	'''
+	Types of updates that a bot can receive.
+	
+	You can use these to filter updates, using the `allowed_updates`
+	parameter in `getUpdates` and `setWebhook` methods.
+	'''
+	MESSAGE = 'message'
+	EDITED_MESSAGE = 'edited_message'
+	CHANNEL_POST = 'channel_post'
+	EDITED_CHANNEL_POST = 'edited_channel_post'
+	INLINE_QUERY = 'inline_query'
+	CHOSEN_INLINE_RESULT = 'chosen_inline_result'
+	CALLBACK_QUERY = 'callback_query'
+	SHIPPING_QUERY = 'shipping_query'
+	PRE_CHECKOUT_QUERY = 'pre_checkout_query'
+	POLL = 'poll'
+	POLL_ANSWER = 'poll_answer'
+	CHAT_MEMBER_UPDATED = 'chat_member_updated'
+	CHAT_JOIN_REQUEST = 'chat_join_request'
+	
+class MediaType(enum.StrEnum):
+	'''
+	These are messages containing some kind of multimedia/visual content,
+	and NOT text-centric content.
+	'''
+	ANIMATION = 'animation'
+	AUDIO = 'audio'
+	DOCUMENT = 'document'
+	PHOTO = 'photo'
+	STICKER = 'sticker'
+	VIDEO = 'video'
+	VIDEO_NOTE = 'video_note'
+	VOICE = 'voice'
+	STORY = 'story'
+	PAID_MEDIA = 'paid_media'
+	
+class ServiceMessage(enum.StrEnum):
+	'''
+	These are special types of messages that convey service information.
+	
+	They are ALL represented as semi-transparent bubbles in Telegram apps UI,
+	containing text and/or graphical elements (e.g. gifts, giveaways).
+	'''
+	NEW_CHAT_MEMBERS = 'new_chat_members'
+	LEFT_CHAT_MEMBER = 'left_chat_member'
+	NEW_CHAT_TITLE = 'new_chat_title'
+	NEW_CHAT_PHOTO = 'new_chat_photo'
+	DELETE_CHAT_PHOTO = 'delete_chat_photo'
+	GROUP_CHAT_CREATED = 'group_chat_created'
+	SUPERGROUP_CHAT_CREATED = 'supergroup_chat_created'
+	CHANNEL_CHAT_CREATED = 'channel_chat_created'
+	MESSAGE_AUTO_DELETE_TIMER_CHANGED = 'message_auto_delete_timer_changed'
+	MIGRATE_TO_CHAT_ID = 'migrate_to_chat_id'
+	MIGRATE_FROM_CHAT_ID = 'migrate_from_chat_id'
+	PINNED_MESSAGE = 'pinned_message'
+	SUCCESSFUL_PAYMENT = 'successful_payment'
+	REFUNDED_PAYMENT = 'refunded_payment'
+	USERS_SHARED = 'users_shared'
+	CHAT_SHARED = 'chat_shared'
+	GIFT = 'gift'
+	UNIQUE_GIFT = 'unique_gift'
+	CONNECTED_WEBSITE = 'connected_website'
+	WRITE_ACCESS_ALLOWED = 'write_access_allowed'
+	PASSPORT_DATA = 'passport_data'
+	PROXIMITY_ALERT_TRIGGERED = 'proximity_alert_triggered'
+	BOOST_ADDED = 'boost_added'
+	CHAT_BACKGROUND_SET = 'chat_background_set'
+	CHECKLIST_TASKS_DONE = 'checklist_tasks_done'
+	CHECKLIST_TASKS_ADDED = 'checklist_tasks_added'
+	DIRECT_MESSAGE_PRICE_CHANGED = 'direct_message_price_changed'
+	FORUM_TOPIC_CREATED = 'forum_topic_created'
+	FORUM_TOPIC_EDITED = 'forum_topic_edited'
+	FORUM_TOPIC_CLOSED = 'forum_topic_closed'
+	FORUM_TOPIC_REOPENED = 'forum_topic_reopened'
+	GENERAL_FORUM_TOPIC_HIDDEN = 'general_forum_topic_hidden'
+	GENERAL_FORUM_TOPIC_UNHIDDEN = 'general_forum_topic_unhidden'
+	GIVEAWAY = 'giveaway'
+	GIVEAWAY_CREATED = 'giveaway_created'
+	GIVEAWAY_WINNERS = 'giveaway_winners'
+	GIVEAWAY_COMPLETED = 'giveaway_completed'
+	PAID_MESSAGE_PRICE_CHANGED = 'paid_message_price_changed'
+	SUGGESTED_POST_APPROVED = 'suggested_post_approved'
+	SUGGESTED_POST_APPROVAL_FAILED = 'suggested_post_approval_failed'
+	SUGGESTED_POST_DECLINED = 'suggested_post_declined'
+	SUGGESTED_POST_PAID = 'suggested_post_paid'
+	SUGGESTED_POST_REFUNDED = 'suggested_post_refunded'
+	VIDEO_CHAT_SCHEDULED = 'video_chat_scheduled'
+	VIDEO_CHAT_STARTED = 'video_chat_started'
+	VIDEO_CHAT_ENDED = 'video_chat_ended'
+	VIDEO_CHAT_PARTICIPANTS_INVITED = 'video_chat_participants_invited'
+	WEB_APP_DATA = 'web_app_data'
+	SUGGESTED_POST = 'suggested_post_info'
+	
+@boilerplate.extend_enum(MediaType, ServiceMessage)
+class MessageType(enum.StrEnum):
+	'''
+	The content of this message.
+	All of these fields should be mutually exclusive.
+	'''
+	TEXT = 'text'
+	CHECKLIST = 'checklist'
+	POLL = 'poll'
+	GAME = 'game'
+	INVOICE = 'invoice'
+	DICE = 'dice'
+	VENUE = 'venue'
+	LOCATION = 'location'
+	CONTACT = 'contact'
+	
+class ChatMemberStatus(enum.StrEnum):
+	'''
+	Statuses of a chat member.
+	
+	Note that left members that are also restricted (muted), are represented as
+	`RESTRICTED` with the `is_member` flag set to `False`.
+	
+	See: https://core.telegram.org/bots/api#chatmember
+	'''
+	CREATOR = 'creator'
+	ADMINISTRATOR = 'administrator'
+	MEMBER = 'member'
+	RESTRICTED = 'restricted'
+	LEFT = 'left'
+	BANNED = 'kicked'
+	
+class ParseMode(enum.StrEnum):
+	'''
+	Available parse modes for formatting text messages.
+	
+	See: https://core.telegram.org/bots/api#formatting-options
+	'''
+	MARKDOWN = 'Markdown'
+	MARKDOWN_V2 = 'MarkdownV2'
+	HTML = 'HTML'
+	
+class ChatAction(enum.StrEnum):
+	'''
+	Types of actions that a bot can send using the `sendChatAction` method.
+	
+	See: https://core.telegram.org/bots/api#sendchataction
+	'''
+	TYPING = 'typing'
+	UPLOAD_PHOTO = 'upload_photo'
+	RECORD_VIDEO = 'record_video'
+	UPLOAD_VIDEO = 'upload_video'
+	RECORD_VOICE = 'record_voice'
+	UPLOAD_VOICE = 'upload_voice'
+	UPLOAD_DOCUMENT = 'upload_document'
+	CHOOSE_STICKER = 'choose_sticker'
+	FIND_LOCATION = 'find_location'
+	RECORD_VIDEO_NOTE = 'record_video_note'
+	UPLOAD_VIDEO_NOTE = 'upload_video_note'
+