-
Notifications
You must be signed in to change notification settings - Fork 5.1k
/
test_official.py
259 lines (218 loc) · 9.34 KB
/
test_official.py
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
#!/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 inspect
import os
from typing import List
import httpx
import pytest
from bs4 import BeautifulSoup
import telegram
from telegram._utils.defaultvalue import DefaultValue
from tests.auxil.object_conversions import env_var_2_bool
IGNORED_OBJECTS = ("ResponseParameters", "CallbackGame")
IGNORED_PARAMETERS = {
"self",
"args",
"read_timeout",
"write_timeout",
"connect_timeout",
"pool_timeout",
"bot",
"api_kwargs",
}
ignored_param_requirements = { # Ignore these since there's convenience params in them (eg. Venue)
"send_location": {"latitude", "longitude"},
"edit_message_live_location": {"latitude", "longitude"},
"send_venue": {"latitude", "longitude", "title", "address"},
"send_contact": {"phone_number", "first_name"},
}
def find_next_sibling_until(tag, name, until):
for sibling in tag.next_siblings:
if sibling is until:
return
if sibling.name == name:
return sibling
def parse_table(h4) -> List[List[str]]:
"""Parses the Telegram doc table and has an output of a 2D list."""
table = find_next_sibling_until(h4, "table", h4.find_next_sibling("h4"))
if not table:
return []
t = []
for tr in table.find_all("tr")[1:]:
t.append([td.text for td in tr.find_all("td")])
return t
def check_method(h4):
name = h4.text # name of the method in telegram's docs.
method = getattr(telegram.Bot, name) # Retrieve our lib method
table = parse_table(h4)
# Check arguments based on source
sig = inspect.signature(method, follow_wrapped=True)
checked = []
for tg_parameter in table: # Iterates through each row in the table
param = sig.parameters.get(
tg_parameter[0] # parameter[0] is first element (the param name)
)
assert param is not None, f"Parameter {tg_parameter[0]} not found in {method.__name__}"
# TODO: Check type via docstring
assert check_required_param(
tg_parameter, param, method.__name__
), f"Param {param.name!r} of method {method.__name__!r} requirement mismatch!"
# Now we will check that we don't pass default values if the parameter is not required.
if param.default is not inspect.Parameter.empty: # If there is a default argument...
default_arg_none = check_defaults_type(param) # check if it's None
assert default_arg_none, f"Param {param.name!r} of {method.__name__!r} should be None"
checked.append(tg_parameter[0])
ignored = IGNORED_PARAMETERS.copy()
if name == "getUpdates":
ignored -= {"timeout"} # Has it's own timeout parameter that we do wanna check for
elif name in (
f"send{media_type}"
for media_type in [
"Animation",
"Audio",
"Document",
"Photo",
"Video",
"VideoNote",
"Voice",
]
):
ignored |= {"filename"} # Convenience parameter
elif name == "sendContact":
ignored |= {"contact"} # Added for ease of use
elif name in ["sendLocation", "editMessageLiveLocation"]:
ignored |= {"location"} # Added for ease of use
elif name == "sendVenue":
ignored |= {"venue"} # Added for ease of use
elif name == "answerInlineQuery":
ignored |= {"current_offset"} # Added for ease of use
elif name == "sendMediaGroup":
# Added for ease of use
ignored |= {"caption", "parse_mode", "caption_entities"}
assert (sig.parameters.keys() ^ checked) - ignored == set()
kw_or_positional_args = [
p.name for p in sig.parameters.values() if p.kind != inspect.Parameter.KEYWORD_ONLY
]
assert set(kw_or_positional_args).difference(checked).difference(["self"]) == set(), (
f"In {method.__qualname__}, extra args should be keyword only "
f"(compared to {name} in API)"
)
def check_object(h4):
name = h4.text
obj = getattr(telegram, name)
table = parse_table(h4)
# Check arguments based on source. Makes sure to only check __init__'s signature & nothing else
sig = inspect.signature(obj.__init__, follow_wrapped=True)
checked = set()
for tg_parameter in table:
field: str = tg_parameter[0] # From telegram docs
if field == "from":
field = "from_user"
elif (
name.startswith("InlineQueryResult")
or name.startswith("InputMedia")
or name.startswith("BotCommandScope")
or name.startswith("MenuButton")
) and field == "type":
continue
elif (name.startswith("ChatMember")) and field == "status": # We autofill the status
continue
elif (
name.startswith("PassportElementError") and field == "source"
) or field == "remove_keyboard":
continue
elif name.startswith("ForceReply") and field == "force_reply": # this param is always True
continue
param = sig.parameters.get(field)
assert param is not None, f"Attribute {field} not found in {obj.__name__}"
# TODO: Check type via docstring
assert check_required_param(
tg_parameter, param, obj.__name__
), f"{obj.__name__!r} parameter {param.name!r} requirement mismatch"
if param.default is not inspect.Parameter.empty: # If there is a default argument...
default_arg_none = check_defaults_type(param) # check if its None
assert default_arg_none, f"Param {param.name!r} of {obj.__name__!r} should be `None`"
checked.add(field)
ignored = IGNORED_PARAMETERS.copy()
if name == "InputFile":
return
if name == "InlineQueryResult":
ignored |= {"id", "type"} # attributes common to all subclasses
if name == "ChatMember":
ignored |= {"user", "status"} # attributes common to all subclasses
if name == "BotCommandScope":
ignored |= {"type"} # attributes common to all subclasses
if name == "MenuButton":
ignored |= {"type"} # attributes common to all subclasses
elif name in ("PassportFile", "EncryptedPassportElement"):
ignored |= {"credentials"}
elif name == "PassportElementError":
ignored |= {"message", "type", "source"}
elif name == "InputMedia":
ignored |= {"caption", "caption_entities", "media", "media_type", "parse_mode"}
elif name.startswith("InputMedia"):
ignored |= {"filename"} # Convenience parameter
assert (sig.parameters.keys() ^ checked) - ignored == set()
def is_parameter_required_by_tg(field: str) -> bool:
if field in {"Required", "Yes"}:
return True
if field.split(".", 1)[0] == "Optional": # splits the sentence and extracts first word
return False
else:
return True
def check_required_param(
param_desc: List[str], param: inspect.Parameter, method_or_obj_name: str
) -> bool:
"""Checks if the method/class parameter is a required/optional param as per Telegram docs.
Returns:
:obj:`bool`: The boolean returned represents whether our parameter's requirement (optional
or required) is the same as Telegram's or not.
"""
is_ours_required = param.default is inspect.Parameter.empty
telegram_requires = is_parameter_required_by_tg(param_desc[2])
# Handle cases where we provide convenience intentionally-
if param.name in ignored_param_requirements.get(method_or_obj_name, {}):
return True
return telegram_requires is is_ours_required
def check_defaults_type(ptb_param: inspect.Parameter) -> bool:
return True if DefaultValue.get_value(ptb_param.default) is None else False
to_run = env_var_2_bool(os.getenv("TEST_OFFICIAL"))
argvalues = []
names = []
if to_run:
argvalues = []
names = []
request = httpx.get("https://core.telegram.org/bots/api")
soup = BeautifulSoup(request.text, "html.parser")
for thing in soup.select("h4 > a.anchor"):
# Methods and types don't have spaces in them, luckily all other sections of the docs do
# TODO: don't depend on that
if "-" not in thing["name"]:
h4 = thing.parent
# Is it a method
if h4.text[0].lower() == h4.text[0]:
argvalues.append((check_method, h4))
names.append(h4.text)
elif h4.text not in IGNORED_OBJECTS: # Or a type/object
argvalues.append((check_object, h4))
names.append(h4.text)
@pytest.mark.skipif(not to_run, reason="test_official is not enabled")
@pytest.mark.parametrize(("method", "data"), argvalues=argvalues, ids=names)
def test_official(method, data):
method(data)