python-telegram-bot/tests/ext/test_callbackcontext.py

Ignoring revisions in .git-blame-ignore-revs. Click here to bypass and see the normal blame view.

250 lines
9.7 KiB
Python
Raw Normal View History

#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
2023-01-01 21:31:29 +01:00
# Copyright (C) 2015-2023
# 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
2021-06-06 11:48:48 +02:00
from telegram import (
Bot,
CallbackQuery,
Chat,
InlineKeyboardButton,
InlineKeyboardMarkup,
Message,
Update,
User,
2021-06-06 11:48:48 +02:00
)
from telegram.error import TelegramError
from telegram.ext import ApplicationBuilder, CallbackContext, Job
from telegram.warnings import PTBUserWarning
2023-02-22 20:19:46 +01:00
from tests.auxil.slots import mro_slots
"""
CallbackContext.refresh_data is tested in TestBasePersistence
"""
class TestCallbackContext:
2023-02-22 20:19:46 +01:00
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 "
2023-01-03 18:50:06 +01:00
"`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):
2020-10-06 19:28:40 +02:00
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
2020-10-06 19:28:40 +02:00
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")
2020-10-06 19:28:40 +02:00
update = Update(
0, message=Message(0, None, Chat(1, "chat"), from_user=User(1, "user", False))
)
coroutine = object()
2020-10-04 17:20:33 +02:00
callback_context = CallbackContext.from_error(
update=update, error=error, application=app, coroutine=coroutine
2020-10-04 17:20:33 +02:00
)
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
Update Filters, CommandHandler and MessageHandler (#1221) * update_filter attribute on filters Makes it possible to have filters work on an update instead of message, while keeping behavior for current filters * add update_type filter * Messagehandler rework - remove allow_edited (deprecated for a while) - set deprecated defaults to None - Raise deprecation warning when they're used - add sensible defaults for filters. - rework tests * Commandhandler rework * Remove deprecation test from new handler * Some tweaks per CR - rename update_types -> updates - added some clarification to docstrings * run webhook set test only on 3.6 on appveyor * update_filter attribute on filters Makes it possible to have filters work on an update instead of message, while keeping behavior for current filters * add update_type filter * Messagehandler rework - remove allow_edited (deprecated for a while) - set deprecated defaults to None - Raise deprecation warning when they're used - add sensible defaults for filters. - rework tests * Commandhandler rework * Remove deprecation test from new handler * Some tweaks per CR - rename update_types -> updates - added some clarification to docstrings * run webhook set test only on 3.6 on appveyor * Changes per CR * Update travis to build v12 * small doc update * try to make ci build version branches * doc for BaseFilter * Modify regexfilter and mergedfilter Now returns a list of match objects for every regexfilter * Change callbackcontext (+ docs) * integrate in CommandHandler and PrefixHandler * integrate in MessageHandler * cbqhandler, iqhandler and srhandler * make regexhandler a shell over MessageHandler And raise deprecationWarning on creation * clean up code and add some comments * Rework based on internal group feedback - use data_filter instead of regex_filter on BaseFilter - have these filters return a dict that is then updated onto CallbackContext instead of using a list is before - Add a .match property on CallbackContext that returns .matches[0] or None * Fix and add test for callbackcontext.match * Lots of documentation fixes and improvements [ci skip]
2019-02-13 12:07:25 +01:00
def test_match(self, app):
callback_context = CallbackContext(app)
Update Filters, CommandHandler and MessageHandler (#1221) * update_filter attribute on filters Makes it possible to have filters work on an update instead of message, while keeping behavior for current filters * add update_type filter * Messagehandler rework - remove allow_edited (deprecated for a while) - set deprecated defaults to None - Raise deprecation warning when they're used - add sensible defaults for filters. - rework tests * Commandhandler rework * Remove deprecation test from new handler * Some tweaks per CR - rename update_types -> updates - added some clarification to docstrings * run webhook set test only on 3.6 on appveyor * update_filter attribute on filters Makes it possible to have filters work on an update instead of message, while keeping behavior for current filters * add update_type filter * Messagehandler rework - remove allow_edited (deprecated for a while) - set deprecated defaults to None - Raise deprecation warning when they're used - add sensible defaults for filters. - rework tests * Commandhandler rework * Remove deprecation test from new handler * Some tweaks per CR - rename update_types -> updates - added some clarification to docstrings * run webhook set test only on 3.6 on appveyor * Changes per CR * Update travis to build v12 * small doc update * try to make ci build version branches * doc for BaseFilter * Modify regexfilter and mergedfilter Now returns a list of match objects for every regexfilter * Change callbackcontext (+ docs) * integrate in CommandHandler and PrefixHandler * integrate in MessageHandler * cbqhandler, iqhandler and srhandler * make regexhandler a shell over MessageHandler And raise deprecationWarning on creation * clean up code and add some comments * Rework based on internal group feedback - use data_filter instead of regex_filter on BaseFilter - have these filters return a dict that is then updated onto CallbackContext instead of using a list is before - Add a .match property on CallbackContext that returns .matches[0] or None * Fix and add test for callbackcontext.match * Lots of documentation fixes and improvements [ci skip]
2019-02-13 12:07:25 +01:00
assert callback_context.match is None
callback_context.matches = ["test", "blah"]
assert callback_context.match == "test"
def test_data_assignment(self, app):
2020-10-06 19:28:40 +02:00
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
2021-06-06 11:48:48 +02:00
def test_drop_callback_data_exception(self, bot, app):
2021-06-06 11:48:48 +02:00
non_ext_bot = Bot(bot.token)
update = Update(
0, message=Message(0, None, Chat(1, "chat"), from_user=User(1, "user", False))
)
callback_context = CallbackContext.from_update(update, app)
2021-06-06 11:48:48 +02:00
with pytest.raises(RuntimeError, match="This telegram.ext.ExtBot instance does not"):
callback_context.drop_callback_data(None)
try:
app.bot = non_ext_bot
2021-06-06 11:48:48 +02:00
with pytest.raises(RuntimeError, match="telegram.Bot does not allow for"):
callback_context.drop_callback_data(None)
finally:
app.bot = bot
2021-06-06 11:48:48 +02:00
async def test_drop_callback_data(self, bot, monkeypatch, chat_id):
app = ApplicationBuilder().token(bot.token).arbitrary_callback_data(True).build()
2021-06-06 11:48:48 +02:00
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 = list(app.bot.callback_data_cache.persistence_data[0][0][2])[0]
2021-06-06 11:48:48 +02:00
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)
2021-06-06 11:48:48 +02:00
try:
assert len(app.bot.callback_data_cache.persistence_data[0]) == 1
assert list(app.bot.callback_data_cache.persistence_data[1]) == ["1"]
2021-06-06 11:48:48 +02:00
callback_context.drop_callback_data(callback_query)
assert app.bot.callback_data_cache.persistence_data == ([], {})
2021-06-06 11:48:48 +02:00
finally:
app.bot.callback_data_cache.clear_callback_data()
app.bot.callback_data_cache.clear_callback_queries()