Skip to content

Add msg_in filter #1144

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
icekom wants to merge 7 commits into from
Closed

Add msg_in filter #1144

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
4d606f7
Add list filter
Jun 25, 2018
9c9bf49
Fix typo
Jun 25, 2018
71f5b03
Use {!r} instead of repr
Jul 9, 2018
fbcff76
Rename filter and add caption argument
Jul 9, 2018
1b45a74
Update docstring and self.name
Jul 23, 2018
bcd8067
Add test for msg_in filter
Jul 23, 2018
2ba37b1
Update AUTHORS.rst
Aug 26, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions AUTHORS.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ The following wonderful people contributed directly or indirectly to this projec
- `d-qoi <https://github.com/d-qoi>`_
- `daimajia <https://github.com/daimajia>`_
- `Daniel Reed <https://github.com/nmlorg>`_
- `Dmitry Grigoryev <https://github.com/icecom-dg>`_
- `Eli Gao <https://github.com/eligao>`_
- `Emilio Molinari <https://github.com/xates>`_
- `ErgoZ Riftbit Vaper <https://github.com/ergoz>`_
Expand Down
27 changes: 27 additions & 0 deletions telegram/ext/filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -701,3 +701,30 @@ def __init__(self, lang):
def filter(self, message):
return message.from_user.language_code and any(
[message.from_user.language_code.startswith(x) for x in self.lang])

class msg_in(BaseFilter):
"""Filters messages to only allow those which exist in a list.

Examples:
``MessageHandler(Filters.msg_in(['i love python',]), callback_method)``

Args:
list_ (List[:obj:`str`]): Which messages to allow through. Only exact matches
are allowed.
caption (:obj:`bool`): Optional. Should the caption be used instead of text?
Default is ``False``.

"""

def __init__(self, list_, caption=False):
self.list_ = list_
self.caption = caption
self.name = 'Filters.msg_in({!r}, caption={!r})'.format(self.list_, self.caption)

def filter(self, message):
if self.caption:
txt = message.caption
else:
txt = message.text

return txt in self.list_
10 changes: 10 additions & 0 deletions tests/test_filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -414,6 +414,16 @@ def test_language_filter_multiple(self, message):
message.from_user.language_code = 'da'
assert f(message)

def test_msg_in_filter(self, message):
message.text = 'test'
message.caption = 'caption'

assert Filters.msg_in(['test'])(message)
assert Filters.msg_in(['caption'], caption=True)(message)

assert not Filters.msg_in(['test'], caption=True)(message)
assert not Filters.msg_in(['caption'])(message)

def test_and_filters(self, message):
message.text = 'test'
message.forward_date = True
Expand Down