python-telegram-bot/telegram/_inline/inlinekeyboardmarkup.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

166 lines
5.5 KiB
Python
Raw Permalink Normal View History

2016-04-12 06:23:52 +02:00
#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
2024-02-19 20:06:25 +01:00
# Copyright (C) 2015-2024
2016-04-12 06:23:52 +02:00
# Leandro Toledo de Souza <devs@python-telegram-bot.org>
#
# This program is free software: you can redistribute it and/or modify
# it under the terms of the GNU Lesser Public License as published by
# the Free Software Foundation, either version 3 of the License, or
# (at your option) any later version.
#
# This program 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 Public License for more details.
#
# You should have received a copy of the GNU Lesser Public License
# along with this program. If not, see [http://www.gnu.org/licenses/].
"""This module contains an object that represents a Telegram InlineKeyboardMarkup."""
from collections.abc import Sequence
from typing import TYPE_CHECKING, Optional
from telegram._inline.inlinekeyboardbutton import InlineKeyboardButton
from telegram._telegramobject import TelegramObject
2022-01-19 18:00:21 +01:00
from telegram._utils.markup import check_keyboard_type
from telegram._utils.types import JSONDict
2020-10-06 19:28:40 +02:00
if TYPE_CHECKING:
from telegram import Bot
2016-04-14 01:38:45 +02:00
2022-01-19 18:00:21 +01:00
class InlineKeyboardMarkup(TelegramObject):
"""
This object represents an inline keyboard that appears right next to the message it belongs to.
2016-04-21 14:21:12 +02:00
Objects of this class are comparable in terms of equality. Two objects of this class are
2022-01-19 18:00:21 +01:00
considered equal, if their size of :attr:`inline_keyboard` and all the buttons are equal.
.. figure:: https://core.telegram.org/file/464001863/110f3/I47qTXAD9Z4.120010/e0\
ea04f66357b640ec
:align: center
An inline keyboard on a message
.. seealso::
Another kind of keyboard would be the :class:`telegram.ReplyKeyboardMarkup`.
Examples:
* :any:`Inline Keyboard 1 <examples.inlinekeyboard>`
* :any:`Inline Keyboard 2 <examples.inlinekeyboard2>`
Args:
inline_keyboard (Sequence[Sequence[:class:`telegram.InlineKeyboardButton`]]): Sequence of
button rows, each represented by a sequence of :class:`~telegram.InlineKeyboardButton`
objects.
.. versionchanged:: 20.0
|sequenceclassargs|
2016-04-21 14:21:12 +02:00
Attributes:
inline_keyboard (tuple[tuple[:class:`telegram.InlineKeyboardButton`]]): Tuple of
button rows, each represented by a tuple of :class:`~telegram.InlineKeyboardButton`
objects.
.. versionchanged:: 20.0
|tupleclassattrs|
2017-09-01 08:43:08 +02:00
2016-04-21 14:21:12 +02:00
"""
2016-04-14 01:38:45 +02:00
__slots__ = ("inline_keyboard",)
def __init__(
self,
inline_keyboard: Sequence[Sequence[InlineKeyboardButton]],
*,
api_kwargs: Optional[JSONDict] = None,
):
super().__init__(api_kwargs=api_kwargs)
2022-01-19 18:00:21 +01:00
if not check_keyboard_type(inline_keyboard):
raise ValueError(
"The parameter `inline_keyboard` should be a sequence of sequences of "
"InlineKeyboardButtons"
)
2016-04-14 01:38:45 +02:00
# Required
self.inline_keyboard: tuple[tuple[InlineKeyboardButton, ...], ...] = tuple(
2023-02-02 18:55:07 +01:00
tuple(row) for row in inline_keyboard
)
2016-04-14 01:38:45 +02:00
self._id_attrs = (self.inline_keyboard,)
self._freeze()
2019-08-23 21:20:41 +02:00
@classmethod
def de_json(
cls, data: Optional[JSONDict], bot: Optional["Bot"] = None
) -> Optional["InlineKeyboardMarkup"]:
"""See :meth:`telegram.TelegramObject.de_json`."""
2019-08-23 21:20:41 +02:00
if not data:
return None
2020-10-06 19:28:40 +02:00
2019-08-23 21:20:41 +02:00
keyboard = []
for row in data["inline_keyboard"]:
tmp = []
for col in row:
2020-10-06 19:28:40 +02:00
btn = InlineKeyboardButton.de_json(col, bot)
if btn:
tmp.append(btn)
2019-08-23 21:20:41 +02:00
keyboard.append(tmp)
return cls(keyboard)
@classmethod
def from_button(cls, button: InlineKeyboardButton, **kwargs: object) -> "InlineKeyboardMarkup":
"""Shortcut for::
InlineKeyboardMarkup([[button]], **kwargs)
Return an InlineKeyboardMarkup from a single InlineKeyboardButton
Args:
button (:class:`telegram.InlineKeyboardButton`): The button to use in the markup
"""
return cls([[button]], **kwargs) # type: ignore[arg-type]
@classmethod
2020-10-06 19:28:40 +02:00
def from_row(
cls, button_row: Sequence[InlineKeyboardButton], **kwargs: object
2020-10-06 19:28:40 +02:00
) -> "InlineKeyboardMarkup":
"""Shortcut for::
InlineKeyboardMarkup([button_row], **kwargs)
Return an InlineKeyboardMarkup from a single row of InlineKeyboardButtons
Args:
button_row (Sequence[:class:`telegram.InlineKeyboardButton`]): The button to use
in the markup
.. versionchanged:: 20.0
|sequenceargs|
"""
return cls([button_row], **kwargs) # type: ignore[arg-type]
@classmethod
2020-10-06 19:28:40 +02:00
def from_column(
cls, button_column: Sequence[InlineKeyboardButton], **kwargs: object
2020-10-06 19:28:40 +02:00
) -> "InlineKeyboardMarkup":
"""Shortcut for::
InlineKeyboardMarkup([[button] for button in button_column], **kwargs)
Return an InlineKeyboardMarkup from a single column of InlineKeyboardButtons
Args:
button_column (Sequence[:class:`telegram.InlineKeyboardButton`]): The button to use
in the markup
.. versionchanged:: 20.0
|sequenceargs|
"""
button_grid = [[button] for button in button_column]
return cls(button_grid, **kwargs) # type: ignore[arg-type]