OpenSource/python-telegram-bot
OpenSource/python-telegram-bot
1
0
Fork 0
mirror of https://github.com/python-telegram-bot/python-telegram-bot.git synced 2025-03-24 15:59:29 +01:00
Code Issues Projects Releases Packages Wiki Activity

Change entities filter to be singular.

Browse source 
Also remove the faulty example completely since it should be no longer needed.
This commit is contained in:
Jacob Bom 2016-09-24 13:38:56 +02:00
parent 97bb04cd38
commit e16c1da6b1
2 changed files with 11 additions and 26 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

19
telegram/ext/messagehandler.py
View file

@ -86,29 +86,19 @@ class Filters(object):
return bool(message.forward_date) return bool(message.forward_date)
@staticmethod @staticmethod
def entities(entity_types): def entity(entity_type):
"""Filters messages to only allow those which have a :class:`telegram.MessageEntity` """Filters messages to only allow those which have a :class:`telegram.MessageEntity`
that match `entity_types`. where their `type` matches `entity_type`.
Note:
This filter functions as an OR filter, meaning that just one of the entity_type.
If you want AND filtering instead, you have to specify multiple of this filter in the
`filters` attribute. Example:
>>> MessageHandler([Filters.entities([TEXT_MENTION, MENTION]),
... Filters.entities([HASHTAG])], callback)
Will require either a one type of mention AND a hashtag in the message.
Args: Args:
entity_types: List of entity types to check for. All types can be found as constants entity_type: Entity type to check for. All types can be found as constants
in :class:`telegram.MessageEntity`. in :class:`telegram.MessageEntity`.
Returns: function to use as filter Returns: function to use as filter
""" """
def entities_filter(message): def entities_filter(message):
return any([entity.type in entity_types for entity in message.entities]) return any([entity.type == entity_type for entity in message.entities])
return entities_filter return entities_filter
@ -169,6 +159,7 @@ class MessageHandler(Handler):
return self.callback(dispatcher.bot, update, **optional_args) return self.callback(dispatcher.bot, update, **optional_args)
# old non-PEP8 Handler methods # old non-PEP8 Handler methods
m = "telegram.MessageHandler." m = "telegram.MessageHandler."
checkUpdate = deprecate(check_update, m + "checkUpdate", m + "check_update") checkUpdate = deprecate(check_update, m + "checkUpdate", m + "check_update")
handleUpdate = deprecate(handle_update, m + "handleUpdate", m + "handle_update") handleUpdate = deprecate(handle_update, m + "handleUpdate", m + "handle_update")

16
tests/test_filters.py
View file

@ -155,22 +155,16 @@ class FiltersTest(BaseTest, unittest.TestCase):
e = functools.partial(MessageEntity, offset=0, length=0) e = functools.partial(MessageEntity, offset=0, length=0)
self.message.entities = [e(MessageEntity.MENTION)] self.message.entities = [e(MessageEntity.MENTION)]
self.assertTrue(Filters.entities([MessageEntity.MENTION])(self.message)) self.assertTrue(Filters.entity(MessageEntity.MENTION)(self.message))
self.message.entities = [] self.message.entities = []
self.assertFalse(Filters.entities([MessageEntity.MENTION])(self.message)) self.assertFalse(Filters.entity(MessageEntity.MENTION)(self.message))
self.message.entities = [e(MessageEntity.BOLD)] self.message.entities = [e(MessageEntity.BOLD)]
self.assertFalse(Filters.entities([MessageEntity.MENTION])(self.message)) self.assertFalse(Filters.entity(MessageEntity.MENTION)(self.message))
self.message.entities = [e(MessageEntity.MENTION)] self.message.entities = [e(MessageEntity.BOLD), e(MessageEntity.MENTION)]
self.assertTrue( self.assertTrue(Filters.entity(MessageEntity.MENTION)(self.message))
Filters.entities([MessageEntity.MENTION, MessageEntity.BOLD])(self.message))
self.message.entities = [e(MessageEntity.BOLD)]
self.assertTrue(
Filters.entities([MessageEntity.MENTION, MessageEntity.BOLD])(self.message))
self.assertFalse(
Filters.entities([MessageEntity.MENTION, MessageEntity.TEXT_MENTION])(self.message))
if __name__ == '__main__': if __name__ == '__main__':