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 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588
|
#!/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 datetime as dtm
import pytest
from telegram import (
Audio,
Bot,
CallbackQuery,
Chat,
InaccessibleMessage,
InputChecklist,
InputChecklistTask,
Message,
User,
)
from tests.auxil.bot_method_checks import (
check_defaults_handling,
check_shortcut_call,
check_shortcut_signature,
)
from tests.auxil.slots import mro_slots
@pytest.fixture(params=["message", "inline", "inaccessible_message"])
def callback_query(bot, request):
cbq = CallbackQuery(
CallbackQueryTestBase.id_,
CallbackQueryTestBase.from_user,
CallbackQueryTestBase.chat_instance,
data=CallbackQueryTestBase.data,
game_short_name=CallbackQueryTestBase.game_short_name,
)
cbq.set_bot(bot)
cbq._unfreeze()
if request.param == "message":
cbq.message = CallbackQueryTestBase.message
cbq.message.set_bot(bot)
elif request.param == "inline":
cbq.inline_message_id = CallbackQueryTestBase.inline_message_id
elif request.param == "inaccessible_message":
cbq.message = InaccessibleMessage(
chat=CallbackQueryTestBase.message.chat,
message_id=CallbackQueryTestBase.message.message_id,
)
return cbq
class CallbackQueryTestBase:
id_ = "id"
from_user = User(1, "test_user", False)
chat_instance = "chat_instance"
message = Message(
3, dtm.datetime.utcnow(), Chat(4, "private"), from_user=User(5, "bot", False)
)
data = "data"
inline_message_id = "inline_message_id"
game_short_name = "the_game"
class TestCallbackQueryWithoutRequest(CallbackQueryTestBase):
@staticmethod
def skip_params(callback_query: CallbackQuery):
if callback_query.inline_message_id:
return {"message_id", "chat_id", "business_connection_id"}
return {"inline_message_id", "business_connection_id"}
@staticmethod
def shortcut_kwargs(callback_query: CallbackQuery):
if not callback_query.inline_message_id:
return {"message_id", "chat_id"}
return {"inline_message_id"}
@staticmethod
def check_passed_ids(callback_query: CallbackQuery, kwargs):
if callback_query.inline_message_id:
id_ = kwargs["inline_message_id"] == callback_query.inline_message_id
chat_id = kwargs["chat_id"] is None
message_id = kwargs["message_id"] is None
else:
id_ = kwargs["inline_message_id"] is None
chat_id = kwargs["chat_id"] == callback_query.message.chat_id
message_id = kwargs["message_id"] == callback_query.message.message_id
return id_ and chat_id and message_id
def test_slot_behaviour(self, callback_query):
for attr in callback_query.__slots__:
assert getattr(callback_query, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(callback_query)) == len(set(mro_slots(callback_query))), "same slot"
def test_de_json(self, offline_bot):
json_dict = {
"id": self.id_,
"from": self.from_user.to_dict(),
"chat_instance": self.chat_instance,
"message": self.message.to_dict(),
"data": self.data,
"inline_message_id": self.inline_message_id,
"game_short_name": self.game_short_name,
}
callback_query = CallbackQuery.de_json(json_dict, offline_bot)
assert callback_query.api_kwargs == {}
assert callback_query.id == self.id_
assert callback_query.from_user == self.from_user
assert callback_query.chat_instance == self.chat_instance
assert callback_query.message == self.message
assert callback_query.data == self.data
assert callback_query.inline_message_id == self.inline_message_id
assert callback_query.game_short_name == self.game_short_name
def test_to_dict(self, callback_query):
callback_query_dict = callback_query.to_dict()
assert isinstance(callback_query_dict, dict)
assert callback_query_dict["id"] == callback_query.id
assert callback_query_dict["from"] == callback_query.from_user.to_dict()
assert callback_query_dict["chat_instance"] == callback_query.chat_instance
if callback_query.message is not None:
assert callback_query_dict["message"] == callback_query.message.to_dict()
elif callback_query.inline_message_id:
assert callback_query_dict["inline_message_id"] == callback_query.inline_message_id
assert callback_query_dict["data"] == callback_query.data
assert callback_query_dict["game_short_name"] == callback_query.game_short_name
def test_equality(self):
a = CallbackQuery(self.id_, self.from_user, "chat")
b = CallbackQuery(self.id_, self.from_user, "chat")
c = CallbackQuery(self.id_, None, "")
d = CallbackQuery("", None, "chat")
e = Audio(self.id_, "unique_id", 1)
assert a == b
assert hash(a) == hash(b)
assert a is not b
assert a == c
assert hash(a) == hash(c)
assert a != d
assert hash(a) != hash(d)
assert a != e
assert hash(a) != hash(e)
async def test_answer(self, monkeypatch, callback_query):
async def make_assertion(*_, **kwargs):
return kwargs["callback_query_id"] == callback_query.id
assert check_shortcut_signature(
CallbackQuery.answer, Bot.answer_callback_query, ["callback_query_id"], []
)
assert await check_shortcut_call(
callback_query.answer, callback_query.get_bot(), "answer_callback_query"
)
assert await check_defaults_handling(callback_query.answer, callback_query.get_bot())
monkeypatch.setattr(callback_query.get_bot(), "answer_callback_query", make_assertion)
assert await callback_query.answer()
async def test_edit_message_text(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.edit_message_text("test")
return
async def make_assertion(*_, **kwargs):
text = kwargs["text"] == "test"
ids = self.check_passed_ids(callback_query, kwargs)
return ids and text
assert check_shortcut_signature(
CallbackQuery.edit_message_text,
Bot.edit_message_text,
["inline_message_id", "message_id", "chat_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.edit_message_text,
callback_query.get_bot(),
"edit_message_text",
skip_params=self.skip_params(callback_query),
shortcut_kwargs=self.shortcut_kwargs(callback_query),
)
assert await check_defaults_handling(
callback_query.edit_message_text, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "edit_message_text", make_assertion)
assert await callback_query.edit_message_text(text="test")
assert await callback_query.edit_message_text("test")
async def test_edit_message_caption(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.edit_message_caption("test")
return
async def make_assertion(*_, **kwargs):
caption = kwargs["caption"] == "new caption"
ids = self.check_passed_ids(callback_query, kwargs)
return ids and caption
assert check_shortcut_signature(
CallbackQuery.edit_message_caption,
Bot.edit_message_caption,
["inline_message_id", "message_id", "chat_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.edit_message_caption,
callback_query.get_bot(),
"edit_message_caption",
skip_params=self.skip_params(callback_query),
shortcut_kwargs=self.shortcut_kwargs(callback_query),
)
assert await check_defaults_handling(
callback_query.edit_message_caption, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "edit_message_caption", make_assertion)
assert await callback_query.edit_message_caption(caption="new caption")
assert await callback_query.edit_message_caption("new caption")
async def test_edit_message_checklist(self, monkeypatch, callback_query):
checklist = InputChecklist(title="My Checklist", tasks=[InputChecklistTask(1, "Task 1")])
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.edit_message_checklist(checklist)
return
if callback_query.inline_message_id:
pytest.skip("Can't edit inline messages")
async def make_assertion(*_, **kwargs):
chat_id = kwargs["chat_id"] == callback_query.message.chat_id
message_id = kwargs["message_id"] == callback_query.message.message_id
caption = kwargs["checklist"] == checklist
return chat_id and message_id and caption
assert check_shortcut_signature(
CallbackQuery.edit_message_checklist,
Bot.edit_message_checklist,
["chat_id", "message_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.edit_message_checklist,
callback_query.get_bot(),
"edit_message_checklist",
shortcut_kwargs=["chat_id", "message_id", "business_connection_id"],
)
assert await check_defaults_handling(
callback_query.edit_message_checklist, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "edit_message_checklist", make_assertion)
assert await callback_query.edit_message_checklist(checklist=checklist)
assert await callback_query.edit_message_checklist(checklist)
async def test_edit_message_reply_markup(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.edit_message_reply_markup("test")
return
async def make_assertion(*_, **kwargs):
reply_markup = kwargs["reply_markup"] == [["1", "2"]]
ids = self.check_passed_ids(callback_query, kwargs)
return ids and reply_markup
assert check_shortcut_signature(
CallbackQuery.edit_message_reply_markup,
Bot.edit_message_reply_markup,
["inline_message_id", "message_id", "chat_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.edit_message_reply_markup,
callback_query.get_bot(),
"edit_message_reply_markup",
skip_params=self.skip_params(callback_query),
shortcut_kwargs=self.shortcut_kwargs(callback_query),
)
assert await check_defaults_handling(
callback_query.edit_message_reply_markup, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "edit_message_reply_markup", make_assertion)
assert await callback_query.edit_message_reply_markup(reply_markup=[["1", "2"]])
assert await callback_query.edit_message_reply_markup([["1", "2"]])
async def test_edit_message_media(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.edit_message_media("test")
return
async def make_assertion(*_, **kwargs):
message_media = kwargs.get("media") == [["1", "2"]]
ids = self.check_passed_ids(callback_query, kwargs)
return ids and message_media
assert check_shortcut_signature(
CallbackQuery.edit_message_media,
Bot.edit_message_media,
["inline_message_id", "message_id", "chat_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.edit_message_media,
callback_query.get_bot(),
"edit_message_media",
skip_params=self.skip_params(callback_query),
shortcut_kwargs=self.shortcut_kwargs(callback_query),
)
assert await check_defaults_handling(
callback_query.edit_message_media, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "edit_message_media", make_assertion)
assert await callback_query.edit_message_media(media=[["1", "2"]])
assert await callback_query.edit_message_media([["1", "2"]])
async def test_edit_message_live_location(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.edit_message_live_location("test")
return
async def make_assertion(*_, **kwargs):
latitude = kwargs.get("latitude") == 1
longitude = kwargs.get("longitude") == 2
live = kwargs.get("live_period") == 900
ids = self.check_passed_ids(callback_query, kwargs)
return ids and latitude and longitude and live
assert check_shortcut_signature(
CallbackQuery.edit_message_live_location,
Bot.edit_message_live_location,
["inline_message_id", "message_id", "chat_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.edit_message_live_location,
callback_query.get_bot(),
"edit_message_live_location",
skip_params=self.skip_params(callback_query),
shortcut_kwargs=self.shortcut_kwargs(callback_query),
)
assert await check_defaults_handling(
callback_query.edit_message_live_location, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "edit_message_live_location", make_assertion)
assert await callback_query.edit_message_live_location(
latitude=1, longitude=2, live_period=900
)
assert await callback_query.edit_message_live_location(1, 2, live_period=900)
async def test_stop_message_live_location(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.stop_message_live_location("test")
return
async def make_assertion(*_, **kwargs):
return self.check_passed_ids(callback_query, kwargs)
assert check_shortcut_signature(
CallbackQuery.stop_message_live_location,
Bot.stop_message_live_location,
["inline_message_id", "message_id", "chat_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.stop_message_live_location,
callback_query.get_bot(),
"stop_message_live_location",
skip_params=self.skip_params(callback_query),
shortcut_kwargs=self.shortcut_kwargs(callback_query),
)
assert await check_defaults_handling(
callback_query.stop_message_live_location, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "stop_message_live_location", make_assertion)
assert await callback_query.stop_message_live_location()
async def test_set_game_score(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.set_game_score(user_id=1, score=2)
return
async def make_assertion(*_, **kwargs):
user_id = kwargs.get("user_id") == 1
score = kwargs.get("score") == 2
ids = self.check_passed_ids(callback_query, kwargs)
return ids and user_id and score
assert check_shortcut_signature(
CallbackQuery.set_game_score,
Bot.set_game_score,
["inline_message_id", "message_id", "chat_id"],
[],
)
assert await check_shortcut_call(
callback_query.set_game_score,
callback_query.get_bot(),
"set_game_score",
skip_params=self.skip_params(callback_query),
shortcut_kwargs=self.shortcut_kwargs(callback_query),
)
assert await check_defaults_handling(
callback_query.set_game_score, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "set_game_score", make_assertion)
assert await callback_query.set_game_score(user_id=1, score=2)
assert await callback_query.set_game_score(1, 2)
async def test_get_game_high_scores(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.get_game_high_scores("test")
return
async def make_assertion(*_, **kwargs):
user_id = kwargs.get("user_id") == 1
ids = self.check_passed_ids(callback_query, kwargs)
return ids and user_id
assert check_shortcut_signature(
CallbackQuery.get_game_high_scores,
Bot.get_game_high_scores,
["inline_message_id", "message_id", "chat_id"],
[],
)
assert await check_shortcut_call(
callback_query.get_game_high_scores,
callback_query.get_bot(),
"get_game_high_scores",
skip_params=self.skip_params(callback_query),
shortcut_kwargs=self.shortcut_kwargs(callback_query),
)
assert await check_defaults_handling(
callback_query.get_game_high_scores, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "get_game_high_scores", make_assertion)
assert await callback_query.get_game_high_scores(user_id=1)
assert await callback_query.get_game_high_scores(1)
async def test_delete_message(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.delete_message()
return
if callback_query.inline_message_id:
pytest.skip("Can't delete inline messages")
async def make_assertion(*args, **kwargs):
id_ = kwargs["chat_id"] == callback_query.message.chat_id
message = kwargs["message_id"] == callback_query.message.message_id
return id_ and message
assert check_shortcut_signature(
CallbackQuery.delete_message,
Bot.delete_message,
["message_id", "chat_id"],
[],
)
assert await check_shortcut_call(
callback_query.delete_message, callback_query.get_bot(), "delete_message"
)
assert await check_defaults_handling(
callback_query.delete_message, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "delete_message", make_assertion)
assert await callback_query.delete_message()
async def test_pin_message(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.pin_message()
return
if callback_query.inline_message_id:
pytest.skip("Can't pin inline messages")
async def make_assertion(*args, **kwargs):
return kwargs["chat_id"] == callback_query.message.chat_id
assert check_shortcut_signature(
CallbackQuery.pin_message,
Bot.pin_chat_message,
["message_id", "chat_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.pin_message,
callback_query.get_bot(),
"pin_chat_message",
["business_connection_id"],
)
assert await check_defaults_handling(callback_query.pin_message, callback_query.get_bot())
monkeypatch.setattr(callback_query.get_bot(), "pin_chat_message", make_assertion)
assert await callback_query.pin_message()
async def test_unpin_message(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.unpin_message()
return
if callback_query.inline_message_id:
pytest.skip("Can't unpin inline messages")
async def make_assertion(*args, **kwargs):
return kwargs["chat_id"] == callback_query.message.chat_id
assert check_shortcut_signature(
CallbackQuery.unpin_message,
Bot.unpin_chat_message,
["message_id", "chat_id", "business_connection_id"],
[],
)
assert await check_shortcut_call(
callback_query.unpin_message,
callback_query.get_bot(),
"unpin_chat_message",
shortcut_kwargs=["message_id"],
skip_params=["business_connection_id"],
)
assert await check_defaults_handling(
callback_query.unpin_message, callback_query.get_bot()
)
monkeypatch.setattr(callback_query.get_bot(), "unpin_chat_message", make_assertion)
assert await callback_query.unpin_message()
async def test_copy_message(self, monkeypatch, callback_query):
if isinstance(callback_query.message, InaccessibleMessage):
with pytest.raises(TypeError, match="inaccessible message"):
await callback_query.copy_message(1)
return
if callback_query.inline_message_id:
pytest.skip("Can't copy inline messages")
async def make_assertion(*args, **kwargs):
id_ = kwargs["from_chat_id"] == callback_query.message.chat_id
chat_id = kwargs["chat_id"] == 1
message = kwargs["message_id"] == callback_query.message.message_id
return id_ and message and chat_id
assert check_shortcut_signature(
CallbackQuery.copy_message,
Bot.copy_message,
["message_id", "from_chat_id"],
[],
)
assert await check_shortcut_call(
callback_query.copy_message, callback_query.get_bot(), "copy_message"
)
assert await check_defaults_handling(callback_query.copy_message, callback_query.get_bot())
monkeypatch.setattr(callback_query.get_bot(), "copy_message", make_assertion)
assert await callback_query.copy_message(1)
|