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
|
#!/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 re
from pathlib import Path
from telegram._utils.strings import TextEncoding
telegram_root = Path(__file__).parent.parent / "telegram"
telegram_ext_root = telegram_root / "ext"
exclude_dirs = {
# We touch passport stuff only if strictly necessary.
telegram_root
/ "_passport",
}
exclude_patterns = {
re.compile(re.escape("self.type: ReactionType = type")),
re.compile(re.escape("self.type: BackgroundType = type")),
re.compile(re.escape("self.type: StoryAreaType = type")),
}
def test_types_are_converted_to_enum():
"""We want to convert all attributes of name "type" to an enum from telegram.constants.
Since we don't necessarily document this as type hint, we simply check this with a regex.
"""
pattern = re.compile(r"self\.type: [^=]+ = ([^\n]+)\n", re.MULTILINE)
for path in telegram_root.rglob("*.py"):
if telegram_ext_root in path.parents or any(
exclude_dir in path.parents for exclude_dir in exclude_dirs
):
# We don't check tg.ext.
continue
text = path.read_text(encoding=TextEncoding.UTF_8)
for match in re.finditer(pattern, text):
if any(exclude_pattern.match(match.group(0)) for exclude_pattern in exclude_patterns):
continue
assert match.group(1).startswith("enum.get_member") or match.group(1).startswith(
"get_member"
), (
f"`{match.group(1)}` in `{path}` does not seem to convert the type to an enum. "
f"Please fix this and also make sure to add a separate test to the classes test "
f"file."
)
|
