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
|
#!/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 os
from pathlib import Path
import pytest
from telegram import Bot, InputFile, PhotoSize, ReplyParameters, VideoNote, Voice
from telegram.constants import ParseMode
from telegram.error import BadRequest, TelegramError
from telegram.request import RequestData
from telegram.warnings import PTBDeprecationWarning
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
@pytest.fixture
def video_note_file():
with data_file("telegram2.mp4").open("rb") as f:
yield f
@pytest.fixture(scope="module")
async def video_note(bot, chat_id):
with data_file("telegram2.mp4").open("rb") as f:
return (await bot.send_video_note(chat_id, video_note=f, read_timeout=50)).video_note
class VideoNoteTestBase:
length = 240
duration = dtm.timedelta(seconds=3)
file_size = 132084
thumb_width = 240
thumb_height = 240
thumb_file_size = 11547
caption = "VideoNoteTest - Caption"
videonote_file_id = "5a3128a4d2a04750b5b58397f3b5e812"
videonote_file_unique_id = "adc3145fd2e84d95b64d68eaa22aa33e"
class TestVideoNoteWithoutRequest(VideoNoteTestBase):
def test_slot_behaviour(self, video_note):
for attr in video_note.__slots__:
assert getattr(video_note, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(video_note)) == len(set(mro_slots(video_note))), "duplicate slot"
def test_creation(self, video_note):
# Make sure file has been uploaded.
assert isinstance(video_note, VideoNote)
assert isinstance(video_note.file_id, str)
assert isinstance(video_note.file_unique_id, str)
assert video_note.file_id
assert video_note.file_unique_id
assert isinstance(video_note.thumbnail, PhotoSize)
assert isinstance(video_note.thumbnail.file_id, str)
assert isinstance(video_note.thumbnail.file_unique_id, str)
assert video_note.thumbnail.file_id
assert video_note.thumbnail.file_unique_id
def test_de_json(self, offline_bot):
json_dict = {
"file_id": self.videonote_file_id,
"file_unique_id": self.videonote_file_unique_id,
"length": self.length,
"duration": int(self.duration.total_seconds()),
"file_size": self.file_size,
}
json_video_note = VideoNote.de_json(json_dict, offline_bot)
assert json_video_note.api_kwargs == {}
assert json_video_note.file_id == self.videonote_file_id
assert json_video_note.file_unique_id == self.videonote_file_unique_id
assert json_video_note.length == self.length
assert json_video_note._duration == self.duration
assert json_video_note.file_size == self.file_size
def test_to_dict(self, video_note):
video_note_dict = video_note.to_dict()
assert isinstance(video_note_dict, dict)
assert video_note_dict["file_id"] == video_note.file_id
assert video_note_dict["file_unique_id"] == video_note.file_unique_id
assert video_note_dict["length"] == video_note.length
assert video_note_dict["duration"] == int(self.duration.total_seconds())
assert isinstance(video_note_dict["duration"], int)
assert video_note_dict["file_size"] == video_note.file_size
def test_time_period_properties(self, PTB_TIMEDELTA, video_note):
if PTB_TIMEDELTA:
assert video_note.duration == self.duration
assert isinstance(video_note.duration, dtm.timedelta)
else:
assert video_note.duration == int(self.duration.total_seconds())
assert isinstance(video_note.duration, int)
def test_time_period_int_deprecated(self, recwarn, PTB_TIMEDELTA, video_note):
video_note.duration
if PTB_TIMEDELTA:
assert len(recwarn) == 0
else:
assert len(recwarn) == 1
assert "`duration` will be of type `datetime.timedelta`" in str(recwarn[0].message)
assert recwarn[0].category is PTBDeprecationWarning
def test_equality(self, video_note):
a = VideoNote(video_note.file_id, video_note.file_unique_id, self.length, self.duration)
b = VideoNote("", video_note.file_unique_id, self.length, self.duration)
c = VideoNote(video_note.file_id, video_note.file_unique_id, 0, 0)
d = VideoNote("", "", self.length, self.duration)
e = Voice(video_note.file_id, video_note.file_unique_id, self.duration)
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_video_note(chat_id=chat_id)
async def test_send_with_video_note(self, monkeypatch, offline_bot, chat_id, video_note):
async def make_assertion(url, request_data: RequestData, *args, **kwargs):
return request_data.json_parameters["video_note"] == video_note.file_id
monkeypatch.setattr(offline_bot.request, "post", make_assertion)
assert await offline_bot.send_video_note(chat_id, video_note=video_note)
async def test_send_video_note_custom_filename(
self, offline_bot, chat_id, video_note_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_video_note(
chat_id, video_note_file, filename="custom_filename"
)
@pytest.mark.parametrize("local_mode", [True, False])
async def test_send_video_note_local_files(
self, monkeypatch, offline_bot, chat_id, local_mode, dummy_message_dict
):
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("video_note") == expected and data.get("thumbnail") == expected
)
else:
test_flag = isinstance(data.get("video_note"), InputFile) and isinstance(
data.get("thumbnail"), InputFile
)
return dummy_message_dict
monkeypatch.setattr(offline_bot, "_post", make_assertion)
await offline_bot.send_video_note(chat_id, file, thumbnail=file)
assert test_flag
finally:
offline_bot._local_mode = False
async def test_get_file_instance_method(self, monkeypatch, video_note):
async def make_assertion(*_, **kwargs):
return kwargs["file_id"] == video_note.file_id
assert check_shortcut_signature(VideoNote.get_file, Bot.get_file, ["file_id"], [])
assert await check_shortcut_call(video_note.get_file, video_note.get_bot(), "get_file")
assert await check_defaults_handling(video_note.get_file, video_note.get_bot())
monkeypatch.setattr(video_note.get_bot(), "get_file", make_assertion)
assert await video_note.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_video_note_default_quote_parse_mode(
self, default_bot, chat_id, video_note, 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_video_note(
chat_id, video_note, reply_parameters=ReplyParameters(**kwargs)
)
class TestVideoNoteWithRequest(VideoNoteTestBase):
@pytest.mark.parametrize("duration", [3, dtm.timedelta(seconds=3)])
async def test_send_all_args(
self, bot, chat_id, video_note_file, video_note, thumb_file, duration
):
message = await bot.send_video_note(
chat_id,
video_note_file,
duration=duration,
length=self.length,
disable_notification=False,
protect_content=True,
thumbnail=thumb_file,
)
assert isinstance(message.video_note, VideoNote)
assert isinstance(message.video_note.file_id, str)
assert isinstance(message.video_note.file_unique_id, str)
assert message.video_note.file_id
assert message.video_note.file_unique_id
assert message.video_note.length == video_note.length
assert message.video_note.duration == video_note.duration
assert message.video_note.file_size == video_note.file_size
assert message.video_note.thumbnail.file_size == self.thumb_file_size
assert message.video_note.thumbnail.width == self.thumb_width
assert message.video_note.thumbnail.height == self.thumb_height
assert message.has_protected_content
async def test_get_and_download(self, bot, video_note, tmp_file):
new_file = await bot.get_file(video_note.file_id)
assert new_file.file_size == self.file_size
assert new_file.file_unique_id == video_note.file_unique_id
assert new_file.file_path.startswith("https://")
await new_file.download_to_drive(tmp_file)
assert tmp_file.is_file()
async def test_resend(self, bot, chat_id, video_note):
message = await bot.send_video_note(chat_id, video_note.file_id)
assert message.video_note == video_note
@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_video_note_default_allow_sending_without_reply(
self, default_bot, chat_id, video_note, 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_video_note(
chat_id,
video_note,
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_video_note(
chat_id, video_note, 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_video_note(
chat_id, video_note, reply_to_message_id=reply_to_message.message_id
)
@pytest.mark.parametrize("default_bot", [{"protect_content": True}], indirect=True)
async def test_send_video_note_default_protect_content(self, chat_id, default_bot, video_note):
tasks = asyncio.gather(
default_bot.send_video_note(chat_id, video_note),
default_bot.send_video_note(chat_id, video_note, protect_content=False),
)
protected, unprotected = await tasks
assert protected.has_protected_content
assert not unprotected.has_protected_content
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_video_note(chat_id, file)
async def test_error_send_empty_file_id(self, bot, chat_id):
with pytest.raises(TelegramError):
await bot.send_video_note(chat_id, "")
|