mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-22 07:06:26 +01:00
115 lines
4.4 KiB
Python
115 lines
4.4 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/].
|
|
"""This module contains an object that represents a Telegram Venue."""
|
|
|
|
from typing import TYPE_CHECKING, Optional
|
|
|
|
from telegram._files.location import Location
|
|
from telegram._telegramobject import TelegramObject
|
|
from telegram._utils.types import JSONDict
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import Bot
|
|
|
|
|
|
class Venue(TelegramObject):
|
|
"""This object represents a venue.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`location` and :attr:`title` are equal.
|
|
|
|
Note:
|
|
Foursquare details and Google Place details are mutually exclusive. However, this
|
|
behaviour is undocumented and might be changed by Telegram.
|
|
|
|
Args:
|
|
location (:class:`telegram.Location`): Venue location.
|
|
title (:obj:`str`): Name of the venue.
|
|
address (:obj:`str`): Address of the venue.
|
|
foursquare_id (:obj:`str`, optional): Foursquare identifier of the venue.
|
|
foursquare_type (:obj:`str`, optional): Foursquare type of the venue. (For example,
|
|
"arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".)
|
|
google_place_id (:obj:`str`, optional): Google Places identifier of the venue.
|
|
google_place_type (:obj:`str`, optional): Google Places type of the venue. (See
|
|
`supported types <https://developers.google.com/maps/documentation/places/web-service\
|
|
/supported_types>`_.)
|
|
|
|
Attributes:
|
|
location (:class:`telegram.Location`): Venue location.
|
|
title (:obj:`str`): Name of the venue.
|
|
address (:obj:`str`): Address of the venue.
|
|
foursquare_id (:obj:`str`): Optional. Foursquare identifier of the venue.
|
|
foursquare_type (:obj:`str`): Optional. Foursquare type of the venue. (For example,
|
|
"arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".)
|
|
google_place_id (:obj:`str`): Optional. Google Places identifier of the venue.
|
|
google_place_type (:obj:`str`): Optional. Google Places type of the venue. (See
|
|
`supported types <https://developers.google.com/maps/documentation/places/web-service\
|
|
/supported_types>`_.)
|
|
|
|
"""
|
|
|
|
__slots__ = (
|
|
"address",
|
|
"location",
|
|
"foursquare_id",
|
|
"foursquare_type",
|
|
"google_place_id",
|
|
"google_place_type",
|
|
"title",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
location: Location,
|
|
title: str,
|
|
address: str,
|
|
foursquare_id: Optional[str] = None,
|
|
foursquare_type: Optional[str] = None,
|
|
google_place_id: Optional[str] = None,
|
|
google_place_type: Optional[str] = None,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
|
|
# Required
|
|
self.location: Location = location
|
|
self.title: str = title
|
|
self.address: str = address
|
|
# Optionals
|
|
self.foursquare_id: Optional[str] = foursquare_id
|
|
self.foursquare_type: Optional[str] = foursquare_type
|
|
self.google_place_id: Optional[str] = google_place_id
|
|
self.google_place_type: Optional[str] = google_place_type
|
|
|
|
self._id_attrs = (self.location, self.title)
|
|
|
|
self._freeze()
|
|
|
|
@classmethod
|
|
def de_json(cls, data: Optional[JSONDict], bot: "Bot") -> Optional["Venue"]:
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
data = cls._parse_data(data)
|
|
|
|
if not data:
|
|
return None
|
|
|
|
data["location"] = Location.de_json(data.get("location"), bot)
|
|
|
|
return super().de_json(data=data, bot=bot)
|