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
|
#!/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 os
from io import BytesIO
from pathlib import Path
import pytest
from telegram import Bot, InputFile, MessageEntity, PhotoSize, ReplyParameters, Sticker
from telegram.constants import ParseMode
from telegram.error import BadRequest, TelegramError
from telegram.helpers import escape_markdown
from telegram.request import RequestData
from tests.auxil.bot_method_checks import (
check_defaults_handling,
check_shortcut_call,
check_shortcut_signature,
)
from tests.auxil.build_messages import make_message
from tests.auxil.files import data_file
from tests.auxil.slots import mro_slots
class PhotoTestBase:
width = 800
height = 800
caption = "<b>PhotoTest</b> - *Caption*"
photo_file_url = "https://python-telegram-bot.org/static/testfiles/telegram_new.jpg"
# For some reason the file size is not the same after switching to httpx
# so we accept three different sizes here. Shouldn't be too much
file_size = [29176, 27662]
class TestPhotoWithoutRequest(PhotoTestBase):
def test_slot_behaviour(self, photo):
for attr in photo.__slots__:
assert getattr(photo, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(photo)) == len(set(mro_slots(photo))), "duplicate slot"
def test_creation(self, thumb, photo):
# Make sure file has been uploaded.
assert isinstance(photo, PhotoSize)
assert isinstance(photo.file_id, str)
assert isinstance(photo.file_unique_id, str)
assert photo.file_id
assert photo.file_unique_id
assert isinstance(thumb, PhotoSize)
assert isinstance(thumb.file_id, str)
assert isinstance(thumb.file_unique_id, str)
assert thumb.file_id
assert thumb.file_unique_id
def test_expected_values(self, photo, thumb):
assert photo.width == self.width
assert photo.height == self.height
assert photo.file_size in self.file_size
assert thumb.width == 90
assert thumb.height == 90
# File sizes don't seem to be consistent, so we use the values that we have observed
# so far
assert thumb.file_size in [1475, 1477]
def test_de_json(self, offline_bot, photo):
json_dict = {
"file_id": photo.file_id,
"file_unique_id": photo.file_unique_id,
"width": self.width,
"height": self.height,
"file_size": self.file_size,
}
json_photo = PhotoSize.de_json(json_dict, offline_bot)
assert json_photo.api_kwargs == {}
assert json_photo.file_id == photo.file_id
assert json_photo.file_unique_id == photo.file_unique_id
assert json_photo.width == self.width
assert json_photo.height == self.height
assert json_photo.file_size == self.file_size
def test_to_dict(self, photo):
photo_dict = photo.to_dict()
assert isinstance(photo_dict, dict)
assert photo_dict["file_id"] == photo.file_id
assert photo_dict["file_unique_id"] == photo.file_unique_id
assert photo_dict["width"] == photo.width
assert photo_dict["height"] == photo.height
assert photo_dict["file_size"] == photo.file_size
def test_equality(self, photo):
a = PhotoSize(photo.file_id, photo.file_unique_id, self.width, self.height)
b = PhotoSize("", photo.file_unique_id, self.width, self.height)
c = PhotoSize(photo.file_id, photo.file_unique_id, 0, 0)
d = PhotoSize("", "", self.width, self.height)
e = Sticker(
photo.file_id,
photo.file_unique_id,
self.width,
self.height,
False,
False,
Sticker.REGULAR,
)
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_error_without_required_args(self, offline_bot, chat_id):
with pytest.raises(TypeError):
await offline_bot.send_photo(chat_id=chat_id)
async def test_send_photo_custom_filename(self, offline_bot, chat_id, photo_file, monkeypatch):
async def make_assertion(url, request_data: RequestData, *args, **kwargs):
return next(iter(request_data.multipart_data.values()))[0] == "custom_filename"
monkeypatch.setattr(offline_bot.request, "post", make_assertion)
assert await offline_bot.send_photo(chat_id, photo_file, filename="custom_filename")
@pytest.mark.parametrize("local_mode", [True, False])
async def test_send_photo_local_files(
self, dummy_message_dict, monkeypatch, offline_bot, chat_id, local_mode
):
try:
offline_bot._local_mode = local_mode
# For just test that the correct paths are passed as we have no local Bot API set up
test_flag = False
file = data_file("telegram.jpg")
expected = file.as_uri()
async def make_assertion(_, data, *args, **kwargs):
nonlocal test_flag
if local_mode:
test_flag = data.get("photo") == expected
else:
test_flag = isinstance(data.get("photo"), InputFile)
return dummy_message_dict
monkeypatch.setattr(offline_bot, "_post", make_assertion)
await offline_bot.send_photo(chat_id, file)
assert test_flag
finally:
offline_bot._local_mode = False
async def test_send_with_photosize(self, monkeypatch, offline_bot, chat_id, photo):
async def make_assertion(url, request_data: RequestData, *args, **kwargs):
return request_data.json_parameters["photo"] == photo.file_id
monkeypatch.setattr(offline_bot.request, "post", make_assertion)
assert await offline_bot.send_photo(photo=photo, chat_id=chat_id)
async def test_get_file_instance_method(self, monkeypatch, photo):
async def make_assertion(*_, **kwargs):
return kwargs["file_id"] == photo.file_id
assert check_shortcut_signature(PhotoSize.get_file, Bot.get_file, ["file_id"], [])
assert await check_shortcut_call(photo.get_file, photo.get_bot(), "get_file")
assert await check_defaults_handling(photo.get_file, photo.get_bot())
monkeypatch.setattr(photo.get_bot(), "get_file", make_assertion)
assert await photo.get_file()
@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_photo_default_quote_parse_mode(
self, default_bot, chat_id, photo, 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_photo(chat_id, photo, reply_parameters=ReplyParameters(**kwargs))
class TestPhotoWithRequest(PhotoTestBase):
async def test_send_photo_all_args(self, bot, chat_id, photo_file):
message = await bot.send_photo(
chat_id,
photo_file,
caption=self.caption,
disable_notification=False,
protect_content=True,
parse_mode="Markdown",
has_spoiler=True,
show_caption_above_media=True,
)
assert isinstance(message.photo[-2], PhotoSize)
assert isinstance(message.photo[-2].file_id, str)
assert isinstance(message.photo[-2].file_unique_id, str)
assert message.photo[-2].file_id
assert message.photo[-2].file_unique_id
assert isinstance(message.photo[-1], PhotoSize)
assert isinstance(message.photo[-1].file_id, str)
assert isinstance(message.photo[-1].file_unique_id, str)
assert message.photo[-1].file_id
assert message.photo[-1].file_unique_id
assert message.caption == self.caption.replace("*", "")
assert message.has_protected_content
assert message.has_media_spoiler
assert message.show_caption_above_media
async def test_send_photo_parse_mode_markdown(self, bot, chat_id, photo_file):
message = await bot.send_photo(
chat_id, photo_file, caption=self.caption, parse_mode="Markdown"
)
assert isinstance(message.photo[-2], PhotoSize)
assert isinstance(message.photo[-2].file_id, str)
assert isinstance(message.photo[-2].file_unique_id, str)
assert message.photo[-2].file_id
assert message.photo[-2].file_unique_id
assert isinstance(message.photo[-1], PhotoSize)
assert isinstance(message.photo[-1].file_id, str)
assert isinstance(message.photo[-1].file_unique_id, str)
assert message.photo[-1].file_id
assert message.photo[-1].file_unique_id
assert message.caption == self.caption.replace("*", "")
assert len(message.caption_entities) == 1
async def test_send_photo_parse_mode_html(self, bot, chat_id, photo_file):
message = await bot.send_photo(
chat_id, photo_file, caption=self.caption, parse_mode="HTML"
)
assert isinstance(message.photo[-2], PhotoSize)
assert isinstance(message.photo[-2].file_id, str)
assert isinstance(message.photo[-2].file_unique_id, str)
assert message.photo[-2].file_id
assert message.photo[-2].file_unique_id
assert isinstance(message.photo[-1], PhotoSize)
assert isinstance(message.photo[-1].file_id, str)
assert isinstance(message.photo[-1].file_unique_id, str)
assert message.photo[-1].file_id
assert message.photo[-1].file_unique_id
assert message.caption == self.caption.replace("<b>", "").replace("</b>", "")
assert len(message.caption_entities) == 1
async def test_send_photo_caption_entities(self, bot, chat_id, photo_file):
test_string = "Italic Bold Code"
entities = [
MessageEntity(MessageEntity.ITALIC, 0, 6),
MessageEntity(MessageEntity.ITALIC, 7, 4),
MessageEntity(MessageEntity.ITALIC, 12, 4),
]
message = await bot.send_photo(
chat_id, photo_file, caption=test_string, caption_entities=entities
)
assert message.caption == test_string
assert message.caption_entities == tuple(entities)
@pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True)
async def test_send_photo_default_parse_mode_1(self, default_bot, chat_id, photo_file):
test_string = "Italic Bold Code"
test_markdown_string = "_Italic_ *Bold* `Code`"
message = await default_bot.send_photo(chat_id, photo_file, caption=test_markdown_string)
assert message.caption_markdown == test_markdown_string
assert message.caption == test_string
@pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True)
async def test_send_photo_default_parse_mode_2(self, default_bot, chat_id, photo_file):
test_markdown_string = "_Italic_ *Bold* `Code`"
message = await default_bot.send_photo(
chat_id, photo_file, caption=test_markdown_string, parse_mode=None
)
assert message.caption == test_markdown_string
assert message.caption_markdown == escape_markdown(test_markdown_string)
@pytest.mark.parametrize("default_bot", [{"parse_mode": "Markdown"}], indirect=True)
async def test_send_photo_default_parse_mode_3(self, default_bot, chat_id, photo_file):
test_markdown_string = "_Italic_ *Bold* `Code`"
message = await default_bot.send_photo(
chat_id, photo_file, caption=test_markdown_string, parse_mode="HTML"
)
assert message.caption == test_markdown_string
assert message.caption_markdown == escape_markdown(test_markdown_string)
@pytest.mark.parametrize("default_bot", [{"protect_content": True}], indirect=True)
async def test_send_photo_default_protect_content(self, chat_id, default_bot, photo):
tasks = asyncio.gather(
default_bot.send_photo(chat_id, photo),
default_bot.send_photo(chat_id, photo, protect_content=False),
)
protected, unprotected = await tasks
assert protected.has_protected_content
assert not unprotected.has_protected_content
@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_photo_default_allow_sending_without_reply(
self, default_bot, chat_id, photo_file, 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_photo(
chat_id,
photo_file,
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_photo(
chat_id, photo_file, 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_photo(
chat_id, photo_file, reply_to_message_id=reply_to_message.message_id
)
async def test_get_and_download(self, bot, photo, tmp_file):
new_file = await bot.getFile(photo.file_id)
assert new_file.file_size == photo.file_size
assert new_file.file_unique_id == photo.file_unique_id
assert new_file.file_path.startswith("https://") is True
await new_file.download_to_drive(tmp_file)
assert tmp_file.is_file()
async def test_send_url_jpg_file(self, bot, chat_id):
message = await bot.send_photo(chat_id, photo=self.photo_file_url)
assert isinstance(message.photo[-2], PhotoSize)
assert isinstance(message.photo[-2].file_id, str)
assert isinstance(message.photo[-2].file_unique_id, str)
assert message.photo[-2].file_id
assert message.photo[-2].file_unique_id
assert isinstance(message.photo[-1], PhotoSize)
assert isinstance(message.photo[-1].file_id, str)
assert isinstance(message.photo[-1].file_unique_id, str)
assert message.photo[-1].file_id
assert message.photo[-1].file_unique_id
async def test_send_url_png_file(self, bot, chat_id):
message = await bot.send_photo(
photo="http://dummyimage.com/600x400/000/fff.png&text=telegram", chat_id=chat_id
)
photo = message.photo[-1]
assert isinstance(photo, PhotoSize)
assert isinstance(photo.file_id, str)
assert isinstance(photo.file_unique_id, str)
assert photo.file_id
assert photo.file_unique_id
async def test_send_file_unicode_filename(self, bot, chat_id):
"""
Regression test for https://github.com/python-telegram-bot/python-telegram-bot/issues/1202
"""
with data_file("测试.png").open("rb") as f:
message = await bot.send_photo(photo=f, chat_id=chat_id)
photo = message.photo[-1]
assert isinstance(photo, PhotoSize)
assert isinstance(photo.file_id, str)
assert isinstance(photo.file_unique_id, str)
assert photo.file_id
assert photo.file_unique_id
async def test_send_bytesio_jpg_file(self, bot, chat_id):
filepath = data_file("telegram_no_standard_header.jpg")
# raw image bytes
raw_bytes = BytesIO(filepath.read_bytes())
input_file = InputFile(raw_bytes)
assert input_file.mimetype == "application/octet-stream"
# raw image bytes with name info
raw_bytes = BytesIO(filepath.read_bytes())
raw_bytes.name = str(filepath)
input_file = InputFile(raw_bytes)
assert input_file.mimetype == "image/jpeg"
# send raw photo
raw_bytes = BytesIO(filepath.read_bytes())
message = await bot.send_photo(chat_id, photo=raw_bytes)
photo = message.photo[-1]
assert isinstance(photo.file_id, str)
assert isinstance(photo.file_unique_id, str)
assert photo.file_id
assert photo.file_unique_id
assert isinstance(photo, PhotoSize)
assert photo.width == 1280
assert photo.height == 720
assert photo.file_size == 33372
async def test_resend(self, bot, chat_id, photo):
message = await bot.send_photo(chat_id=chat_id, photo=photo.file_id)
assert isinstance(message.photo[-2], PhotoSize)
assert isinstance(message.photo[-2].file_id, str)
assert isinstance(message.photo[-2].file_unique_id, str)
assert message.photo[-2].file_id
assert message.photo[-2].file_unique_id
assert isinstance(message.photo[-1], PhotoSize)
assert isinstance(message.photo[-1].file_id, str)
assert isinstance(message.photo[-1].file_unique_id, str)
assert message.photo[-1].file_id
assert message.photo[-1].file_unique_id
async def test_error_send_empty_file(self, bot, chat_id):
with Path(os.devnull).open("rb") as file, pytest.raises(TelegramError):
await bot.send_photo(chat_id=chat_id, photo=file)
async def test_error_send_empty_file_id(self, bot, chat_id):
with pytest.raises(TelegramError):
await bot.send_photo(chat_id=chat_id, photo="")
|