mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-11-21 22:56:38 +01:00
f408b1a2dd
Co-authored-by: Dmitry Kolomatskiy <58207913+lemontree210@users.noreply.github.com> Co-authored-by: Viicos <65306057+Viicos@users.noreply.github.com> Co-authored-by: Harshil <37377066+harshil21@users.noreply.github.com> Co-authored-by: Eisberge <22561095+Eisberge@users.noreply.github.com> Co-authored-by: Joshua Tang <joshuaystang@gmail.com>
143 lines
6.3 KiB
Python
143 lines
6.3 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2022
|
|
# 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 InputLocationMessageContent."""
|
|
|
|
from typing import ClassVar
|
|
|
|
from telegram import constants
|
|
from telegram._inline.inputmessagecontent import InputMessageContent
|
|
from telegram._utils.types import JSONDict
|
|
|
|
|
|
class InputLocationMessageContent(InputMessageContent):
|
|
# fmt: off
|
|
"""
|
|
Represents the content of a location message to be sent as the result of an inline query.
|
|
|
|
Objects of this class are comparable in terms of equality. Two objects of this class are
|
|
considered equal, if their :attr:`latitude` and :attr:`longitude` are equal.
|
|
|
|
Args:
|
|
latitude (:obj:`float`): Latitude of the location in degrees.
|
|
longitude (:obj:`float`): Longitude of the location in degrees.
|
|
horizontal_accuracy (:obj:`float`, optional): The radius of uncertainty for the location,
|
|
measured in meters; 0-
|
|
:tg-const:`telegram.InputLocationMessageContent.HORIZONTAL_ACCURACY`.
|
|
live_period (:obj:`int`, optional): Period in seconds for which the location will be
|
|
updated, should be between
|
|
:tg-const:`telegram.InputLocationMessageContent.MIN_LIVE_PERIOD` and
|
|
:tg-const:`telegram.InputLocationMessageContent.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.InputLocationMessageContent.MIN_HEADING` and
|
|
:tg-const:`telegram.InputLocationMessageContent.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.InputLocationMessageContent.MIN_PROXIMITY_ALERT_RADIUS`
|
|
and :tg-const:`telegram.InputLocationMessageContent.MAX_PROXIMITY_ALERT_RADIUS`
|
|
if specified.
|
|
|
|
Attributes:
|
|
latitude (:obj:`float`): Latitude of the location in degrees.
|
|
longitude (:obj:`float`): Longitude of the location in degrees.
|
|
horizontal_accuracy (:obj:`float`): Optional. The radius of uncertainty for the location,
|
|
measured in meters; 0-
|
|
:tg-const:`telegram.InputLocationMessageContent.HORIZONTAL_ACCURACY`.
|
|
live_period (:obj:`int`): Optional. Period in seconds for which the location can be
|
|
updated, should be between
|
|
:tg-const:`telegram.InputLocationMessageContent.MIN_LIVE_PERIOD` and
|
|
:tg-const:`telegram.InputLocationMessageContent.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.InputLocationMessageContent.MIN_HEADING` and
|
|
:tg-const:`telegram.InputLocationMessageContent.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.InputLocationMessageContent.MIN_PROXIMITY_ALERT_RADIUS`
|
|
and :tg-const:`telegram.InputLocationMessageContent.MAX_PROXIMITY_ALERT_RADIUS`
|
|
if specified.
|
|
|
|
"""
|
|
|
|
__slots__ = ('longitude', 'horizontal_accuracy', 'proximity_alert_radius', 'live_period',
|
|
'latitude', 'heading')
|
|
# fmt: on
|
|
|
|
def __init__(
|
|
self,
|
|
latitude: float,
|
|
longitude: float,
|
|
live_period: int = None,
|
|
horizontal_accuracy: float = None,
|
|
heading: int = None,
|
|
proximity_alert_radius: int = None,
|
|
*,
|
|
api_kwargs: JSONDict = None,
|
|
):
|
|
super().__init__(api_kwargs=api_kwargs)
|
|
with self._unfrozen():
|
|
# Required
|
|
self.latitude = latitude
|
|
self.longitude = longitude
|
|
|
|
# Optionals
|
|
self.live_period = live_period
|
|
self.horizontal_accuracy = horizontal_accuracy
|
|
self.heading = heading
|
|
self.proximity_alert_radius = (
|
|
int(proximity_alert_radius) if proximity_alert_radius else None
|
|
)
|
|
|
|
self._id_attrs = (self.latitude, self.longitude)
|
|
|
|
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
|
|
"""
|