#!/usr/bin/env python # # A library that provides a Python interface to the Telegram Bot API # Copyright (C) 2015-2024 # Leandro Toledo de Souza # # 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 from typing import Sequence import pytest from telegram import InputFile, InputMediaPhoto, InputMediaVideo, InputSticker, 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}), (datetime.datetime(2019, 11, 11, 0, 26, 16, 10**5), 1573431976), ( [ True, "str", MessageEntity("type", 1, 1), ChatType.PRIVATE, datetime.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 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_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_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