1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308
|
#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2025
# 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/].
import asyncio
import datetime as dtm
import pytest
from telegram import Location, ReplyParameters
from telegram.constants import ParseMode
from telegram.error import BadRequest
from telegram.request import RequestData
from telegram.warnings import PTBDeprecationWarning
from tests.auxil.build_messages import make_message
from tests.auxil.slots import mro_slots
@pytest.fixture(scope="module")
def location():
return Location(
latitude=LocationTestBase.latitude,
longitude=LocationTestBase.longitude,
horizontal_accuracy=LocationTestBase.horizontal_accuracy,
live_period=LocationTestBase.live_period,
heading=LocationTestBase.live_period,
proximity_alert_radius=LocationTestBase.proximity_alert_radius,
)
class LocationTestBase:
latitude = -23.691288
longitude = -46.788279
horizontal_accuracy = 999
live_period = dtm.timedelta(seconds=60)
heading = 90
proximity_alert_radius = 50
class TestLocationWithoutRequest(LocationTestBase):
def test_slot_behaviour(self, location):
for attr in location.__slots__:
assert getattr(location, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(location)) == len(set(mro_slots(location))), "duplicate slot"
def test_de_json(self, offline_bot):
json_dict = {
"latitude": self.latitude,
"longitude": self.longitude,
"horizontal_accuracy": self.horizontal_accuracy,
"live_period": int(self.live_period.total_seconds()),
"heading": self.heading,
"proximity_alert_radius": self.proximity_alert_radius,
}
location = Location.de_json(json_dict, offline_bot)
assert location.api_kwargs == {}
assert location.latitude == self.latitude
assert location.longitude == self.longitude
assert location.horizontal_accuracy == self.horizontal_accuracy
assert location._live_period == self.live_period
assert location.heading == self.heading
assert location.proximity_alert_radius == self.proximity_alert_radius
def test_to_dict(self, location):
location_dict = location.to_dict()
assert location_dict["latitude"] == location.latitude
assert location_dict["longitude"] == location.longitude
assert location_dict["horizontal_accuracy"] == location.horizontal_accuracy
assert location_dict["live_period"] == int(self.live_period.total_seconds())
assert isinstance(location_dict["live_period"], int)
assert location["heading"] == location.heading
assert location["proximity_alert_radius"] == location.proximity_alert_radius
def test_time_period_properties(self, PTB_TIMEDELTA, location):
if PTB_TIMEDELTA:
assert location.live_period == self.live_period
assert isinstance(location.live_period, dtm.timedelta)
else:
assert location.live_period == int(self.live_period.total_seconds())
assert isinstance(location.live_period, int)
def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, location):
location.live_period
if PTB_TIMEDELTA:
assert len(recwarn) == 0
else:
assert len(recwarn) == 1
assert "`live_period` will be of type `datetime.timedelta`" in str(recwarn[0].message)
assert recwarn[0].category is PTBDeprecationWarning
def test_equality(self):
a = Location(self.longitude, self.latitude)
b = Location(self.longitude, self.latitude)
d = Location(0, self.latitude)
assert a == b
assert hash(a) == hash(b)
assert a is not b
assert a != d
assert hash(a) != hash(d)
async def test_send_location_without_required(self, offline_bot, chat_id):
with pytest.raises(ValueError, match="Either location or latitude and longitude"):
await offline_bot.send_location(chat_id=chat_id)
async def test_edit_location_without_required(self, offline_bot):
with pytest.raises(ValueError, match="Either location or latitude and longitude"):
await offline_bot.edit_message_live_location(chat_id=2, message_id=3)
async def test_send_location_with_all_args(self, offline_bot, location):
with pytest.raises(ValueError, match="Not both"):
await offline_bot.send_location(
chat_id=1, latitude=2.5, longitude=4.6, location=location
)
async def test_edit_location_with_all_args(self, offline_bot, location):
with pytest.raises(ValueError, match="Not both"):
await offline_bot.edit_message_live_location(
chat_id=1, message_id=7, latitude=2.5, longitude=4.6, location=location
)
# TODO: Needs improvement with in inline sent live location.
async def test_edit_live_inline_message(self, monkeypatch, offline_bot, location):
async def make_assertion(url, request_data: RequestData, *args, **kwargs):
data = request_data.json_parameters
lat = data["latitude"] == str(location.latitude)
lon = data["longitude"] == str(location.longitude)
id_ = data["inline_message_id"] == "1234"
ha = data["horizontal_accuracy"] == "50"
heading = data["heading"] == "90"
prox_alert = data["proximity_alert_radius"] == "1000"
live = data["live_period"] == "900"
return lat and lon and id_ and ha and heading and prox_alert and live
monkeypatch.setattr(offline_bot.request, "post", make_assertion)
assert await offline_bot.edit_message_live_location(
inline_message_id=1234,
location=location,
horizontal_accuracy=50,
heading=90,
proximity_alert_radius=1000,
live_period=900,
)
# TODO: Needs improvement with in inline sent live location.
async def test_stop_live_inline_message(self, monkeypatch, offline_bot):
async def make_assertion(url, request_data: RequestData, *args, **kwargs):
return request_data.json_parameters["inline_message_id"] == "1234"
monkeypatch.setattr(offline_bot.request, "post", make_assertion)
assert await offline_bot.stop_message_live_location(inline_message_id=1234)
async def test_send_with_location(self, monkeypatch, offline_bot, chat_id, location):
async def make_assertion(url, request_data: RequestData, *args, **kwargs):
lat = request_data.json_parameters["latitude"] == str(location.latitude)
lon = request_data.json_parameters["longitude"] == str(location.longitude)
return lat and lon
monkeypatch.setattr(offline_bot.request, "post", make_assertion)
assert await offline_bot.send_location(location=location, chat_id=chat_id)
async def test_edit_live_location_with_location(self, monkeypatch, offline_bot, location):
async def make_assertion(url, request_data: RequestData, *args, **kwargs):
lat = request_data.json_parameters["latitude"] == str(location.latitude)
lon = request_data.json_parameters["longitude"] == str(location.longitude)
return lat and lon
monkeypatch.setattr(offline_bot.request, "post", make_assertion)
assert await offline_bot.edit_message_live_location(None, None, location=location)
@pytest.mark.parametrize(
("default_bot", "custom"),
[
({"parse_mode": ParseMode.HTML}, None),
({"parse_mode": ParseMode.HTML}, ParseMode.MARKDOWN_V2),
({"parse_mode": None}, ParseMode.MARKDOWN_V2),
],
indirect=["default_bot"],
)
async def test_send_location_default_quote_parse_mode(
self, default_bot, chat_id, location, custom, monkeypatch
):
async def make_assertion(url, request_data: RequestData, *args, **kwargs):
assert request_data.parameters["reply_parameters"].get("quote_parse_mode") == (
custom or default_bot.defaults.quote_parse_mode
)
return make_message("dummy reply").to_dict()
kwargs = {"message_id": 1}
if custom is not None:
kwargs["quote_parse_mode"] = custom
monkeypatch.setattr(default_bot.request, "post", make_assertion)
await default_bot.send_location(
chat_id, location=location, reply_parameters=ReplyParameters(**kwargs)
)
class TestLocationWithRequest:
@pytest.mark.parametrize(
("default_bot", "custom"),
[
({"allow_sending_without_reply": True}, None),
({"allow_sending_without_reply": False}, None),
({"allow_sending_without_reply": False}, True),
],
indirect=["default_bot"],
)
async def test_send_location_default_allow_sending_without_reply(
self, default_bot, chat_id, location, custom
):
reply_to_message = await default_bot.send_message(chat_id, "test")
await reply_to_message.delete()
if custom is not None:
message = await default_bot.send_location(
chat_id,
location=location,
allow_sending_without_reply=custom,
reply_to_message_id=reply_to_message.message_id,
)
assert message.reply_to_message is None
elif default_bot.defaults.allow_sending_without_reply:
message = await default_bot.send_location(
chat_id, location=location, reply_to_message_id=reply_to_message.message_id
)
assert message.reply_to_message is None
else:
with pytest.raises(BadRequest, match="Message to be replied not found"):
await default_bot.send_location(
chat_id, location=location, reply_to_message_id=reply_to_message.message_id
)
@pytest.mark.parametrize("default_bot", [{"protect_content": True}], indirect=True)
async def test_send_location_default_protect_content(self, chat_id, default_bot, location):
tasks = asyncio.gather(
default_bot.send_location(chat_id, location=location),
default_bot.send_location(chat_id, location=location, protect_content=False),
)
protected, unprotected = await tasks
assert protected.has_protected_content
assert not unprotected.has_protected_content
@pytest.mark.xfail
@pytest.mark.parametrize(
("live_period", "edit_live_period"),
[(80, 200), (dtm.timedelta(seconds=80), dtm.timedelta(seconds=200))],
)
async def test_send_live_location(self, bot, chat_id, live_period, edit_live_period):
message = await bot.send_location(
chat_id=chat_id,
latitude=52.223880,
longitude=5.166146,
live_period=live_period,
horizontal_accuracy=50,
heading=90,
proximity_alert_radius=1000,
protect_content=True,
)
assert message.location
assert pytest.approx(message.location.latitude, rel=1e-5) == 52.223880
assert pytest.approx(message.location.longitude, rel=1e-5) == 5.166146
assert message.location.live_period == 80
assert message.location.horizontal_accuracy == 50
assert message.location.heading == 90
assert message.location.proximity_alert_radius == 1000
assert message.has_protected_content
message2 = await bot.edit_message_live_location(
message.chat_id,
message.message_id,
latitude=52.223098,
longitude=5.164306,
horizontal_accuracy=30,
heading=10,
proximity_alert_radius=500,
live_period=edit_live_period,
)
assert pytest.approx(message2.location.latitude, rel=1e-5) == 52.223098
assert pytest.approx(message2.location.longitude, rel=1e-5) == 5.164306
assert message2.location.horizontal_accuracy == 30
assert message2.location.heading == 10
assert message2.location.proximity_alert_radius == 500
assert message2.location.live_period == 200
assert await bot.stop_message_live_location(message.chat_id, message.message_id)
with pytest.raises(BadRequest, match="Message can't be edited"):
await bot.edit_message_live_location(
message.chat_id, message.message_id, latitude=52.223880, longitude=5.164306
)
|