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
|
#!/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
from collections.abc import Sequence
import pytest
from telegram import (
InputFile,
InputMediaPhoto,
InputMediaVideo,
InputProfilePhotoAnimated,
InputProfilePhotoStatic,
InputSticker,
InputStoryContentPhoto,
InputStoryContentVideo,
MessageEntity,
)
from telegram.constants import ChatType
from telegram.request._requestparameter import RequestParameter
from tests.auxil.files import data_file
from tests.auxil.slots import mro_slots
class TestRequestParameterWithoutRequest:
def test_slot_behaviour(self):
inst = RequestParameter("name", "value", [1, 2])
for attr in inst.__slots__:
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
def test_init(self):
request_parameter = RequestParameter("name", "value", [1, 2])
assert request_parameter.name == "name"
assert request_parameter.value == "value"
assert request_parameter.input_files == [1, 2]
request_parameter = RequestParameter("name", "value", None)
assert request_parameter.name == "name"
assert request_parameter.value == "value"
assert request_parameter.input_files is None
@pytest.mark.parametrize(
("value", "expected"),
[
(1, "1"),
("one", "one"),
(True, "true"),
(None, None),
([1, "1"], '[1, "1"]'),
({True: None}, '{"true": null}'),
((1,), "[1]"),
],
)
def test_json_value(self, value, expected):
request_parameter = RequestParameter("name", value, None)
assert request_parameter.json_value == expected
def test_multiple_multipart_data(self):
assert RequestParameter("name", "value", []).multipart_data is None
input_file_1 = InputFile("data1", attach=True)
input_file_2 = InputFile("data2", filename="custom")
request_parameter = RequestParameter(
value="value", name="name", input_files=[input_file_1, input_file_2]
)
files = request_parameter.multipart_data
assert files[input_file_1.attach_name] == input_file_1.field_tuple
assert files["name"] == input_file_2.field_tuple
@pytest.mark.parametrize(
("value", "expected_value"),
[
(True, True),
("str", "str"),
({1: 1.0}, {1: 1.0}),
(ChatType.PRIVATE, "private"),
(MessageEntity("type", 1, 1), {"type": "type", "offset": 1, "length": 1}),
(dtm.datetime(2019, 11, 11, 0, 26, 16, 10**5), 1573431976),
(dtm.timedelta(days=42), 42 * 24 * 60 * 60),
(
[
True,
"str",
MessageEntity("type", 1, 1),
ChatType.PRIVATE,
dtm.datetime(2019, 11, 11, 0, 26, 16, 10**5),
],
[True, "str", {"type": "type", "offset": 1, "length": 1}, "private", 1573431976],
),
],
)
def test_from_input_no_media(self, value, expected_value):
request_parameter = RequestParameter.from_input("key", value)
assert request_parameter.value == expected_value
assert request_parameter.input_files is None
@pytest.mark.parametrize(
("value", "expected_type", "expected_value"),
[
(dtm.timedelta(seconds=1), int, 1),
(dtm.timedelta(milliseconds=1), float, 0.001),
],
)
def test_from_input_timedelta(self, value, expected_type, expected_value):
request_parameter = RequestParameter.from_input("key", value)
assert request_parameter.value == expected_value
assert request_parameter.input_files is None
assert isinstance(request_parameter.value, expected_type)
def test_from_input_inputfile(self):
inputfile_1 = InputFile("data1", filename="inputfile_1", attach=True)
inputfile_2 = InputFile("data2", filename="inputfile_2")
request_parameter = RequestParameter.from_input("key", inputfile_1)
assert request_parameter.value == inputfile_1.attach_uri
assert request_parameter.input_files == [inputfile_1]
request_parameter = RequestParameter.from_input("key", inputfile_2)
assert request_parameter.value is None
assert request_parameter.input_files == [inputfile_2]
request_parameter = RequestParameter.from_input("key", [inputfile_1, inputfile_2])
assert request_parameter.value == [inputfile_1.attach_uri]
assert request_parameter.input_files == [inputfile_1, inputfile_2]
def test_from_input_input_media(self):
input_media_no_thumb = InputMediaPhoto(media=data_file("telegram.jpg").read_bytes())
input_media_thumb = InputMediaVideo(
media=data_file("telegram.mp4").read_bytes(),
thumbnail=data_file("telegram.jpg").read_bytes(),
)
request_parameter = RequestParameter.from_input("key", input_media_no_thumb)
expected_no_thumb = input_media_no_thumb.to_dict()
expected_no_thumb.update({"media": input_media_no_thumb.media.attach_uri})
assert request_parameter.value == expected_no_thumb
assert request_parameter.input_files == [input_media_no_thumb.media]
request_parameter = RequestParameter.from_input("key", input_media_thumb)
expected_thumb = input_media_thumb.to_dict()
expected_thumb.update({"media": input_media_thumb.media.attach_uri})
expected_thumb.update({"thumbnail": input_media_thumb.thumbnail.attach_uri})
assert request_parameter.value == expected_thumb
assert request_parameter.input_files == [
input_media_thumb.media,
input_media_thumb.thumbnail,
]
request_parameter = RequestParameter.from_input(
"key", [input_media_thumb, input_media_no_thumb]
)
assert request_parameter.value == [expected_thumb, expected_no_thumb]
assert request_parameter.input_files == [
input_media_thumb.media,
input_media_thumb.thumbnail,
input_media_no_thumb.media,
]
def test_from_input_inputmedia_without_attach(self):
"""This case will never happen, but we test it for completeness"""
input_media = InputMediaVideo(
data_file("telegram.png").read_bytes(),
thumbnail=data_file("telegram.png").read_bytes(),
parse_mode=None,
)
input_media.media.attach_name = None
input_media.thumbnail.attach_name = None
request_parameter = RequestParameter.from_input("key", input_media)
assert request_parameter.value == {"type": "video"}
assert request_parameter.input_files == [input_media.media, input_media.thumbnail]
def test_from_input_profile_photo_static(self):
input_profile_photo = InputProfilePhotoStatic(data_file("telegram.jpg").read_bytes())
expected = input_profile_photo.to_dict()
expected.update({"photo": input_profile_photo.photo.attach_uri})
request_parameter = RequestParameter.from_input("key", input_profile_photo)
assert request_parameter.value == expected
assert request_parameter.input_files == [input_profile_photo.photo]
def test_from_input_profile_photo_animated(self):
input_profile_photo = InputProfilePhotoAnimated(
data_file("telegram2.mp4").read_bytes(),
main_frame_timestamp=dtm.timedelta(seconds=42, milliseconds=43),
)
expected = input_profile_photo.to_dict()
expected.update({"animation": input_profile_photo.animation.attach_uri})
request_parameter = RequestParameter.from_input("key", input_profile_photo)
assert request_parameter.value == expected
assert request_parameter.input_files == [input_profile_photo.animation]
@pytest.mark.parametrize(
("cls", "args"),
[
(InputProfilePhotoStatic, (data_file("telegram.jpg"),)),
(
InputProfilePhotoAnimated,
(data_file("telegram2.mp4"), dtm.timedelta(seconds=42, milliseconds=43)),
),
],
)
def test_from_input_profile_photo_local_files(self, cls, args):
input_profile_photo = cls(*args)
expected = input_profile_photo.to_dict()
requested = RequestParameter.from_input("key", input_profile_photo)
assert requested.value == expected
assert requested.input_files is None
def test_from_input_inputsticker(self):
input_sticker = InputSticker(data_file("telegram.png").read_bytes(), ["emoji"], "static")
expected = input_sticker.to_dict()
expected.update({"sticker": input_sticker.sticker.attach_uri})
request_parameter = RequestParameter.from_input("key", input_sticker)
assert request_parameter.value == expected
assert request_parameter.input_files == [input_sticker.sticker]
def test_from_input_story_content_photo(self):
input_story_content_photo = InputStoryContentPhoto(data_file("telegram.jpg").read_bytes())
expected = input_story_content_photo.to_dict()
expected.update({"photo": input_story_content_photo.photo.attach_uri})
request_parameter = RequestParameter.from_input("key", input_story_content_photo)
assert request_parameter.value == expected
assert request_parameter.input_files == [input_story_content_photo.photo]
def test_from_input_story_content_video(self):
input_story_content_video = InputStoryContentVideo(data_file("telegram2.mp4").read_bytes())
expected = input_story_content_video.to_dict()
expected.update({"video": input_story_content_video.video.attach_uri})
request_parameter = RequestParameter.from_input("key", input_story_content_video)
assert request_parameter.value == expected
assert request_parameter.input_files == [input_story_content_video.video]
@pytest.mark.parametrize(
("cls", "arg"),
[
(InputStoryContentPhoto, data_file("telegram.jpg")),
(InputStoryContentVideo, data_file("telegram2.mp4")),
],
)
def test_from_input_story_content_local_files(self, cls, arg):
input_story_content = cls(arg)
expected = input_story_content.to_dict()
requested = RequestParameter.from_input("key", input_story_content)
assert requested.value == expected
assert requested.input_files is None
def test_from_input_str_and_bytes(self):
input_str = "test_input"
request_parameter = RequestParameter.from_input("input", input_str)
assert request_parameter.value == input_str
assert request_parameter.name == "input"
assert request_parameter.input_files is None
input_bytes = b"test_input"
request_parameter = RequestParameter.from_input("input", input_bytes)
assert request_parameter.value == input_bytes
assert request_parameter.name == "input"
assert request_parameter.input_files is None
def test_from_input_different_sequences(self):
input_list = ["item1", "item2"]
request_parameter = RequestParameter.from_input("input", input_list)
assert request_parameter.value == input_list
assert request_parameter.name == "input"
assert request_parameter.input_files is None
input_tuple = tuple(input_list)
request_parameter = RequestParameter.from_input("input", input_tuple)
assert request_parameter.value == input_list
assert request_parameter.name == "input"
assert request_parameter.input_files is None
class CustomSequence(Sequence):
def __init__(self, items):
self.items = items
def __getitem__(self, index):
return self.items[index]
def __len__(self):
return len(self.items)
input_custom_sequence = CustomSequence(input_list)
request_parameter = RequestParameter.from_input("input", input_custom_sequence)
assert request_parameter.value == input_list
assert request_parameter.name == "input"
assert request_parameter.input_files is None
|