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
|
#!/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
import pytest
from telegram import (
Chat,
ChatInviteLink,
ChatMember,
ChatMemberAdministrator,
ChatMemberBanned,
ChatMemberOwner,
ChatMemberUpdated,
User,
)
from telegram._utils.datetime import UTC, to_timestamp
from tests.auxil.slots import mro_slots
@pytest.fixture(scope="module")
def user():
return User(1, "First name", False)
@pytest.fixture(scope="module")
def chat():
return Chat(1, Chat.SUPERGROUP, "Chat")
@pytest.fixture(scope="module")
def old_chat_member(user):
return ChatMember(user, ChatMemberUpdatedTestBase.old_status)
@pytest.fixture(scope="module")
def new_chat_member(user):
return ChatMemberAdministrator(
user,
True,
True,
True,
True,
True,
True,
True,
True,
True,
True,
True,
True,
custom_title=ChatMemberUpdatedTestBase.new_status,
)
@pytest.fixture(scope="module")
def time():
return dtm.datetime.now(tz=UTC)
@pytest.fixture(scope="module")
def invite_link(user):
return ChatInviteLink("link", user, False, True, True)
@pytest.fixture(scope="module")
def chat_member_updated(user, chat, old_chat_member, new_chat_member, invite_link, time):
return ChatMemberUpdated(
chat, user, time, old_chat_member, new_chat_member, invite_link, True, True
)
class ChatMemberUpdatedTestBase:
old_status = ChatMember.MEMBER
new_status = ChatMember.ADMINISTRATOR
class TestChatMemberUpdatedWithoutRequest(ChatMemberUpdatedTestBase):
def test_slot_behaviour(self, chat_member_updated):
action = chat_member_updated
for attr in action.__slots__:
assert getattr(action, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(action)) == len(set(mro_slots(action))), "duplicate slot"
def test_de_json_required_args(
self, offline_bot, user, chat, old_chat_member, new_chat_member, time
):
json_dict = {
"chat": chat.to_dict(),
"from": user.to_dict(),
"date": to_timestamp(time),
"old_chat_member": old_chat_member.to_dict(),
"new_chat_member": new_chat_member.to_dict(),
}
chat_member_updated = ChatMemberUpdated.de_json(json_dict, offline_bot)
assert chat_member_updated.api_kwargs == {}
assert chat_member_updated.chat == chat
assert chat_member_updated.from_user == user
assert abs(chat_member_updated.date - time) < dtm.timedelta(seconds=1)
assert to_timestamp(chat_member_updated.date) == to_timestamp(time)
assert chat_member_updated.old_chat_member == old_chat_member
assert chat_member_updated.new_chat_member == new_chat_member
assert chat_member_updated.invite_link is None
assert chat_member_updated.via_chat_folder_invite_link is None
def test_de_json_all_args(
self, offline_bot, user, time, invite_link, chat, old_chat_member, new_chat_member
):
json_dict = {
"chat": chat.to_dict(),
"from": user.to_dict(),
"date": to_timestamp(time),
"old_chat_member": old_chat_member.to_dict(),
"new_chat_member": new_chat_member.to_dict(),
"invite_link": invite_link.to_dict(),
"via_chat_folder_invite_link": True,
"via_join_request": True,
}
chat_member_updated = ChatMemberUpdated.de_json(json_dict, offline_bot)
assert chat_member_updated.api_kwargs == {}
assert chat_member_updated.chat == chat
assert chat_member_updated.from_user == user
assert abs(chat_member_updated.date - time) < dtm.timedelta(seconds=1)
assert to_timestamp(chat_member_updated.date) == to_timestamp(time)
assert chat_member_updated.old_chat_member == old_chat_member
assert chat_member_updated.new_chat_member == new_chat_member
assert chat_member_updated.invite_link == invite_link
assert chat_member_updated.via_chat_folder_invite_link is True
assert chat_member_updated.via_join_request is True
def test_de_json_localization(
self,
offline_bot,
raw_bot,
tz_bot,
user,
chat,
old_chat_member,
new_chat_member,
time,
invite_link,
):
json_dict = {
"chat": chat.to_dict(),
"from": user.to_dict(),
"date": to_timestamp(time),
"old_chat_member": old_chat_member.to_dict(),
"new_chat_member": new_chat_member.to_dict(),
"invite_link": invite_link.to_dict(),
}
chat_member_updated_bot = ChatMemberUpdated.de_json(json_dict, offline_bot)
chat_member_updated_raw = ChatMemberUpdated.de_json(json_dict, raw_bot)
chat_member_updated_tz = ChatMemberUpdated.de_json(json_dict, tz_bot)
# comparing utcoffsets because comparing timezones is unpredicatable
message_offset = chat_member_updated_tz.date.utcoffset()
tz_bot_offset = tz_bot.defaults.tzinfo.utcoffset(
chat_member_updated_tz.date.replace(tzinfo=None)
)
assert chat_member_updated_raw.date.tzinfo == UTC
assert chat_member_updated_bot.date.tzinfo == UTC
assert message_offset == tz_bot_offset
def test_to_dict(self, chat_member_updated):
chat_member_updated_dict = chat_member_updated.to_dict()
assert isinstance(chat_member_updated_dict, dict)
assert chat_member_updated_dict["chat"] == chat_member_updated.chat.to_dict()
assert chat_member_updated_dict["from"] == chat_member_updated.from_user.to_dict()
assert chat_member_updated_dict["date"] == to_timestamp(chat_member_updated.date)
assert (
chat_member_updated_dict["old_chat_member"]
== chat_member_updated.old_chat_member.to_dict()
)
assert (
chat_member_updated_dict["new_chat_member"]
== chat_member_updated.new_chat_member.to_dict()
)
assert chat_member_updated_dict["invite_link"] == chat_member_updated.invite_link.to_dict()
assert (
chat_member_updated_dict["via_chat_folder_invite_link"]
== chat_member_updated.via_chat_folder_invite_link
)
assert chat_member_updated_dict["via_join_request"] == chat_member_updated.via_join_request
def test_equality(self, time, old_chat_member, new_chat_member, invite_link):
a = ChatMemberUpdated(
Chat(1, "chat"),
User(1, "", False),
time,
old_chat_member,
new_chat_member,
invite_link,
)
b = ChatMemberUpdated(
Chat(1, "chat"), User(1, "", False), time, old_chat_member, new_chat_member
)
# wrong date
c = ChatMemberUpdated(
Chat(1, "chat"),
User(1, "", False),
time + dtm.timedelta(hours=1),
old_chat_member,
new_chat_member,
)
# wrong chat & form_user
d = ChatMemberUpdated(
Chat(42, "wrong_chat"),
User(42, "wrong_user", False),
time,
old_chat_member,
new_chat_member,
)
# wrong old_chat_member
e = ChatMemberUpdated(
Chat(1, "chat"),
User(1, "", False),
time,
ChatMember(User(1, "", False), ChatMember.OWNER),
new_chat_member,
)
# wrong new_chat_member
f = ChatMemberUpdated(
Chat(1, "chat"),
User(1, "", False),
time,
old_chat_member,
ChatMember(User(1, "", False), ChatMember.OWNER),
)
# wrong type
g = ChatMember(User(1, "", False), ChatMember.OWNER)
assert a == b
assert hash(a) == hash(b)
assert a is not b
for other in [c, d, e, f, g]:
assert a != other
assert hash(a) != hash(other)
def test_difference_required(self, user, chat):
old_chat_member = ChatMember(user, "old_status")
new_chat_member = ChatMember(user, "new_status")
chat_member_updated = ChatMemberUpdated(
chat, user, dtm.datetime.utcnow(), old_chat_member, new_chat_member
)
assert chat_member_updated.difference() == {"status": ("old_status", "new_status")}
# We deliberately change an optional argument here to make sure that comparison doesn't
# just happens by id/required args
new_user = User(1, "First name", False, last_name="last name")
new_chat_member = ChatMember(new_user, "new_status")
chat_member_updated = ChatMemberUpdated(
chat, user, dtm.datetime.utcnow(), old_chat_member, new_chat_member
)
assert chat_member_updated.difference() == {
"status": ("old_status", "new_status"),
"user": (user, new_user),
}
@pytest.mark.parametrize(
"optional_attribute",
# This gives the names of all optional arguments of ChatMember
# skipping stories names because they aren't optional even though we pretend they are
[
name
for name, param in inspect.signature(ChatMemberAdministrator).parameters.items()
if name
not in [
"self",
"api_kwargs",
"can_delete_stories",
"can_post_stories",
"can_edit_stories",
]
and param.default != inspect.Parameter.empty
],
)
def test_difference_optionals(self, optional_attribute, user, chat):
# We test with ChatMemberAdministrator, since that's currently the only interesting class
# with optional arguments
old_value = "old_value"
new_value = "new_value"
trues = tuple(True for _ in range(9))
old_chat_member = ChatMemberAdministrator(
user,
*trues,
**{optional_attribute: old_value},
can_delete_stories=True,
can_edit_stories=True,
can_post_stories=True,
)
new_chat_member = ChatMemberAdministrator(
user,
*trues,
**{optional_attribute: new_value},
can_delete_stories=True,
can_edit_stories=True,
can_post_stories=True,
)
chat_member_updated = ChatMemberUpdated(
chat, user, dtm.datetime.utcnow(), old_chat_member, new_chat_member
)
assert chat_member_updated.difference() == {optional_attribute: (old_value, new_value)}
def test_difference_different_classes(self, user, chat):
old_chat_member = ChatMemberOwner(user=user, is_anonymous=False)
new_chat_member = ChatMemberBanned(user=user, until_date=dtm.datetime(2021, 1, 1))
chat_member_updated = ChatMemberUpdated(
chat=chat,
from_user=user,
date=dtm.datetime.utcnow(),
old_chat_member=old_chat_member,
new_chat_member=new_chat_member,
)
diff = chat_member_updated.difference()
assert diff.pop("is_anonymous") == (False, None)
assert diff.pop("until_date") == (None, dtm.datetime(2021, 1, 1))
assert diff.pop("status") == (ChatMember.OWNER, ChatMember.BANNED)
assert diff == {}
|