mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-23 17:36:26 +02:00
75 lines
2.4 KiB
Python
75 lines
2.4 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2024
|
|
# 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 ShippingOption."""
|
|
from typing import TYPE_CHECKING, Optional, Sequence, Tuple
|
|
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._utils.argumentparsing import parse_sequence_arg
|
|
from telegram._utils.types import JSONDict
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import LabeledPrice
|
|
|
|
|
|
class ShippingOption(TelegramObject):
|
|
"""This object represents one shipping option.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`id` is equal.
|
|
|
|
Examples:
|
|
:any:`Payment Bot <examples.paymentbot>`
|
|
|
|
Args:
|
|
id (:obj:`str`): Shipping option identifier.
|
|
title (:obj:`str`): Option title.
|
|
prices (Sequence[:class:`telegram.LabeledPrice`]): List of price portions.
|
|
|
|
.. versionchanged:: 20.0
|
|
|sequenceclassargs|
|
|
|
|
Attributes:
|
|
id (:obj:`str`): Shipping option identifier.
|
|
title (:obj:`str`): Option title.
|
|
prices (Tuple[:class:`telegram.LabeledPrice`]): List of price portions.
|
|
|
|
.. versionchanged:: 20.0
|
|
|tupleclassattrs|
|
|
|
|
"""
|
|
|
|
__slots__ = ("id", "prices", "title")
|
|
|
|
def __init__(
|
|
self,
|
|
id: str, # pylint: disable=redefined-builtin
|
|
title: str,
|
|
prices: Sequence["LabeledPrice"],
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
|
|
self.id: str = id
|
|
self.title: str = title
|
|
self.prices: Tuple[LabeledPrice, ...] = parse_sequence_arg(prices)
|
|
|
|
self._id_attrs = (self.id,)
|
|
|
|
self._freeze()
|