mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-10-23 17:36:26 +02:00
89 lines
2.9 KiB
Python
89 lines
2.9 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 ShippingAddress."""
|
|
|
|
from typing import Optional
|
|
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._utils.types import JSONDict
|
|
|
|
|
|
class ShippingAddress(TelegramObject):
|
|
"""This object represents a Telegram ShippingAddress.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`country_code`, :attr:`state`, :attr:`city`,
|
|
:attr:`street_line1`, :attr:`street_line2` and :attr:`post_code` are equal.
|
|
|
|
Args:
|
|
country_code (:obj:`str`): ISO 3166-1 alpha-2 country code.
|
|
state (:obj:`str`): State, if applicable.
|
|
city (:obj:`str`): City.
|
|
street_line1 (:obj:`str`): First line for the address.
|
|
street_line2 (:obj:`str`): Second line for the address.
|
|
post_code (:obj:`str`): Address post code.
|
|
|
|
Attributes:
|
|
country_code (:obj:`str`): ISO 3166-1 alpha-2 country code.
|
|
state (:obj:`str`): State, if applicable.
|
|
city (:obj:`str`): City.
|
|
street_line1 (:obj:`str`): First line for the address.
|
|
street_line2 (:obj:`str`): Second line for the address.
|
|
post_code (:obj:`str`): Address post code.
|
|
|
|
"""
|
|
|
|
__slots__ = (
|
|
"city",
|
|
"country_code",
|
|
"post_code",
|
|
"state",
|
|
"street_line1",
|
|
"street_line2",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
country_code: str,
|
|
state: str,
|
|
city: str,
|
|
street_line1: str,
|
|
street_line2: str,
|
|
post_code: str,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
self.country_code: str = country_code
|
|
self.state: str = state
|
|
self.city: str = city
|
|
self.street_line1: str = street_line1
|
|
self.street_line2: str = street_line2
|
|
self.post_code: str = post_code
|
|
|
|
self._id_attrs = (
|
|
self.country_code,
|
|
self.state,
|
|
self.city,
|
|
self.street_line1,
|
|
self.street_line2,
|
|
self.post_code,
|
|
)
|
|
|
|
self._freeze()
|