mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-12-22 22:45:09 +01:00
281 lines
12 KiB
Python
281 lines
12 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 the classes that represent Telegram InlineQueryResultLocation."""
|
|
|
|
from typing import TYPE_CHECKING, ClassVar, Optional
|
|
|
|
from telegram import constants
|
|
from telegram._inline.inlinekeyboardmarkup import InlineKeyboardMarkup
|
|
from telegram._inline.inlinequeryresult import InlineQueryResult
|
|
from telegram._utils.types import JSONDict
|
|
from telegram._utils.warnings_transition import (
|
|
warn_about_deprecated_arg_return_new_arg,
|
|
warn_about_deprecated_attr_in_property,
|
|
)
|
|
|
|
if TYPE_CHECKING:
|
|
from telegram import InputMessageContent
|
|
|
|
|
|
class InlineQueryResultLocation(InlineQueryResult):
|
|
"""
|
|
Represents a location on a map. By default, the location will be sent by the user.
|
|
Alternatively, you can use :attr:`input_message_content` to send a message with the specified
|
|
content instead of the location.
|
|
|
|
Args:
|
|
id (:obj:`str`): Unique identifier for this result,
|
|
:tg-const:`telegram.InlineQueryResult.MIN_ID_LENGTH`-
|
|
:tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes.
|
|
latitude (:obj:`float`): Location latitude in degrees.
|
|
longitude (:obj:`float`): Location longitude in degrees.
|
|
title (:obj:`str`): Location title.
|
|
horizontal_accuracy (:obj:`float`, optional): The radius of uncertainty for the location,
|
|
measured in meters; 0-
|
|
:tg-const:`telegram.InlineQueryResultLocation.HORIZONTAL_ACCURACY`.
|
|
live_period (:obj:`int`, optional): Period in seconds for which the location will be
|
|
updated, should be between
|
|
:tg-const:`telegram.InlineQueryResultLocation.MIN_LIVE_PERIOD` and
|
|
:tg-const:`telegram.InlineQueryResultLocation.MAX_LIVE_PERIOD`.
|
|
heading (:obj:`int`, optional): For live locations, a direction in which the user is
|
|
moving, in degrees. Must be between
|
|
:tg-const:`telegram.InlineQueryResultLocation.MIN_HEADING` and
|
|
:tg-const:`telegram.InlineQueryResultLocation.MAX_HEADING` if specified.
|
|
proximity_alert_radius (:obj:`int`, optional): For live locations, a maximum distance
|
|
for proximity alerts about approaching another chat member, in meters. Must be
|
|
between :tg-const:`telegram.InlineQueryResultLocation.MIN_PROXIMITY_ALERT_RADIUS`
|
|
and :tg-const:`telegram.InlineQueryResultLocation.MAX_PROXIMITY_ALERT_RADIUS`
|
|
if specified.
|
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`, optional): Inline keyboard attached
|
|
to the message.
|
|
input_message_content (:class:`telegram.InputMessageContent`, optional): Content of the
|
|
message to be sent instead of the location.
|
|
thumb_url (:obj:`str`, optional): Url of the thumbnail for the result.
|
|
|
|
.. deprecated:: 20.2
|
|
|thumbargumentdeprecation| :paramref:`thumbnail_url`.
|
|
thumb_width (:obj:`int`, optional): Thumbnail width.
|
|
|
|
.. deprecated:: 20.2
|
|
|thumbargumentdeprecation| :paramref:`thumbnail_width`.
|
|
thumb_height (:obj:`int`, optional): Thumbnail height.
|
|
|
|
.. deprecated:: 20.2
|
|
|thumbargumentdeprecation| :paramref:`thumbnail_height`.
|
|
thumbnail_url (:obj:`str`, optional): Url of the thumbnail for the result.
|
|
|
|
.. versionadded:: 20.2
|
|
thumbnail_width (:obj:`int`, optional): Thumbnail width.
|
|
|
|
.. versionadded:: 20.2
|
|
thumbnail_height (:obj:`int`, optional): Thumbnail height.
|
|
|
|
.. versionadded:: 20.2
|
|
|
|
Attributes:
|
|
type (:obj:`str`): :tg-const:`telegram.constants.InlineQueryResultType.LOCATION`.
|
|
id (:obj:`str`): Unique identifier for this result,
|
|
:tg-const:`telegram.InlineQueryResult.MIN_ID_LENGTH`-
|
|
:tg-const:`telegram.InlineQueryResult.MAX_ID_LENGTH` Bytes.
|
|
latitude (:obj:`float`): Location latitude in degrees.
|
|
longitude (:obj:`float`): Location longitude in degrees.
|
|
title (:obj:`str`): Location title.
|
|
horizontal_accuracy (:obj:`float`): Optional. The radius of uncertainty for the location,
|
|
measured in meters; 0-
|
|
:tg-const:`telegram.InlineQueryResultLocation.HORIZONTAL_ACCURACY`.
|
|
live_period (:obj:`int`): Optional. Period in seconds for which the location will be
|
|
updated, should be between
|
|
:tg-const:`telegram.InlineQueryResultLocation.MIN_LIVE_PERIOD` and
|
|
:tg-const:`telegram.InlineQueryResultLocation.MAX_LIVE_PERIOD`.
|
|
heading (:obj:`int`): Optional. For live locations, a direction in which the user is
|
|
moving, in degrees. Must be between
|
|
:tg-const:`telegram.InlineQueryResultLocation.MIN_HEADING` and
|
|
:tg-const:`telegram.InlineQueryResultLocation.MAX_HEADING` if specified.
|
|
proximity_alert_radius (:obj:`int`): Optional. For live locations, a maximum distance
|
|
for proximity alerts about approaching another chat member, in meters. Must be
|
|
between :tg-const:`telegram.InlineQueryResultLocation.MIN_PROXIMITY_ALERT_RADIUS`
|
|
and :tg-const:`telegram.InlineQueryResultLocation.MAX_PROXIMITY_ALERT_RADIUS`
|
|
if specified.
|
|
reply_markup (:class:`telegram.InlineKeyboardMarkup`): Optional. Inline keyboard attached
|
|
to the message.
|
|
input_message_content (:class:`telegram.InputMessageContent`): Optional. Content of the
|
|
message to be sent instead of the location.
|
|
thumbnail_url (:obj:`str`): Optional. Url of the thumbnail for the result.
|
|
|
|
.. versionadded:: 20.2
|
|
thumbnail_width (:obj:`int`): Optional. Thumbnail width.
|
|
|
|
.. versionadded:: 20.2
|
|
thumbnail_height (:obj:`int`): Optional. Thumbnail height.
|
|
|
|
.. versionadded:: 20.2
|
|
|
|
"""
|
|
|
|
__slots__ = (
|
|
"longitude",
|
|
"reply_markup",
|
|
"thumbnail_width",
|
|
"thumbnail_height",
|
|
"heading",
|
|
"title",
|
|
"live_period",
|
|
"proximity_alert_radius",
|
|
"input_message_content",
|
|
"latitude",
|
|
"horizontal_accuracy",
|
|
"thumbnail_url",
|
|
)
|
|
|
|
def __init__(
|
|
self,
|
|
id: str, # pylint: disable=redefined-builtin
|
|
latitude: float,
|
|
longitude: float,
|
|
title: str,
|
|
live_period: Optional[int] = None,
|
|
reply_markup: Optional[InlineKeyboardMarkup] = None,
|
|
input_message_content: Optional["InputMessageContent"] = None,
|
|
thumb_url: Optional[str] = None,
|
|
thumb_width: Optional[int] = None,
|
|
thumb_height: Optional[int] = None,
|
|
horizontal_accuracy: Optional[float] = None,
|
|
heading: Optional[int] = None,
|
|
proximity_alert_radius: Optional[int] = None,
|
|
thumbnail_url: Optional[str] = None,
|
|
thumbnail_width: Optional[int] = None,
|
|
thumbnail_height: Optional[int] = None,
|
|
*,
|
|
api_kwargs: Optional[JSONDict] = None,
|
|
):
|
|
# Required
|
|
super().__init__(constants.InlineQueryResultType.LOCATION, id, api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
self.latitude: float = latitude
|
|
self.longitude: float = longitude
|
|
self.title: str = title
|
|
|
|
# Optionals
|
|
self.live_period: Optional[int] = live_period
|
|
self.reply_markup: Optional[InlineKeyboardMarkup] = reply_markup
|
|
self.input_message_content: Optional[InputMessageContent] = input_message_content
|
|
self.thumbnail_url: Optional[str] = warn_about_deprecated_arg_return_new_arg(
|
|
deprecated_arg=thumb_url,
|
|
new_arg=thumbnail_url,
|
|
deprecated_arg_name="thumb_url",
|
|
new_arg_name="thumbnail_url",
|
|
bot_api_version="6.6",
|
|
)
|
|
self.thumbnail_width: Optional[int] = warn_about_deprecated_arg_return_new_arg(
|
|
deprecated_arg=thumb_width,
|
|
new_arg=thumbnail_width,
|
|
deprecated_arg_name="thumb_width",
|
|
new_arg_name="thumbnail_width",
|
|
bot_api_version="6.6",
|
|
)
|
|
self.thumbnail_height: Optional[int] = warn_about_deprecated_arg_return_new_arg(
|
|
deprecated_arg=thumb_height,
|
|
new_arg=thumbnail_height,
|
|
deprecated_arg_name="thumb_height",
|
|
new_arg_name="thumbnail_height",
|
|
bot_api_version="6.6",
|
|
)
|
|
self.horizontal_accuracy: Optional[float] = horizontal_accuracy
|
|
self.heading: Optional[int] = heading
|
|
self.proximity_alert_radius: Optional[int] = (
|
|
int(proximity_alert_radius) if proximity_alert_radius else None
|
|
)
|
|
|
|
@property
|
|
def thumb_url(self) -> Optional[str]:
|
|
""":obj:`str`: Optional. Url of the thumbnail for the result.
|
|
|
|
.. deprecated:: 20.2
|
|
|thumbattributedeprecation| :attr:`thumbnail_url`.
|
|
"""
|
|
warn_about_deprecated_attr_in_property(
|
|
deprecated_attr_name="thumb_url",
|
|
new_attr_name="thumbnail_url",
|
|
bot_api_version="6.6",
|
|
)
|
|
return self.thumbnail_url
|
|
|
|
@property
|
|
def thumb_width(self) -> Optional[int]:
|
|
""":obj:`str`: Optional. Thumbnail width.
|
|
|
|
.. deprecated:: 20.2
|
|
|thumbattributedeprecation| :attr:`thumbnail_width`.
|
|
"""
|
|
warn_about_deprecated_attr_in_property(
|
|
deprecated_attr_name="thumb_width",
|
|
new_attr_name="thumbnail_width",
|
|
bot_api_version="6.6",
|
|
)
|
|
return self.thumbnail_width
|
|
|
|
@property
|
|
def thumb_height(self) -> Optional[int]:
|
|
""":obj:`str`: Optional. Thumbnail height.
|
|
|
|
.. deprecated:: 20.2
|
|
|thumbattributedeprecation| :attr:`thumbnail_height`.
|
|
"""
|
|
warn_about_deprecated_attr_in_property(
|
|
deprecated_attr_name="thumb_height",
|
|
new_attr_name="thumbnail_height",
|
|
bot_api_version="6.6",
|
|
)
|
|
return self.thumbnail_height
|
|
|
|
HORIZONTAL_ACCURACY: ClassVar[int] = constants.LocationLimit.HORIZONTAL_ACCURACY
|
|
""":const:`telegram.constants.LocationLimit.HORIZONTAL_ACCURACY`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|
|
MIN_HEADING: ClassVar[int] = constants.LocationLimit.MIN_HEADING
|
|
""":const:`telegram.constants.LocationLimit.MIN_HEADING`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|
|
MAX_HEADING: ClassVar[int] = constants.LocationLimit.MAX_HEADING
|
|
""":const:`telegram.constants.LocationLimit.MAX_HEADING`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|
|
MIN_LIVE_PERIOD: ClassVar[int] = constants.LocationLimit.MIN_LIVE_PERIOD
|
|
""":const:`telegram.constants.LocationLimit.MIN_LIVE_PERIOD`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|
|
MAX_LIVE_PERIOD: ClassVar[int] = constants.LocationLimit.MAX_LIVE_PERIOD
|
|
""":const:`telegram.constants.LocationLimit.MAX_LIVE_PERIOD`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|
|
MIN_PROXIMITY_ALERT_RADIUS: ClassVar[int] = constants.LocationLimit.MIN_PROXIMITY_ALERT_RADIUS
|
|
""":const:`telegram.constants.LocationLimit.MIN_PROXIMITY_ALERT_RADIUS`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|
|
MAX_PROXIMITY_ALERT_RADIUS: ClassVar[int] = constants.LocationLimit.MAX_PROXIMITY_ALERT_RADIUS
|
|
""":const:`telegram.constants.LocationLimit.MAX_PROXIMITY_ALERT_RADIUS`
|
|
|
|
.. versionadded:: 20.0
|
|
"""
|