mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-26 09:07:43 +01:00
79 lines
2.8 KiB
Python
79 lines
2.8 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2023
|
|
# 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/].
|
|
# pylint: disable=redefined-builtin
|
|
"""This module contains the classes that represent Telegram InlineQueryResult."""
|
|
|
|
from typing import Final, Optional
|
|
|
|
from telegram import constants
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._utils import enum
|
|
from telegram._utils.types import JSONDict
|
|
|
|
|
|
class InlineQueryResult(TelegramObject):
|
|
"""Baseclass for the InlineQueryResult* classes.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`id` is equal.
|
|
|
|
Note:
|
|
All URLs passed in inline query results will be available to end users and therefore must
|
|
be assumed to be *public*.
|
|
|
|
Examples:
|
|
:any:`Inline Bot <examples.inlinebot>`
|
|
|
|
Args:
|
|
type (:obj:`str`): Type of the result.
|
|
id (:obj:`str`): Unique identifier for this result,
|
|
:tg-const:`telegram.InlineQueryResult.MIN_ID_LENGTH`-
|
|
:tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes.
|
|
|
|
Attributes:
|
|
type (:obj:`str`): Type of the result.
|
|
id (:obj:`str`): Unique identifier for this result,
|
|
:tg-const:`telegram.InlineQueryResult.MIN_ID_LENGTH`-
|
|
:tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes.
|
|
|
|
"""
|
|
|
|
__slots__ = ("type", "id")
|
|
|
|
def __init__(self, type: str, id: str, *, api_kwargs: Optional[JSONDict] = None):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
|
|
# Required
|
|
self.type: str = enum.get_member(constants.InlineQueryResultType, type, type)
|
|
self.id: str = str(id)
|
|
|
|
self._id_attrs = (self.id,)
|
|
|
|
self._freeze()
|
|
|
|
MIN_ID_LENGTH: Final[int] = constants.InlineQueryResultLimit.MIN_ID_LENGTH
|
|
""":const:`telegram.constants.InlineQueryResultLimit.MIN_ID_LENGTH`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|
|
MAX_ID_LENGTH: Final[int] = constants.InlineQueryResultLimit.MAX_ID_LENGTH
|
|
""":const:`telegram.constants.InlineQueryResultLimit.MAX_ID_LENGTH`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|