2016-04-12 06:12:35 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2022-01-03 08:15:18 +01:00
|
|
|
# Copyright (C) 2015-2022
|
2016-04-12 06:12:35 +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/].
|
2016-10-17 00:22:40 +02:00
|
|
|
"""This module contains an object that represents a Telegram Venue."""
|
2016-04-16 16:33:58 +02:00
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
from typing import TYPE_CHECKING, Optional
|
2020-10-31 16:33:34 +01:00
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram._files.location import Location
|
|
|
|
from telegram._telegramobject import TelegramObject
|
2021-10-10 15:10:21 +02:00
|
|
|
from telegram._utils.types import JSONDict
|
2020-10-09 17:22:07 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
if TYPE_CHECKING:
|
|
|
|
from telegram import Bot
|
2016-04-16 16:33:58 +02:00
|
|
|
|
|
|
|
|
|
|
|
class Venue(TelegramObject):
|
2017-09-01 08:43:08 +02:00
|
|
|
"""This object represents a venue.
|
2016-04-16 16:33:58 +02:00
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
2020-07-28 09:10:32 +02:00
|
|
|
considered equal, if their :attr:`location` and :attr:`title` are equal.
|
2020-07-14 21:33:56 +02:00
|
|
|
|
2020-11-29 16:20:46 +01:00
|
|
|
Note:
|
|
|
|
Foursquare details and Google Pace details are mutually exclusive. However, this
|
|
|
|
behaviour is undocumented and might be changed by Telegram.
|
|
|
|
|
2016-04-16 16:33:58 +02:00
|
|
|
Args:
|
2017-07-23 22:33:08 +02:00
|
|
|
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.
|
Bot API 4.0 (#1168)
Telegram Passport (#1174):
- Add full support for telegram passport.
- New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials, PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and PassportElementErrorFiles.
- New bot method: set_passport_data_errors
- New filter: Filters.passport_data
- Field passport_data field on Message
- PassportData is automagically decrypted when you specify your private key when creating Updater or Bot.
- PassportFiles is also automagically decrypted as you download/retrieve them.
- See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for more info
- NOTE: Passport decryption requires new dependency `cryptography`.
Inputfile rework (#1184):
- Change how Inputfile is handled internally
- This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the different send_ methods.
- Also allows Bot.send_media_group to actually finally send more than one media.
- Add thumb to Audio, Video and Videonote
- Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMediaDocument.
Other Bot API 4.0 changes:
- Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and Bot.send_venue. (#1170)
- Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageContent, and Bot.send_contact. (#1166)
- Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
- Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn't currently send them to bots.
- Phone number also seems to have limited support for now
- Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Co-authored-by: Jasmin Bom <jsmnbom@gmail.com>
Co-authored-by: code1mountain <32801117+code1mountain@users.noreply.github.com>
Co-authored-by: Eldinnie <pieter.schutz+github@gmail.com>
Co-authored-by: mathefreak1 <mathefreak@hi2.in>
2018-08-29 14:18:58 +02:00
|
|
|
foursquare_type (:obj:`str`, optional): Foursquare type of the venue. (For example,
|
|
|
|
"arts_entertainment/default", "arts_entertainment/aquarium" or "food/icecream".)
|
2020-11-29 16:20:46 +01:00
|
|
|
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
|
2022-06-09 17:08:54 +02:00
|
|
|
`supported types <https://developers.google.com/maps/documentation/places/web-service\
|
|
|
|
/supported_types>`_.)
|
2017-09-01 08:43:08 +02:00
|
|
|
|
2020-12-30 15:59:50 +01:00
|
|
|
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.
|
|
|
|
google_place_id (:obj:`str`): Optional. Google Places identifier of the venue.
|
|
|
|
google_place_type (:obj:`str`): Optional. Google Places type of the venue.
|
|
|
|
|
2016-04-16 16:33:58 +02:00
|
|
|
"""
|
|
|
|
|
2021-05-29 16:18:16 +02:00
|
|
|
__slots__ = (
|
|
|
|
"address",
|
2021-10-15 18:03:56 +02:00
|
|
|
"location",
|
2021-05-29 16:18:16 +02:00
|
|
|
"foursquare_id",
|
2021-10-15 18:03:56 +02:00
|
|
|
"foursquare_type",
|
2021-05-29 16:18:16 +02:00
|
|
|
"google_place_id",
|
2021-10-15 18:03:56 +02:00
|
|
|
"google_place_type",
|
|
|
|
"title",
|
2021-05-29 16:18:16 +02:00
|
|
|
)
|
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
def __init__(
|
2020-11-05 18:12:01 +01:00
|
|
|
self,
|
2020-10-06 19:28:40 +02:00
|
|
|
location: Location,
|
|
|
|
title: str,
|
|
|
|
address: str,
|
|
|
|
foursquare_id: str = None,
|
|
|
|
foursquare_type: str = None,
|
2020-11-29 16:20:46 +01:00
|
|
|
google_place_id: str = None,
|
|
|
|
google_place_type: str = None,
|
2022-10-07 11:51:53 +02:00
|
|
|
*,
|
|
|
|
api_kwargs: JSONDict = None,
|
2020-10-06 19:28:40 +02:00
|
|
|
):
|
2022-10-07 11:51:53 +02:00
|
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
|
|
|
2016-04-16 16:33:58 +02:00
|
|
|
# Required
|
|
|
|
self.location = location
|
|
|
|
self.title = title
|
|
|
|
self.address = address
|
|
|
|
# Optionals
|
|
|
|
self.foursquare_id = foursquare_id
|
Bot API 4.0 (#1168)
Telegram Passport (#1174):
- Add full support for telegram passport.
- New types: PassportData, PassportFile, EncryptedPassportElement, EncryptedCredentials, PassportElementError, PassportElementErrorDataField, PassportElementErrorFrontSide, PassportElementErrorReverseSide, PassportElementErrorSelfie, PassportElementErrorFile and PassportElementErrorFiles.
- New bot method: set_passport_data_errors
- New filter: Filters.passport_data
- Field passport_data field on Message
- PassportData is automagically decrypted when you specify your private key when creating Updater or Bot.
- PassportFiles is also automagically decrypted as you download/retrieve them.
- See new passportbot.py example for details on how to use, or go to our telegram passport wiki page for more info
- NOTE: Passport decryption requires new dependency `cryptography`.
Inputfile rework (#1184):
- Change how Inputfile is handled internally
- This allows support for specifying the thumbnails of photos and videos using the thumb= argument in the different send_ methods.
- Also allows Bot.send_media_group to actually finally send more than one media.
- Add thumb to Audio, Video and Videonote
- Add Bot.edit_message_media together with InputMediaAnimation, InputMediaAudio, and inputMediaDocument.
Other Bot API 4.0 changes:
- Add forusquare_type to Venue, InlineQueryResultVenue, InputVenueMessageContent, and Bot.send_venue. (#1170)
- Add vCard support by adding vcard field to Contact, InlineQueryResultContact, InputContactMessageContent, and Bot.send_contact. (#1166)
- Support new message entities: CASHTAG and PHONE_NUMBER. (#1179)
- Cashtag seems to be things like $USD and $GBP, but it seems telegram doesn't currently send them to bots.
- Phone number also seems to have limited support for now
- Add Bot.send_animation, add width, height, and duration to Animation, and add Filters.animation. (#1172)
Co-authored-by: Jasmin Bom <jsmnbom@gmail.com>
Co-authored-by: code1mountain <32801117+code1mountain@users.noreply.github.com>
Co-authored-by: Eldinnie <pieter.schutz+github@gmail.com>
Co-authored-by: mathefreak1 <mathefreak@hi2.in>
2018-08-29 14:18:58 +02:00
|
|
|
self.foursquare_type = foursquare_type
|
2020-11-29 16:20:46 +01:00
|
|
|
self.google_place_id = google_place_id
|
|
|
|
self.google_place_type = google_place_type
|
2016-04-16 16:33:58 +02:00
|
|
|
|
2017-05-14 23:29:31 +02:00
|
|
|
self._id_attrs = (self.location, self.title)
|
|
|
|
|
2017-07-23 21:14:38 +02:00
|
|
|
@classmethod
|
2020-10-06 19:28:40 +02:00
|
|
|
def de_json(cls, data: Optional[JSONDict], bot: "Bot") -> Optional["Venue"]:
|
2021-05-27 09:38:17 +02:00
|
|
|
"""See :meth:`telegram.TelegramObject.de_json`."""
|
|
|
|
data = cls._parse_data(data)
|
2016-04-24 03:37:59 +02:00
|
|
|
|
2016-04-17 12:42:30 +02:00
|
|
|
if not data:
|
|
|
|
return None
|
|
|
|
|
2016-09-20 06:36:55 +02:00
|
|
|
data["location"] = Location.de_json(data.get("location"), bot)
|
2016-04-16 16:33:58 +02:00
|
|
|
|
2022-10-07 11:51:53 +02:00
|
|
|
return super().de_json(data=data, bot=bot)
|