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
|
#!/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 pytest
from telegram import (
CallbackQuery,
Chat,
InlineKeyboardButton,
InlineKeyboardMarkup,
Message,
Update,
User,
)
from telegram.error import TelegramError
from telegram.ext import ApplicationBuilder, CallbackContext, Job
from telegram.warnings import PTBUserWarning
from tests.auxil.pytest_classes import make_bot
from tests.auxil.slots import mro_slots
"""
CallbackContext.refresh_data is tested in TestBasePersistence
"""
class TestCallbackContext:
def test_slot_behaviour(self, app):
c = CallbackContext(app)
for attr in c.__slots__:
assert getattr(c, attr, "err") != "err", f"got extra slot '{attr}'"
assert not c.__dict__, f"got missing slot(s): {c.__dict__}"
assert len(mro_slots(c)) == len(set(mro_slots(c))), "duplicate slot"
def test_from_job(self, app):
job = app.job_queue.run_once(lambda x: x, 10)
callback_context = CallbackContext.from_job(job, app)
assert callback_context.job is job
assert callback_context.chat_data is None
assert callback_context.user_data is None
assert callback_context.bot_data is app.bot_data
assert callback_context.bot is app.bot
assert callback_context.job_queue is app.job_queue
assert callback_context.update_queue is app.update_queue
def test_job_queue(self, bot, app, recwarn):
expected_warning = (
"No `JobQueue` set up. To use `JobQueue`, you must install PTB via "
'`pip install "python-telegram-bot[job-queue]"`.'
)
callback_context = CallbackContext(app)
assert callback_context.job_queue is app.job_queue
app = ApplicationBuilder().job_queue(None).token(bot.token).build()
callback_context = CallbackContext(app)
assert callback_context.job_queue is None
assert len(recwarn) == 1
assert str(recwarn[0].message) == expected_warning
assert recwarn[0].category is PTBUserWarning
assert recwarn[0].filename == __file__, "wrong stacklevel"
def test_from_update(self, app):
update = Update(
0, message=Message(0, None, Chat(1, "chat"), from_user=User(1, "user", False))
)
callback_context = CallbackContext.from_update(update, app)
assert callback_context.chat_data == {}
assert callback_context.user_data == {}
assert callback_context.bot_data is app.bot_data
assert callback_context.bot is app.bot
assert callback_context.job_queue is app.job_queue
assert callback_context.update_queue is app.update_queue
callback_context_same_user_chat = CallbackContext.from_update(update, app)
callback_context.bot_data["test"] = "bot"
callback_context.chat_data["test"] = "chat"
callback_context.user_data["test"] = "user"
assert callback_context_same_user_chat.bot_data is callback_context.bot_data
assert callback_context_same_user_chat.chat_data is callback_context.chat_data
assert callback_context_same_user_chat.user_data is callback_context.user_data
update_other_user_chat = Update(
0, message=Message(0, None, Chat(2, "chat"), from_user=User(2, "user", False))
)
callback_context_other_user_chat = CallbackContext.from_update(update_other_user_chat, app)
assert callback_context_other_user_chat.bot_data is callback_context.bot_data
assert callback_context_other_user_chat.chat_data is not callback_context.chat_data
assert callback_context_other_user_chat.user_data is not callback_context.user_data
def test_from_update_not_update(self, app):
callback_context = CallbackContext.from_update(None, app)
assert callback_context.chat_data is None
assert callback_context.user_data is None
assert callback_context.bot_data is app.bot_data
assert callback_context.bot is app.bot
assert callback_context.job_queue is app.job_queue
assert callback_context.update_queue is app.update_queue
callback_context = CallbackContext.from_update("", app)
assert callback_context.chat_data is None
assert callback_context.user_data is None
assert callback_context.bot_data is app.bot_data
assert callback_context.bot is app.bot
assert callback_context.job_queue is app.job_queue
assert callback_context.update_queue is app.update_queue
def test_from_error(self, app):
error = TelegramError("test")
update = Update(
0, message=Message(0, None, Chat(1, "chat"), from_user=User(1, "user", False))
)
coroutine = object()
callback_context = CallbackContext.from_error(
update=update, error=error, application=app, coroutine=coroutine
)
assert callback_context.error is error
assert callback_context.chat_data == {}
assert callback_context.user_data == {}
assert callback_context.bot_data is app.bot_data
assert callback_context.bot is app.bot
assert callback_context.job_queue is app.job_queue
assert callback_context.update_queue is app.update_queue
assert callback_context.coroutine is coroutine
def test_from_error_job_user_chat_data(self, app):
error = TelegramError("test")
job = Job(callback=lambda x: x, data=None, chat_id=42, user_id=43)
callback_context = CallbackContext.from_error(
update=None, error=error, application=app, job=job
)
assert callback_context.error is error
assert callback_context.chat_data == {}
assert callback_context.user_data == {}
assert callback_context.bot_data is app.bot_data
assert callback_context.bot is app.bot
assert callback_context.job_queue is app.job_queue
assert callback_context.update_queue is app.update_queue
assert callback_context.job is job
def test_match(self, app):
callback_context = CallbackContext(app)
assert callback_context.match is None
callback_context.matches = ["test", "blah"]
assert callback_context.match == "test"
def test_data_assignment(self, app):
update = Update(
0, message=Message(0, None, Chat(1, "chat"), from_user=User(1, "user", False))
)
callback_context = CallbackContext.from_update(update, app)
with pytest.raises(AttributeError):
callback_context.bot_data = {"test": 123}
with pytest.raises(AttributeError):
callback_context.user_data = {}
with pytest.raises(AttributeError):
callback_context.chat_data = "test"
def test_application_attribute(self, app):
callback_context = CallbackContext(app)
assert callback_context.application is app
def test_drop_callback_data_exception(self, bot, app, raw_bot):
update = Update(
0, message=Message(0, None, Chat(1, "chat"), from_user=User(1, "user", False))
)
callback_context = CallbackContext.from_update(update, app)
with pytest.raises(RuntimeError, match="This telegram.ext.ExtBot instance does not"):
callback_context.drop_callback_data(None)
try:
app.bot = raw_bot
with pytest.raises(RuntimeError, match="telegram.Bot does not allow for"):
callback_context.drop_callback_data(None)
finally:
app.bot = bot
async def test_drop_callback_data(self, bot, chat_id):
new_bot = make_bot(token=bot.token, arbitrary_callback_data=True, offline=False)
app = ApplicationBuilder().bot(new_bot).build()
update = Update(
0, message=Message(0, None, Chat(1, "chat"), from_user=User(1, "user", False))
)
callback_context = CallbackContext.from_update(update, app)
async with app:
await app.bot.send_message(
chat_id=chat_id,
text="test",
reply_markup=InlineKeyboardMarkup.from_button(
InlineKeyboardButton("test", callback_data="callback_data")
),
)
keyboard_uuid = app.bot.callback_data_cache.persistence_data[0][0][0]
button_uuid = next(iter(app.bot.callback_data_cache.persistence_data[0][0][2]))
callback_data = keyboard_uuid + button_uuid
callback_query = CallbackQuery(
id="1",
from_user=None,
chat_instance=None,
data=callback_data,
)
app.bot.callback_data_cache.process_callback_query(callback_query)
try:
assert len(app.bot.callback_data_cache.persistence_data[0]) == 1
assert list(app.bot.callback_data_cache.persistence_data[1]) == ["1"]
callback_context.drop_callback_data(callback_query)
assert app.bot.callback_data_cache.persistence_data == ([], {})
finally:
app.bot.callback_data_cache.clear_callback_data()
app.bot.callback_data_cache.clear_callback_queries()
|
