2017-08-11 23:58:41 +02:00
|
|
|
#!/usr/bin/env python
|
|
|
|
#
|
|
|
|
# A library that provides a Python interface to the Telegram Bot API
|
2022-01-03 08:15:18 +01:00
|
|
|
# Copyright (C) 2015-2022
|
2017-08-11 23:58:41 +02:00
|
|
|
# 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/].
|
2022-03-12 12:27:18 +01:00
|
|
|
import datetime
|
|
|
|
import pickle
|
2022-05-05 09:27:54 +02:00
|
|
|
from copy import deepcopy
|
2017-08-11 23:58:41 +02:00
|
|
|
|
|
|
|
import pytest
|
|
|
|
|
2022-05-05 09:27:54 +02:00
|
|
|
from telegram import Chat, Message, PhotoSize, TelegramObject, User
|
2017-08-11 23:58:41 +02:00
|
|
|
|
|
|
|
|
2020-06-15 18:20:51 +02:00
|
|
|
class TestTelegramObject:
|
2022-03-12 12:27:18 +01:00
|
|
|
class Sub(TelegramObject):
|
|
|
|
def __init__(self, private, normal, b):
|
|
|
|
self._private = private
|
|
|
|
self.normal = normal
|
|
|
|
self._bot = b
|
|
|
|
|
2022-05-19 12:47:53 +02:00
|
|
|
def test_to_json(self, monkeypatch):
|
2017-08-11 23:58:41 +02:00
|
|
|
# to_json simply takes whatever comes from to_dict, therefore we only need to test it once
|
|
|
|
telegram_object = TelegramObject()
|
|
|
|
|
|
|
|
# Test that it works with a dict with str keys as well as dicts as lists as values
|
2022-05-05 17:40:22 +02:00
|
|
|
d = {"str": "str", "str2": ["str", "str"], "str3": {"str": "str"}}
|
|
|
|
monkeypatch.setattr("telegram.TelegramObject.to_dict", lambda _: d)
|
2017-08-11 23:58:41 +02:00
|
|
|
json = telegram_object.to_json()
|
|
|
|
# Order isn't guarantied
|
|
|
|
assert '"str": "str"' in json
|
|
|
|
assert '"str2": ["str", "str"]' in json
|
|
|
|
assert '"str3": {"str": "str"}' in json
|
|
|
|
|
|
|
|
# Now make sure that it doesn't work with not json stuff and that it fails loudly
|
|
|
|
# Tuples aren't allowed as keys in json
|
2022-05-05 17:40:22 +02:00
|
|
|
d = {("str", "str"): "str"}
|
2017-08-11 23:58:41 +02:00
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
monkeypatch.setattr("telegram.TelegramObject.to_dict", lambda _: d)
|
2017-08-11 23:58:41 +02:00
|
|
|
with pytest.raises(TypeError):
|
|
|
|
telegram_object.to_json()
|
|
|
|
|
2020-06-10 22:21:25 +02:00
|
|
|
def test_to_dict_private_attribute(self):
|
|
|
|
class TelegramObjectSubclass(TelegramObject):
|
2022-05-05 17:40:22 +02:00
|
|
|
__slots__ = ("a", "_b") # Added slots so that the attrs are converted to dict
|
2021-05-29 16:18:16 +02:00
|
|
|
|
2020-06-10 22:21:25 +02:00
|
|
|
def __init__(self):
|
|
|
|
self.a = 1
|
|
|
|
self._b = 2
|
|
|
|
|
|
|
|
subclass_instance = TelegramObjectSubclass()
|
2022-05-05 17:40:22 +02:00
|
|
|
assert subclass_instance.to_dict() == {"a": 1}
|
2020-07-14 21:33:56 +02:00
|
|
|
|
2021-08-19 22:01:10 +02:00
|
|
|
def test_slot_behaviour(self, mro_slots):
|
2021-05-29 16:18:16 +02:00
|
|
|
inst = TelegramObject()
|
|
|
|
for attr in inst.__slots__:
|
2022-05-05 17:40:22 +02:00
|
|
|
assert getattr(inst, attr, "err") != "err", f"got extra slot '{attr}'"
|
2021-05-29 16:18:16 +02:00
|
|
|
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
|
|
|
|
|
2020-07-14 21:33:56 +02:00
|
|
|
def test_meaningless_comparison(self, recwarn):
|
|
|
|
expected_warning = "Objects of type TGO can not be meaningfully tested for equivalence."
|
|
|
|
|
|
|
|
class TGO(TelegramObject):
|
|
|
|
pass
|
|
|
|
|
|
|
|
a = TGO()
|
|
|
|
b = TGO()
|
|
|
|
assert a == b
|
2021-09-20 08:45:42 +02:00
|
|
|
assert len(recwarn) == 1
|
2020-07-14 21:33:56 +02:00
|
|
|
assert str(recwarn[0].message) == expected_warning
|
2021-09-20 08:45:42 +02:00
|
|
|
assert recwarn[0].filename == __file__, "wrong stacklevel"
|
2020-07-14 21:33:56 +02:00
|
|
|
|
|
|
|
def test_meaningful_comparison(self, recwarn):
|
|
|
|
class TGO(TelegramObject):
|
2021-08-19 22:01:10 +02:00
|
|
|
def __init__(self):
|
|
|
|
self._id_attrs = (1,)
|
2020-07-14 21:33:56 +02:00
|
|
|
|
|
|
|
a = TGO()
|
|
|
|
b = TGO()
|
|
|
|
assert a == b
|
|
|
|
assert len(recwarn) == 0
|
|
|
|
assert b == a
|
|
|
|
assert len(recwarn) == 0
|
2021-10-21 11:17:12 +02:00
|
|
|
|
|
|
|
def test_bot_instance_none(self):
|
|
|
|
tg_object = TelegramObject()
|
|
|
|
with pytest.raises(RuntimeError):
|
|
|
|
tg_object.get_bot()
|
|
|
|
|
2022-05-05 17:40:22 +02:00
|
|
|
@pytest.mark.parametrize("bot_inst", ["bot", None])
|
2021-10-21 11:17:12 +02:00
|
|
|
def test_bot_instance_states(self, bot_inst):
|
|
|
|
tg_object = TelegramObject()
|
2022-05-05 17:40:22 +02:00
|
|
|
tg_object.set_bot("bot" if bot_inst == "bot" else bot_inst)
|
|
|
|
if bot_inst == "bot":
|
|
|
|
assert tg_object.get_bot() == "bot"
|
2021-10-21 11:17:12 +02:00
|
|
|
elif bot_inst is None:
|
|
|
|
with pytest.raises(RuntimeError):
|
|
|
|
tg_object.get_bot()
|
2021-11-21 13:36:22 +01:00
|
|
|
|
|
|
|
def test_subscription(self):
|
|
|
|
# We test with Message because that gives us everything we want to test - easier than
|
|
|
|
# implementing a custom subclass just for this test
|
|
|
|
chat = Chat(2, Chat.PRIVATE)
|
2022-05-05 17:40:22 +02:00
|
|
|
user = User(3, "first_name", False)
|
|
|
|
message = Message(1, None, chat=chat, from_user=user, text="foobar")
|
|
|
|
assert message["text"] == "foobar"
|
|
|
|
assert message["chat"] is chat
|
|
|
|
assert message["chat_id"] == 2
|
|
|
|
assert message["from"] is user
|
|
|
|
assert message["from_user"] is user
|
2021-11-21 13:36:22 +01:00
|
|
|
with pytest.raises(KeyError, match="Message don't have an attribute called `no_key`"):
|
2022-05-05 17:40:22 +02:00
|
|
|
message["no_key"]
|
2022-03-12 12:27:18 +01:00
|
|
|
|
|
|
|
def test_pickle(self, bot):
|
|
|
|
chat = Chat(2, Chat.PRIVATE)
|
2022-05-05 17:40:22 +02:00
|
|
|
user = User(3, "first_name", False)
|
2022-03-12 12:27:18 +01:00
|
|
|
date = datetime.datetime.now()
|
2022-05-05 17:40:22 +02:00
|
|
|
photo = PhotoSize("file_id", "unique", 21, 21, bot=bot)
|
|
|
|
msg = Message(1, date, chat, from_user=user, text="foobar", bot=bot, photo=[photo])
|
2022-03-12 12:27:18 +01:00
|
|
|
|
|
|
|
# Test pickling of TGObjects, we choose Message since it's contains the most subclasses.
|
|
|
|
assert msg.get_bot()
|
|
|
|
unpickled = pickle.loads(pickle.dumps(msg))
|
|
|
|
|
|
|
|
with pytest.raises(RuntimeError):
|
|
|
|
unpickled.get_bot() # There should be no bot when we pickle TGObjects
|
|
|
|
|
|
|
|
assert unpickled.chat == chat
|
|
|
|
assert unpickled.from_user == user
|
|
|
|
assert unpickled.date == date
|
|
|
|
assert unpickled.photo[0] == photo
|
|
|
|
|
|
|
|
def test_deepcopy_telegram_obj(self, bot):
|
|
|
|
chat = Chat(2, Chat.PRIVATE)
|
2022-05-05 17:40:22 +02:00
|
|
|
user = User(3, "first_name", False)
|
2022-03-12 12:27:18 +01:00
|
|
|
date = datetime.datetime.now()
|
2022-05-05 17:40:22 +02:00
|
|
|
photo = PhotoSize("file_id", "unique", 21, 21, bot=bot)
|
|
|
|
msg = Message(1, date, chat, from_user=user, text="foobar", bot=bot, photo=[photo])
|
2022-03-12 12:27:18 +01:00
|
|
|
|
|
|
|
new_msg = deepcopy(msg)
|
|
|
|
|
|
|
|
# The same bot should be present when deepcopying.
|
|
|
|
assert new_msg.get_bot() == bot and new_msg.get_bot() is bot
|
|
|
|
|
|
|
|
assert new_msg.date == date and new_msg.date is not date
|
|
|
|
assert new_msg.chat == chat and new_msg.chat is not chat
|
|
|
|
assert new_msg.from_user == user and new_msg.from_user is not user
|
|
|
|
assert new_msg.photo[0] == photo and new_msg.photo[0] is not photo
|
|
|
|
|
|
|
|
def test_deepcopy_subclass_telegram_obj(self, bot):
|
2022-05-05 17:40:22 +02:00
|
|
|
s = self.Sub("private", "normal", bot)
|
2022-03-12 12:27:18 +01:00
|
|
|
d = deepcopy(s)
|
|
|
|
assert d is not s
|
|
|
|
assert d._private == s._private # Can't test for identity since two equal strings is True
|
|
|
|
assert d._bot == s._bot and d._bot is s._bot
|
|
|
|
assert d.normal == s.normal
|