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
|
#!/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 inspect
from copy import deepcopy
import pytest
from telegram import (
Chat,
Dice,
MessageOrigin,
MessageOriginChannel,
MessageOriginChat,
MessageOriginHiddenUser,
MessageOriginUser,
User,
)
from telegram._utils.datetime import UTC, to_timestamp
from tests.auxil.slots import mro_slots
ignored = ["self", "api_kwargs"]
class MODefaults:
date: dtm.datetime = to_timestamp(dtm.datetime.utcnow())
chat = Chat(1, Chat.CHANNEL)
message_id = 123
author_signautre = "PTB"
sender_chat = Chat(1, Chat.CHANNEL)
sender_user_name = "PTB"
sender_user = User(1, "user", False)
def message_origin_channel():
return MessageOriginChannel(
MODefaults.date, MODefaults.chat, MODefaults.message_id, MODefaults.author_signautre
)
def message_origin_chat():
return MessageOriginChat(
MODefaults.date,
MODefaults.sender_chat,
MODefaults.author_signautre,
)
def message_origin_hidden_user():
return MessageOriginHiddenUser(MODefaults.date, MODefaults.sender_user_name)
def message_origin_user():
return MessageOriginUser(MODefaults.date, MODefaults.sender_user)
def make_json_dict(instance: MessageOrigin, include_optional_args: bool = False) -> dict:
"""Used to make the json dict which we use for testing de_json. Similar to iter_args()"""
json_dict = {"type": instance.type}
sig = inspect.signature(instance.__class__.__init__)
for param in sig.parameters.values():
if param.name in ignored: # ignore irrelevant params
continue
val = getattr(instance, param.name)
# Compulsory args-
if param.default is inspect.Parameter.empty:
if hasattr(val, "to_dict"): # convert the user object or any future ones to dict.
val = val.to_dict()
json_dict[param.name] = val
# If we want to test all args (for de_json)-
elif param.default is not inspect.Parameter.empty and include_optional_args:
json_dict[param.name] = val
return json_dict
def iter_args(
instance: MessageOrigin, de_json_inst: MessageOrigin, include_optional: bool = False
):
"""
We accept both the regular instance and de_json created instance and iterate over them for
easy one line testing later one.
"""
yield instance.type, de_json_inst.type # yield this here cause it's not available in sig.
sig = inspect.signature(instance.__class__.__init__)
for param in sig.parameters.values():
if param.name in ignored:
continue
inst_at, json_at = getattr(instance, param.name), getattr(de_json_inst, param.name)
if isinstance(json_at, dtm.datetime): # Convert datetime to int
json_at = to_timestamp(json_at)
if (
param.default is not inspect.Parameter.empty and include_optional
) or param.default is inspect.Parameter.empty:
yield inst_at, json_at
@pytest.fixture
def message_origin_type(request):
return request.param()
@pytest.mark.parametrize(
"message_origin_type",
[
message_origin_channel,
message_origin_chat,
message_origin_hidden_user,
message_origin_user,
],
indirect=True,
)
class TestMessageOriginTypesWithoutRequest:
def test_slot_behaviour(self, message_origin_type):
inst = message_origin_type
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_de_json_required_args(self, offline_bot, message_origin_type):
cls = message_origin_type.__class__
json_dict = make_json_dict(message_origin_type)
const_message_origin = MessageOrigin.de_json(json_dict, offline_bot)
assert const_message_origin.api_kwargs == {}
assert isinstance(const_message_origin, MessageOrigin)
assert isinstance(const_message_origin, cls)
for msg_origin_type_at, const_msg_origin_at in iter_args(
message_origin_type, const_message_origin
):
assert msg_origin_type_at == const_msg_origin_at
def test_de_json_all_args(self, offline_bot, message_origin_type):
json_dict = make_json_dict(message_origin_type, include_optional_args=True)
const_message_origin = MessageOrigin.de_json(json_dict, offline_bot)
assert const_message_origin.api_kwargs == {}
assert isinstance(const_message_origin, MessageOrigin)
assert isinstance(const_message_origin, message_origin_type.__class__)
for msg_origin_type_at, const_msg_origin_at in iter_args(
message_origin_type, const_message_origin, True
):
assert msg_origin_type_at == const_msg_origin_at
def test_de_json_messageorigin_localization(
self, message_origin_type, tz_bot, offline_bot, raw_bot
):
json_dict = make_json_dict(message_origin_type, include_optional_args=True)
msgorigin_raw = MessageOrigin.de_json(json_dict, raw_bot)
msgorigin_bot = MessageOrigin.de_json(json_dict, offline_bot)
msgorigin_tz = MessageOrigin.de_json(json_dict, tz_bot)
# comparing utcoffsets because comparing timezones is unpredicatable
msgorigin_offset = msgorigin_tz.date.utcoffset()
tz_bot_offset = tz_bot.defaults.tzinfo.utcoffset(msgorigin_tz.date.replace(tzinfo=None))
assert msgorigin_raw.date.tzinfo == UTC
assert msgorigin_bot.date.tzinfo == UTC
assert msgorigin_offset == tz_bot_offset
def test_de_json_invalid_type(self, message_origin_type, offline_bot):
json_dict = {"type": "invalid", "date": MODefaults.date}
message_origin_type = MessageOrigin.de_json(json_dict, offline_bot)
assert type(message_origin_type) is MessageOrigin
assert message_origin_type.type == "invalid"
def test_de_json_subclass(self, message_origin_type, offline_bot, chat_id):
"""This makes sure that e.g. MessageOriginChat(data, offline_bot) never returns a
MessageOriginUser instance."""
cls = message_origin_type.__class__
json_dict = make_json_dict(message_origin_type, True)
assert type(cls.de_json(json_dict, offline_bot)) is cls
def test_to_dict(self, message_origin_type):
message_origin_dict = message_origin_type.to_dict()
assert isinstance(message_origin_dict, dict)
assert message_origin_dict["type"] == message_origin_type.type
assert message_origin_dict["date"] == message_origin_type.date
for slot in message_origin_type.__slots__: # additional verification for the optional args
if slot in ("chat", "sender_chat", "sender_user"):
assert (getattr(message_origin_type, slot)).to_dict() == message_origin_dict[slot]
continue
assert getattr(message_origin_type, slot) == message_origin_dict[slot]
def test_equality(self, message_origin_type):
a = MessageOrigin(type="type", date=MODefaults.date)
b = MessageOrigin(type="type", date=MODefaults.date)
c = message_origin_type
d = deepcopy(message_origin_type)
e = Dice(4, "emoji")
assert a == b
assert hash(a) == hash(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)
assert c == d
assert hash(c) == hash(d)
assert c != e
assert hash(c) != hash(e)
|