Skip to content

Add a caption_entity filter for filtering caption entities #1068

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

Merged
jh0ker merged 2 commits into from
Apr 20, 2018
Merged

Add a caption_entity filter for filtering caption entities #1068

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
8a1bccb
Add a caption_entity filter for filtering caption entities
PaulSonOfLars Apr 8, 2018
0ed2e20
remove unneeded list comprehensions
PaulSonOfLars Apr 18, 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
23 changes: 22 additions & 1 deletion telegram/ext/filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -532,7 +532,28 @@ def __init__(self, entity_type):
self.name = 'Filters.entity({})'.format(self.entity_type)

def filter(self, message):
return any([entity.type == self.entity_type for entity in message.entities])
return any(entity.type == self.entity_type for entity in message.entities)
Copy link
Member

@jh0ker jh0ker Apr 20, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for fixing this too 😄


class caption_entity(BaseFilter):
"""
Filters media messages to only allow those which have a :class:`telegram.MessageEntity`
where their `type` matches `entity_type`.

Examples:
Example ``MessageHandler(Filters.caption_entity("hashtag"), callback_method)``

Args:
entity_type: Caption Entity type to check for. All types can be found as constants
in :class:`telegram.MessageEntity`.

"""

def __init__(self, entity_type):
self.entity_type = entity_type
self.name = 'Filters.caption_entity({})'.format(self.entity_type)

def filter(self, message):
return any(entity.type == self.entity_type for entity in message.caption_entities)

class _Private(BaseFilter):
name = 'Filters.private'
Expand Down
15 changes: 15 additions & 0 deletions tests/test_filters.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -305,6 +305,21 @@ def test_entities_filter(self, message, message_entity):
second = MessageEntity.de_json(second, None)
message.entities = [message_entity, second]
assert Filters.entity(message_entity.type)(message)
assert not Filters.caption_entity(message_entity.type)(message)

def test_caption_entities_filter(self, message, message_entity):
message.caption_entities = [message_entity]
assert Filters.caption_entity(message_entity.type)(message)

message.caption_entities = []
assert not Filters.caption_entity(MessageEntity.MENTION)(message)

second = message_entity.to_dict()
second['type'] = 'bold'
second = MessageEntity.de_json(second, None)
message.caption_entities = [message_entity, second]
assert Filters.caption_entity(message_entity.type)(message)
assert not Filters.entity(message_entity.type)(message)

def test_private_filter(self, message):
assert Filters.private(message)
Expand Down