2017-08-11 23:58:41 +02:00
|
|
|
#!/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
|
2017-08-11 23:58:41 +02:00
|
|
|
# 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/].
|
2018-09-21 08:57:01 +02:00
|
|
|
from queue import Queue
|
|
|
|
|
2017-08-11 23:58:41 +02:00
|
|
|
import pytest
|
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
from telegram import (
|
|
|
|
Update,
|
|
|
|
CallbackQuery,
|
|
|
|
Bot,
|
|
|
|
Message,
|
|
|
|
User,
|
|
|
|
Chat,
|
|
|
|
InlineQuery,
|
|
|
|
ChosenInlineResult,
|
|
|
|
ShippingQuery,
|
|
|
|
PreCheckoutQuery,
|
|
|
|
)
|
2018-09-21 08:57:01 +02:00
|
|
|
from telegram.ext import CallbackQueryHandler, CallbackContext, JobQueue
|
2017-08-11 23:58:41 +02:00
|
|
|
|
2020-10-06 19:28:40 +02:00
|
|
|
message = Message(1, None, Chat(1, ''), from_user=User(1, '', False), text='Text')
|
2017-08-11 23:58:41 +02:00
|
|
|
|
|
|
|
params = [
|
|
|
|
{'message': message},
|
|
|
|
{'edited_message': message},
|
|
|
|
{'channel_post': message},
|
|
|
|
{'edited_channel_post': message},
|
2017-09-01 08:40:05 +02:00
|
|
|
{'inline_query': InlineQuery(1, User(1, '', False), '', '')},
|
|
|
|
{'chosen_inline_result': ChosenInlineResult('id', User(1, '', False), '')},
|
|
|
|
{'shipping_query': ShippingQuery('id', User(1, '', False), '', None)},
|
2020-10-09 17:22:07 +02:00
|
|
|
{'pre_checkout_query': PreCheckoutQuery('id', User(1, '', False), '', 0, '')},
|
2017-08-11 23:58:41 +02:00
|
|
|
]
|
|
|
|
|
2020-10-09 17:22:07 +02:00
|
|
|
ids = (
|
|
|
|
'message',
|
|
|
|
'edited_message',
|
|
|
|
'channel_post',
|
|
|
|
'edited_channel_post',
|
|
|
|
'inline_query',
|
|
|
|
'chosen_inline_result',
|
|
|
|
'shipping_query',
|
|
|
|
'pre_checkout_query',
|
|
|
|
)
|
2017-08-11 23:58:41 +02:00
|
|
|
|
|
|
|
|
|
|
|
@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):
|
2018-09-21 08:57:01 +02:00
|
|
|
return Update(0, callback_query=CallbackQuery(2, User(1, '', False), None, data='test data'))
|
2017-08-11 23:58:41 +02:00
|
|
|
|
|
|
|
|
2020-06-15 18:20:51 +02:00
|
|
|
class TestCallbackQueryHandler:
|
2017-08-11 23:58:41 +02:00
|
|
|
test_flag = False
|
|
|
|
|
2021-05-29 16:18:16 +02:00
|
|
|
def test_slot_behaviour(self, recwarn, mro_slots):
|
|
|
|
handler = CallbackQueryHandler(self.callback_data_1, pass_user_data=True)
|
|
|
|
for attr in handler.__slots__:
|
|
|
|
assert getattr(handler, attr, 'err') != 'err', f"got extra slot '{attr}'"
|
|
|
|
assert not handler.__dict__, f"got missing slot(s): {handler.__dict__}"
|
|
|
|
assert len(mro_slots(handler)) == len(set(mro_slots(handler))), "duplicate slot"
|
|
|
|
handler.custom, handler.callback = 'should give warning', self.callback_basic
|
|
|
|
assert len(recwarn) == 1 and 'custom' in str(recwarn[0].message), recwarn.list
|
|
|
|
|
2017-08-11 23:58:41 +02:00
|
|
|
@pytest.fixture(autouse=True)
|
|
|
|
def reset(self):
|
|
|
|
self.test_flag = False
|
|
|
|
|
|
|
|
def callback_basic(self, bot, update):
|
|
|
|
test_bot = isinstance(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'}
|
|
|
|
|
2018-09-21 08:57:01 +02:00
|
|
|
def callback_context(self, update, context):
|
2020-10-09 17:22:07 +02:00
|
|
|
self.test_flag = (
|
|
|
|
isinstance(context, CallbackContext)
|
|
|
|
and isinstance(context.bot, Bot)
|
|
|
|
and isinstance(update, Update)
|
|
|
|
and isinstance(context.update_queue, Queue)
|
|
|
|
and isinstance(context.job_queue, JobQueue)
|
|
|
|
and isinstance(context.user_data, dict)
|
|
|
|
and context.chat_data is None
|
|
|
|
and isinstance(context.bot_data, dict)
|
|
|
|
and isinstance(update.callback_query, CallbackQuery)
|
|
|
|
)
|
2018-09-21 08:57:01 +02:00
|
|
|
|
|
|
|
def callback_context_pattern(self, update, context):
|
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'}
|
2018-09-21 08:57:01 +02:00
|
|
|
|
2017-08-11 23:58:41 +02:00
|
|
|
def test_basic(self, dp, callback_query):
|
|
|
|
handler = CallbackQueryHandler(self.callback_basic)
|
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
assert handler.check_update(callback_query)
|
|
|
|
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
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
|
2021-05-27 09:37:37 +02:00
|
|
|
callback_query.callback_query.game_short_name = "this is a short game name"
|
|
|
|
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)
|
|
|
|
|
2017-08-11 23:58:41 +02:00
|
|
|
def test_with_passing_group_dict(self, dp, callback_query):
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(
|
|
|
|
self.callback_group, pattern='(?P<begin>.*)est(?P<end>.*)', pass_groups=True
|
|
|
|
)
|
2017-08-11 23:58:41 +02:00
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
dp.remove_handler(handler)
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(
|
|
|
|
self.callback_group, pattern='(?P<begin>.*)est(?P<end>.*)', pass_groupdict=True
|
|
|
|
)
|
2017-08-11 23:58:41 +02:00
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
self.test_flag = False
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
def test_pass_user_or_chat_data(self, dp, callback_query):
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(self.callback_data_1, pass_user_data=True)
|
2017-08-11 23:58:41 +02:00
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
dp.remove_handler(handler)
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(self.callback_data_1, pass_chat_data=True)
|
2017-08-11 23:58:41 +02:00
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
self.test_flag = False
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
dp.remove_handler(handler)
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(
|
|
|
|
self.callback_data_2, pass_chat_data=True, pass_user_data=True
|
|
|
|
)
|
2017-08-11 23:58:41 +02:00
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
self.test_flag = False
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
def test_pass_job_or_update_queue(self, dp, callback_query):
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(self.callback_queue_1, pass_job_queue=True)
|
2017-08-11 23:58:41 +02:00
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
dp.remove_handler(handler)
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(self.callback_queue_1, pass_update_queue=True)
|
2017-08-11 23:58:41 +02:00
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
self.test_flag = False
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
dp.remove_handler(handler)
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(
|
|
|
|
self.callback_queue_2, pass_job_queue=True, pass_update_queue=True
|
|
|
|
)
|
2017-08-11 23:58:41 +02:00
|
|
|
dp.add_handler(handler)
|
|
|
|
|
|
|
|
self.test_flag = False
|
|
|
|
dp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
def test_other_update_types(self, false_update):
|
|
|
|
handler = CallbackQueryHandler(self.callback_basic)
|
|
|
|
assert not handler.check_update(false_update)
|
2018-09-21 08:57:01 +02:00
|
|
|
|
|
|
|
def test_context(self, cdp, callback_query):
|
|
|
|
handler = CallbackQueryHandler(self.callback_context)
|
|
|
|
cdp.add_handler(handler)
|
|
|
|
|
|
|
|
cdp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
def test_context_pattern(self, cdp, callback_query):
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(
|
|
|
|
self.callback_context_pattern, pattern=r'(?P<begin>.*)est(?P<end>.*)'
|
|
|
|
)
|
2018-09-21 08:57:01 +02:00
|
|
|
cdp.add_handler(handler)
|
|
|
|
|
|
|
|
cdp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
|
|
|
|
|
|
|
cdp.remove_handler(handler)
|
2020-10-09 17:22:07 +02:00
|
|
|
handler = CallbackQueryHandler(self.callback_context_pattern, pattern=r'(t)est(.*)')
|
2018-09-21 08:57:01 +02:00
|
|
|
cdp.add_handler(handler)
|
|
|
|
|
|
|
|
cdp.process_update(callback_query)
|
|
|
|
assert self.test_flag
|
2021-06-06 11:48:48 +02:00
|
|
|
|
|
|
|
def test_context_callable_pattern(self, cdp, callback_query):
|
|
|
|
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)
|
|
|
|
cdp.add_handler(handler)
|
|
|
|
|
|
|
|
cdp.process_update(callback_query)
|