Skip to content

Prepare for Bot Api 9.4 #2552

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ranjitsingha wants to merge 7 commits into from
Closed

Prepare for Bot Api 9.4 #2552

Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
ae6e7ad
Add style and icon_custom_emoji_id to InlineKeyboardButton and Keyboa…
ranjitsingha Feb 10, 2026
23e8ab8
Fix spaces
Badiboy Feb 10, 2026
13f771b
Fix spaces
Badiboy Feb 10, 2026
a75af38
Fix spaces
Badiboy Feb 10, 2026
337978a
Fix formatting of constructor parameters in types.py
ranjitsingha Feb 10, 2026
196bcb4
Add type hints for icon_custom_emoji_id and style
ranjitsingha Feb 10, 2026
015da7c
Update icon_custom_emoji_id parameter description
ranjitsingha Feb 10, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 29 additions & 3 deletions telebot/types.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2928,21 +2928,31 @@ class KeyboardButton(Dictionaryable, JsonSerializable):
:param request_chat: Optional. If specified, pressing the button will open a list of suitable chats. Tapping on a chat will
send its identifier to the bot in a “chat_shared” service message. Available in private chats only.
:type request_chat: :class:`telebot.types.KeyboardButtonRequestChat`

:param icon_custom_emoji_id: Optional. Custom emoji identifier to be shown on the button.
Can only be used if the bot has a Telegram Premium subscription.
:type icon_custom_emoji_id: :obj:`str`

:param style: Optional. Style of the button. Can be used to change the color of the button.
:type style: :obj:`str`

:return: Instance of the class
:rtype: :class:`telebot.types.KeyboardButton`
"""
def __init__(self, text: str, request_contact: Optional[bool]=None,
request_location: Optional[bool]=None, request_poll: Optional[KeyboardButtonPollType]=None,
web_app: Optional[WebAppInfo]=None, request_user: Optional[KeyboardButtonRequestUser]=None,
request_chat: Optional[KeyboardButtonRequestChat]=None, request_users: Optional[KeyboardButtonRequestUsers]=None):
request_chat: Optional[KeyboardButtonRequestChat]=None, request_users: Optional[KeyboardButtonRequestUsers]=None,
icon_custom_emoji_id: Optional[str]=None, style: Optional[str]=None):
self.text: str = text
self.request_contact: Optional[bool] = request_contact
self.request_location: Optional[bool] = request_location
self.request_poll: Optional[KeyboardButtonPollType] = request_poll
self.web_app: Optional[WebAppInfo] = web_app
self.request_chat: Optional[KeyboardButtonRequestChat] = request_chat
self.request_users: Optional[KeyboardButtonRequestUsers] = request_users
self.icon_custom_emoji_id: Optional[str] = icon_custom_emoji_id
self.style: Optional[str] = style
if request_user is not None:
log_deprecation_warning('The parameter "request_user" is deprecated, use "request_users" instead')
if self.request_users is None:
Expand All @@ -2967,6 +2977,10 @@ def to_dict(self):
json_dict['request_users'] = self.request_users.to_dict()
if self.request_chat is not None:
json_dict['request_chat'] = self.request_chat.to_dict()
if self.icon_custom_emoji_id is not None:
json_dict['icon_custom_emoji_id'] = self.icon_custom_emoji_id
if self.style is not None:
json_dict['style'] = self.style
return json_dict


Expand Down Expand Up @@ -3133,6 +3147,12 @@ class InlineKeyboardButton(Dictionaryable, JsonSerializable, JsonDeserializable)

:param copy_text: Optional. Description of the button that copies the specified text to the clipboard.
:type copy_text: :class:`telebot.types.CopyTextButton`

:param icon_custom_emoji_id: Optional. Custom emoji identifier to be shown on the button. Can only be used if the bot owner has a Telegram Premium subscription.
:type icon_custom_emoji_id: :obj:`str`

Comment on lines +3150 to +3153
Copy link

Copilot AI Feb 10, 2026

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The class-level note for InlineKeyboardButton says “You must use exactly one of the optional fields”, but icon_custom_emoji_id and style are additional optional fields meant to be used alongside an action field (e.g., callback_data/url). As documented now, it reads like style/icon_custom_emoji_id are mutually exclusive with the rest, which would be misleading. Please clarify the docstring to scope the exclusivity requirement to the button action fields only.

Suggested change
:param icon_custom_emoji_id: Optional. Custom emoji identifier to be shown on the button.
Can only be used if the bot has a Telegram Premium subscription.
:type icon_custom_emoji_id: :obj:`str`
Note: Exactly one of the *action* parameters (such as ``url``, ``callback_data``, ``web_app``, ``login_url``,
``switch_inline_query``, ``switch_inline_query_current_chat``, ``switch_inline_query_chosen_chat``,
``callback_game``, ``pay`` or ``copy_text`` should be used for a single button. The following parameters are
additional and may be used alongside one of these action parameters.
:param icon_custom_emoji_id: Optional. Custom emoji identifier to be shown on the button.
Can only be used if the bot has a Telegram Premium subscription.
:type icon_custom_emoji_id: :obj:`str`

Copilot uses AI. Check for mistakes.
Copy link
Copy Markdown
Author

@ranjitsingha ranjitsingha Feb 10, 2026 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can only be used if the bot has a Telegram Premium subscription. -> Can only be used if the bot owner has a Telegram Premium subscription.

:param style: Optional. Style of the button. Can be used to change the color of the button.
:type style: :obj:`str`

:return: Instance of the class
:rtype: :class:`telebot.types.InlineKeyboardButton`
Expand All @@ -3155,7 +3175,7 @@ def de_json(cls, json_string):
def __init__(self, text: str, url: Optional[str]=None, callback_data: Optional[str]=None, web_app: Optional[WebAppInfo]=None,
switch_inline_query: Optional[str]=None, switch_inline_query_current_chat: Optional[str]=None,
switch_inline_query_chosen_chat: Optional[SwitchInlineQueryChosenChat]=None, callback_game=None, pay: Optional[bool]=None,
login_url: Optional[LoginUrl]=None, copy_text: Optional[CopyTextButton]=None, **kwargs):
login_url: Optional[LoginUrl]=None, copy_text: Optional[CopyTextButton]=None, icon_custom_emoji_id: Optional[str]=None, style: Optional[str]=None, **kwargs):
self.text: str = text
self.url: Optional[str] = url
self.callback_data: Optional[str] = callback_data
Expand All @@ -3167,6 +3187,8 @@ def __init__(self, text: str, url: Optional[str]=None, callback_data: Optional[s
self.pay: Optional[bool] = pay
self.login_url: Optional[LoginUrl] = login_url
self.copy_text: Optional[CopyTextButton] = copy_text
self.icon_custom_emoji_id: Optional[str] = icon_custom_emoji_id
self.style: Optional[str] = style

def to_json(self):
return json.dumps(self.to_dict())
Expand All @@ -3193,6 +3215,10 @@ def to_dict(self):
json_dict['switch_inline_query_chosen_chat'] = self.switch_inline_query_chosen_chat.to_dict()
if self.copy_text is not None:
json_dict['copy_text'] = self.copy_text.to_dict()
if self.icon_custom_emoji_id is not None:
json_dict['icon_custom_emoji_id'] = self.icon_custom_emoji_id
if self.style is not None:
json_dict['style'] = self.style
return json_dict


Expand Down Expand Up @@ -13468,4 +13494,4 @@ def de_json(cls, json_string):
obj = cls.check_json(json_string)
return cls(**obj)