python-telegram-bot/tests/test_warnings.py
Harshil 335772568f Update and Expand Tests & pre-commit Settings and Improve Code Quality (#2925)
Co-authored-by: Hinrich Mahler <22366557+Bibo-Joshi@users.noreply.github.com>
2022-05-06 18:22:34 +02:00

87 lines
3.3 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/].
from collections import defaultdict
from pathlib import Path
import pytest
from telegram._utils.warnings import warn
from telegram.warnings import PTBDeprecationWarning, PTBRuntimeWarning, PTBUserWarning
from tests.conftest import PROJECT_ROOT_PATH
class TestWarnings:
@pytest.mark.parametrize(
"inst",
[
(PTBUserWarning("test message")),
(PTBRuntimeWarning("test message")),
(PTBDeprecationWarning()),
],
)
def test_slots_behavior(self, inst, mro_slots):
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_test_coverage(self):
"""This test is only here to make sure that new warning classes will set __slots__
properly.
Add the new warning class to the below covered_subclasses dict, if it's covered in the
above test_slots_behavior tests.
"""
def make_assertion(cls):
assert set(cls.__subclasses__()) == covered_subclasses[cls]
for subcls in cls.__subclasses__():
make_assertion(subcls)
covered_subclasses = defaultdict(set)
covered_subclasses.update(
{
PTBUserWarning: {
PTBRuntimeWarning,
PTBDeprecationWarning,
},
}
)
make_assertion(PTBUserWarning)
def test_warn(self, recwarn):
expected_file = PROJECT_ROOT_PATH / 'telegram' / '_utils' / 'warnings.py'
warn('test message')
assert len(recwarn) == 1
assert recwarn[0].category is PTBUserWarning
assert str(recwarn[0].message) == 'test message'
assert Path(recwarn[0].filename) == expected_file, "incorrect stacklevel!"
warn('test message 2', category=PTBRuntimeWarning)
assert len(recwarn) == 2
assert recwarn[1].category is PTBRuntimeWarning
assert str(recwarn[1].message) == 'test message 2'
assert Path(recwarn[1].filename) == expected_file, "incorrect stacklevel!"
warn('test message 3', stacklevel=1, category=PTBDeprecationWarning)
expected_file = Path(__file__)
assert len(recwarn) == 3
assert recwarn[2].category is PTBDeprecationWarning
assert str(recwarn[2].message) == 'test message 3'
assert Path(recwarn[2].filename) == expected_file, "incorrect stacklevel!"