python-telegram-bot/tests/test_telegramobject.py
2022-01-03 08:15:18 +01:00

120 lines
4.5 KiB
Python

#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
# Copyright (C) 2015-2022
# 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 json as json_lib
import pytest
try:
import ujson
except ImportError:
ujson = None
from telegram import TelegramObject
class TestTelegramObject:
def test_to_json_native(self, monkeypatch):
if ujson:
monkeypatch.setattr('ujson.dumps', json_lib.dumps)
# 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
d = {'str': 'str', 'str2': ['str', 'str'], 'str3': {'str': 'str'}}
monkeypatch.setattr('telegram.TelegramObject.to_dict', lambda _: d)
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
d = {('str', 'str'): 'str'}
monkeypatch.setattr('telegram.TelegramObject.to_dict', lambda _: d)
with pytest.raises(TypeError):
telegram_object.to_json()
@pytest.mark.skipif(not ujson, reason='ujson not installed')
def test_to_json_ujson(self, monkeypatch):
# 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
d = {'str': 'str', 'str2': ['str', 'str'], 'str3': {'str': 'str'}}
monkeypatch.setattr('telegram.TelegramObject.to_dict', lambda _: d)
json = telegram_object.to_json()
# Order isn't guarantied and ujon discards whitespace
assert '"str":"str"' in json
assert '"str2":["str","str"]' in json
assert '"str3":{"str":"str"}' in json
# Test that ujson allows tuples
# NOTE: This could be seen as a bug (since it's differnt from the normal "json",
# but we test it anyways
d = {('str', 'str'): 'str'}
monkeypatch.setattr('telegram.TelegramObject.to_dict', lambda _: d)
telegram_object.to_json()
def test_to_dict_private_attribute(self):
class TelegramObjectSubclass(TelegramObject):
__slots__ = ('a', '_b') # Added slots so that the attrs are converted to dict
def __init__(self):
self.a = 1
self._b = 2
subclass_instance = TelegramObjectSubclass()
assert subclass_instance.to_dict() == {'a': 1}
def test_slot_behaviour(self, recwarn, mro_slots):
inst = TelegramObject()
for attr in inst.__slots__:
assert getattr(inst, attr, 'err') != 'err', f"got extra slot '{attr}'"
assert not inst.__dict__, f"got missing slot(s): {inst.__dict__}"
assert len(mro_slots(inst)) == len(set(mro_slots(inst))), "duplicate slot"
inst.custom = 'should give warning'
assert len(recwarn) == 1 and 'custom' in str(recwarn[0].message), recwarn.list
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
assert len(recwarn) == 2
assert str(recwarn[0].message) == expected_warning
assert str(recwarn[1].message) == expected_warning
def test_meaningful_comparison(self, recwarn):
class TGO(TelegramObject):
_id_attrs = (1,)
a = TGO()
b = TGO()
assert a == b
assert len(recwarn) == 0
assert b == a
assert len(recwarn) == 0