python-telegram-bot/tests/test_callbackqueryhandler.py

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

230 lines
8.1 KiB
Python
Raw Normal View History

#!/usr/bin/env python
#
# A library that provides a Python interface to the Telegram Bot API
2022-01-03 08:15:18 +01:00
# 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 asyncio
import pytest
from telegram import (
Bot,
CallbackQuery,
Chat,
ChosenInlineResult,
InlineQuery,
Message,
PreCheckoutQuery,
ShippingQuery,
Update,
User,
)
from telegram.ext import CallbackContext, CallbackQueryHandler, InvalidCallbackData, JobQueue
2020-10-06 19:28:40 +02:00
message = Message(1, None, Chat(1, ""), from_user=User(1, "", False), text="Text")
params = [
{"message": message},
{"edited_message": message},
{"channel_post": message},
{"edited_channel_post": message},
{"inline_query": InlineQuery(1, User(1, "", False), "", "")},
{"chosen_inline_result": ChosenInlineResult("id", User(1, "", False), "")},
{"shipping_query": ShippingQuery("id", User(1, "", False), "", None)},
{"pre_checkout_query": PreCheckoutQuery("id", User(1, "", False), "", 0, "")},
]
ids = (
"message",
"edited_message",
"channel_post",
"edited_channel_post",
"inline_query",
"chosen_inline_result",
"shipping_query",
"pre_checkout_query",
)
@pytest.fixture(scope="class", params=params, ids=ids)
def false_update(request):
return Update(update_id=2, **request.param)
@pytest.fixture(scope="function")
def callback_query(bot):
update = Update(0, callback_query=CallbackQuery(2, User(1, "", False), None, data="test data"))
update._unfreeze()
update.callback_query._unfreeze()
return update
class TestCallbackQueryHandler:
test_flag = False
def test_slot_behaviour(self, mro_slots):
handler = CallbackQueryHandler(self.callback_data_1)
for attr in handler.__slots__:
assert getattr(handler, attr, "err") != "err", f"got extra slot '{attr}'"
assert len(mro_slots(handler)) == len(set(mro_slots(handler))), "duplicate slot"
@pytest.fixture(autouse=True)
def reset(self):
self.test_flag = False
2021-08-29 18:15:04 +02:00
def callback_basic(self, update, context):
test_bot = isinstance(context.bot, Bot)
test_update = isinstance(update, Update)
self.test_flag = test_bot and test_update
def callback_data_1(self, bot, update, user_data=None, chat_data=None):
self.test_flag = (user_data is not None) or (chat_data is not None)
def callback_data_2(self, bot, update, user_data=None, chat_data=None):
self.test_flag = (user_data is not None) and (chat_data is not None)
def callback_queue_1(self, bot, update, job_queue=None, update_queue=None):
self.test_flag = (job_queue is not None) or (update_queue is not None)
def callback_queue_2(self, bot, update, job_queue=None, update_queue=None):
self.test_flag = (job_queue is not None) and (update_queue is not None)
def callback_group(self, bot, update, groups=None, groupdict=None):
if groups is not None:
self.test_flag = groups == ("t", " data")
if groupdict is not None:
self.test_flag = groupdict == {"begin": "t", "end": " data"}
async def callback(self, update, context):
2019-02-08 20:55:40 +01:00
self.test_flag = (
isinstance(context, CallbackContext)
and isinstance(context.bot, Bot)
and isinstance(update, Update)
and isinstance(context.update_queue, asyncio.Queue)
2019-02-08 20:55:40 +01:00
and isinstance(context.job_queue, JobQueue)
and isinstance(context.user_data, dict)
and context.chat_data is None
and isinstance(context.bot_data, dict)
2019-02-08 20:55:40 +01:00
and isinstance(update.callback_query, CallbackQuery)
)
def callback_pattern(self, update, context):
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
if context.matches[0].groups():
self.test_flag = context.matches[0].groups() == ("t", " data")
if context.matches[0].groupdict():
self.test_flag = context.matches[0].groupdict() == {"begin": "t", "end": " data"}
def test_with_pattern(self, callback_query):
handler = CallbackQueryHandler(self.callback_basic, pattern=".*est.*")
assert handler.check_update(callback_query)
callback_query.callback_query.data = "nothing here"
assert not handler.check_update(callback_query)
2021-06-06 11:48:48 +02:00
callback_query.callback_query.data = None
callback_query.callback_query.game_short_name = "this is a short game name"
assert not handler.check_update(callback_query)
callback_query.callback_query.data = object()
assert not handler.check_update(callback_query)
callback_query.callback_query.data = InvalidCallbackData()
assert not handler.check_update(callback_query)
2021-06-06 11:48:48 +02:00
def test_with_callable_pattern(self, callback_query):
class CallbackData:
pass
def pattern(callback_data):
return isinstance(callback_data, CallbackData)
handler = CallbackQueryHandler(self.callback_basic, pattern=pattern)
callback_query.callback_query.data = CallbackData()
assert handler.check_update(callback_query)
callback_query.callback_query.data = "callback_data"
assert not handler.check_update(callback_query)
def test_with_type_pattern(self, callback_query):
class CallbackData:
pass
handler = CallbackQueryHandler(self.callback_basic, pattern=CallbackData)
callback_query.callback_query.data = CallbackData()
assert handler.check_update(callback_query)
callback_query.callback_query.data = "callback_data"
assert not handler.check_update(callback_query)
handler = CallbackQueryHandler(self.callback_basic, pattern=bool)
callback_query.callback_query.data = False
assert handler.check_update(callback_query)
callback_query.callback_query.data = "callback_data"
assert not handler.check_update(callback_query)
2021-08-29 18:15:04 +02:00
def test_other_update_types(self, false_update):
handler = CallbackQueryHandler(self.callback_basic)
assert not handler.check_update(false_update)
async def test_context(self, app, callback_query):
handler = CallbackQueryHandler(self.callback)
app.add_handler(handler)
async with app:
await app.process_update(callback_query)
assert self.test_flag
async def test_context_pattern(self, app, callback_query):
handler = CallbackQueryHandler(
self.callback_pattern, pattern=r"(?P<begin>.*)est(?P<end>.*)"
)
app.add_handler(handler)
async with app:
await app.process_update(callback_query)
assert self.test_flag
app.remove_handler(handler)
handler = CallbackQueryHandler(self.callback_pattern, pattern=r"(t)est(.*)")
app.add_handler(handler)
await app.process_update(callback_query)
assert self.test_flag
async def test_context_callable_pattern(self, app, callback_query):
2021-06-06 11:48:48 +02:00
class CallbackData:
pass
def pattern(callback_data):
return isinstance(callback_data, CallbackData)
def callback(update, context):
assert context.matches is None
handler = CallbackQueryHandler(callback, pattern=pattern)
app.add_handler(handler)
2021-06-06 11:48:48 +02:00
async with app:
await app.process_update(callback_query)
def test_async_pattern(self):
async def pattern():
pass
with pytest.raises(TypeError, match="must not be a coroutine function"):
CallbackQueryHandler(self.callback, pattern=pattern)