Add Parameter game_pattern to CallbackQueryHandler (#4353)

This commit is contained in:
Jãїиãм 2024-07-14 00:56:44 +05:30 committed by GitHub
parent 2ac4e009d0
commit 422993b8ab
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
3 changed files with 99 additions and 18 deletions

View file

@ -60,6 +60,7 @@ The following wonderful people contributed directly or indirectly to this projec
- `Hugo Damer <https://github.com/HakimusGIT>`_
- `ihoru <https://github.com/ihoru>`_
- `Iulian Onofrei <https://github.com/revolter>`_
- `Jainam Oswal <https://github.com/jainamoswal>`_
- `Jasmin Bom <https://github.com/jsmnbom>`_
- `JASON0916 <https://github.com/JASON0916>`_
- `jeffffc <https://github.com/jeffffc>`_

View file

@ -51,6 +51,15 @@ class CallbackQueryHandler(BaseHandler[Update, CCT]):
.. versionadded:: 13.6
* If neither :paramref:`pattern` nor :paramref:`game_pattern` is set, `any`
``CallbackQuery`` will be handled. If only :paramref:`pattern` is set, queries with
:attr:`~telegram.CallbackQuery.game_short_name` will `not` be considered and vice versa.
If both patterns are set, queries with either :attr:
`~telegram.CallbackQuery.game_short_name` or :attr:`~telegram.CallbackQuery.data`
matching the defined pattern will be handled
.. versionadded:: NEXT.VERSION
Warning:
When setting :paramref:`block` to :obj:`False`, you cannot rely on adding custom
attributes to :class:`telegram.ext.CallbackContext`. See its docs for more info.
@ -85,6 +94,13 @@ class CallbackQueryHandler(BaseHandler[Update, CCT]):
.. versionchanged:: 13.6
Added support for arbitrary callback data.
game_pattern (:obj:`str` | :func:`re.Pattern <re.compile>` | optional)
Pattern to test :attr:`telegram.CallbackQuery.game_short_name` against. If a string or
a regex pattern is passed, :func:`re.match` is used on
:attr:`telegram.CallbackQuery.game_short_name` to determine if an update should be
handled by this handler.
.. versionadded:: NEXT.VERSION
block (:obj:`bool`, optional): Determines whether the return value of the callback should
be awaited before processing the next handler in
:meth:`telegram.ext.Application.process_update`. Defaults to :obj:`True`.
@ -98,13 +114,15 @@ class CallbackQueryHandler(BaseHandler[Update, CCT]):
.. versionchanged:: 13.6
Added support for arbitrary callback data.
game_pattern (:func:`re.Pattern <re.compile>`): Optional.
Regex pattern to test :attr:`telegram.CallbackQuery.game_short_name`
block (:obj:`bool`): Determines whether the return value of the callback should be
awaited before processing the next handler in
:meth:`telegram.ext.Application.process_update`.
"""
__slots__ = ("pattern",)
__slots__ = ("game_pattern", "pattern")
def __init__(
self,
@ -112,6 +130,7 @@ class CallbackQueryHandler(BaseHandler[Update, CCT]):
pattern: Optional[
Union[str, Pattern[str], type, Callable[[object], Optional[bool]]]
] = None,
game_pattern: Optional[Union[str, Pattern[str]]] = None,
block: DVType[bool] = DEFAULT_TRUE,
):
super().__init__(callback, block=block)
@ -120,13 +139,15 @@ class CallbackQueryHandler(BaseHandler[Update, CCT]):
raise TypeError(
"The `pattern` must not be a coroutine function! Use an ordinary function instead."
)
if isinstance(pattern, str):
pattern = re.compile(pattern)
if isinstance(game_pattern, str):
game_pattern = re.compile(game_pattern)
self.pattern: Optional[
Union[str, Pattern[str], type, Callable[[object], Optional[bool]]]
] = pattern
self.game_pattern: Optional[Union[str, Pattern[str]]] = game_pattern
def check_update(self, update: object) -> Optional[Union[bool, object]]:
"""Determines whether an update should be passed to this handler's :attr:`callback`.
@ -139,22 +160,37 @@ class CallbackQueryHandler(BaseHandler[Update, CCT]):
"""
# pylint: disable=too-many-return-statements
if isinstance(update, Update) and update.callback_query:
callback_data = update.callback_query.data
if self.pattern:
if callback_data is None:
return False
if isinstance(self.pattern, type):
return isinstance(callback_data, self.pattern)
if callable(self.pattern):
return self.pattern(callback_data)
if not isinstance(callback_data, str):
return False
if match := re.match(self.pattern, callback_data):
return match
else:
return True
return None
if not (isinstance(update, Update) and update.callback_query):
return None
callback_data = update.callback_query.data
game_short_name = update.callback_query.game_short_name
if not any([self.pattern, self.game_pattern]):
return True
# we check for .data or .game_short_name from update to filter based on whats coming
# this gives xor-like behavior
if callback_data:
if not self.pattern:
return False
if isinstance(self.pattern, type):
return isinstance(callback_data, self.pattern)
if callable(self.pattern):
return self.pattern(callback_data)
if not isinstance(callback_data, str):
return False
if match := re.match(self.pattern, callback_data):
return match
elif game_short_name:
if not self.game_pattern:
return False
if match := re.match(self.game_pattern, game_short_name):
return match
else:
return True
return False
def collect_additional_context(
self,

View file

@ -228,3 +228,47 @@ class TestCallbackQueryHandler:
with pytest.raises(TypeError, match="must not be a coroutine function"):
CallbackQueryHandler(self.callback, pattern=pattern)
def test_game_pattern(self, callback_query):
callback_query.callback_query.data = None
callback_query.callback_query.game_short_name = "test data"
handler = CallbackQueryHandler(self.callback_basic, game_pattern=".*est.*")
assert handler.check_update(callback_query)
callback_query.callback_query.game_short_name = "nothing here"
assert not handler.check_update(callback_query)
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 = "something"
handler = CallbackQueryHandler(self.callback_basic, game_pattern="")
assert not handler.check_update(callback_query)
@pytest.mark.parametrize(
("data", "pattern", "game_short_name", "game_pattern", "expected_result"),
[
(None, None, None, None, True),
(None, ".*data", None, None, True),
(None, None, None, ".*game", True),
(None, ".*data", None, ".*game", True),
("some_data", None, None, None, True),
("some_data", ".*data", None, None, True),
("some_data", None, None, ".*game", False),
("some_data", ".*data", None, ".*game", True),
(None, None, "some_game", None, True),
(None, ".*data", "some_game", None, False),
(None, None, "some_game", ".*game", True),
(None, ".*data", "some_game", ".*game", True),
],
)
def test_pattern_and_game_pattern_interaction(
self, callback_query, data, pattern, game_short_name, game_pattern, expected_result
):
callback_query.callback_query.data = data
callback_query.callback_query.game_short_name = game_short_name
handler = CallbackQueryHandler(
callback=self.callback, pattern=pattern, game_pattern=game_pattern
)
assert bool(handler.check_update(callback_query)) == expected_result