mirror of
https://github.com/python-telegram-bot/python-telegram-bot.git
synced 2024-12-01 12:41:48 +01:00
470ee86497
New filters for handling messages from specific chat/user id
379 lines
16 KiB
Python
379 lines
16 KiB
Python
#!/usr/bin/env python
|
|
#
|
|
# A library that provides a Python interface to the Telegram Bot API
|
|
# Copyright (C) 2015-2017
|
|
# 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 General 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 General Public License for more details.
|
|
#
|
|
# You should have received a copy of the GNU General Public License
|
|
# along with this program. If not, see [http://www.gnu.org/licenses/].
|
|
"""
|
|
This module contains an object that represents Tests for Filters for use with MessageHandler.
|
|
"""
|
|
|
|
import sys
|
|
import unittest
|
|
from datetime import datetime
|
|
import functools
|
|
|
|
sys.path.append('.')
|
|
|
|
from telegram import Message, User, Chat, MessageEntity
|
|
from telegram.ext import Filters, BaseFilter
|
|
from tests.base import BaseTest
|
|
|
|
|
|
class FiltersTest(BaseTest, unittest.TestCase):
|
|
"""This object represents Tests for MessageHandler.Filters"""
|
|
|
|
def setUp(self):
|
|
self.message = Message(0, User(0, "Testuser"), datetime.now(), Chat(0, 'private'))
|
|
self.e = functools.partial(MessageEntity, offset=0, length=0)
|
|
|
|
def test_filters_text(self):
|
|
self.message.text = 'test'
|
|
self.assertTrue(Filters.text(self.message))
|
|
self.message.text = '/test'
|
|
self.assertFalse(Filters.text(self.message))
|
|
|
|
def test_filters_command(self):
|
|
self.message.text = 'test'
|
|
self.assertFalse(Filters.command(self.message))
|
|
self.message.text = '/test'
|
|
self.assertTrue(Filters.command(self.message))
|
|
|
|
def test_filters_reply(self):
|
|
another_message = Message(1, User(1, "TestOther"), datetime.now(), Chat(0, 'private'))
|
|
self.message.text = 'test'
|
|
self.assertFalse(Filters.reply(self.message))
|
|
self.message.reply_to_message = another_message
|
|
self.assertTrue(Filters.reply(self.message))
|
|
|
|
def test_filters_audio(self):
|
|
self.message.audio = 'test'
|
|
self.assertTrue(Filters.audio(self.message))
|
|
self.message.audio = None
|
|
self.assertFalse(Filters.audio(self.message))
|
|
|
|
def test_filters_document(self):
|
|
self.message.document = 'test'
|
|
self.assertTrue(Filters.document(self.message))
|
|
self.message.document = None
|
|
self.assertFalse(Filters.document(self.message))
|
|
|
|
def test_filters_photo(self):
|
|
self.message.photo = 'test'
|
|
self.assertTrue(Filters.photo(self.message))
|
|
self.message.photo = None
|
|
self.assertFalse(Filters.photo(self.message))
|
|
|
|
def test_filters_sticker(self):
|
|
self.message.sticker = 'test'
|
|
self.assertTrue(Filters.sticker(self.message))
|
|
self.message.sticker = None
|
|
self.assertFalse(Filters.sticker(self.message))
|
|
|
|
def test_filters_video(self):
|
|
self.message.video = 'test'
|
|
self.assertTrue(Filters.video(self.message))
|
|
self.message.video = None
|
|
self.assertFalse(Filters.video(self.message))
|
|
|
|
def test_filters_voice(self):
|
|
self.message.voice = 'test'
|
|
self.assertTrue(Filters.voice(self.message))
|
|
self.message.voice = None
|
|
self.assertFalse(Filters.voice(self.message))
|
|
|
|
def test_filters_contact(self):
|
|
self.message.contact = 'test'
|
|
self.assertTrue(Filters.contact(self.message))
|
|
self.message.contact = None
|
|
self.assertFalse(Filters.contact(self.message))
|
|
|
|
def test_filters_location(self):
|
|
self.message.location = 'test'
|
|
self.assertTrue(Filters.location(self.message))
|
|
self.message.location = None
|
|
self.assertFalse(Filters.location(self.message))
|
|
|
|
def test_filters_venue(self):
|
|
self.message.venue = 'test'
|
|
self.assertTrue(Filters.venue(self.message))
|
|
self.message.venue = None
|
|
self.assertFalse(Filters.venue(self.message))
|
|
|
|
def test_filters_game(self):
|
|
self.message.game = 'test'
|
|
self.assertTrue(Filters.game(self.message))
|
|
self.message.game = None
|
|
self.assertFalse(Filters.game(self.message))
|
|
|
|
def test_filters_successful_payment(self):
|
|
self.message.successful_payment = 'test'
|
|
self.assertTrue(Filters.successful_payment(self.message))
|
|
self.message.successful_payment = None
|
|
self.assertFalse(Filters.successful_payment(self.message))
|
|
|
|
def test_filters_invoice(self):
|
|
self.message.invoice = 'test'
|
|
self.assertTrue(Filters.invoice(self.message))
|
|
self.message.invoice = None
|
|
self.assertFalse(Filters.invoice(self.message))
|
|
|
|
def test_filters_status_update(self):
|
|
self.assertFalse(Filters.status_update(self.message))
|
|
|
|
self.message.new_chat_members = ['test']
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.new_chat_members(self.message))
|
|
self.message.new_chat_members = None
|
|
|
|
self.message.left_chat_member = 'test'
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.left_chat_member(self.message))
|
|
self.message.left_chat_member = None
|
|
|
|
self.message.new_chat_title = 'test'
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.new_chat_title(self.message))
|
|
self.message.new_chat_title = ''
|
|
|
|
self.message.new_chat_photo = 'test'
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.new_chat_photo(self.message))
|
|
self.message.new_chat_photo = None
|
|
|
|
self.message.delete_chat_photo = True
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.delete_chat_photo(self.message))
|
|
self.message.delete_chat_photo = False
|
|
|
|
self.message.group_chat_created = True
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.chat_created(self.message))
|
|
self.message.group_chat_created = False
|
|
|
|
self.message.supergroup_chat_created = True
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.chat_created(self.message))
|
|
self.message.supergroup_chat_created = False
|
|
|
|
self.message.migrate_to_chat_id = 100
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.migrate(self.message))
|
|
self.message.migrate_to_chat_id = 0
|
|
|
|
self.message.migrate_from_chat_id = 100
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.migrate(self.message))
|
|
self.message.migrate_from_chat_id = 0
|
|
|
|
self.message.channel_chat_created = True
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.chat_created(self.message))
|
|
self.message.channel_chat_created = False
|
|
|
|
self.message.pinned_message = 'test'
|
|
self.assertTrue(Filters.status_update(self.message))
|
|
self.assertTrue(Filters.status_update.pinned_message(self.message))
|
|
self.message.pinned_message = None
|
|
|
|
def test_entities_filter(self):
|
|
self.message.entities = [self.e(MessageEntity.MENTION)]
|
|
self.assertTrue(Filters.entity(MessageEntity.MENTION)(self.message))
|
|
|
|
self.message.entities = []
|
|
self.assertFalse(Filters.entity(MessageEntity.MENTION)(self.message))
|
|
|
|
self.message.entities = [self.e(MessageEntity.BOLD)]
|
|
self.assertFalse(Filters.entity(MessageEntity.MENTION)(self.message))
|
|
|
|
self.message.entities = [self.e(MessageEntity.BOLD), self.e(MessageEntity.MENTION)]
|
|
self.assertTrue(Filters.entity(MessageEntity.MENTION)(self.message))
|
|
|
|
def test_private_filter(self):
|
|
self.assertTrue(Filters.private(self.message))
|
|
self.message.chat.type = "group"
|
|
self.assertFalse(Filters.private(self.message))
|
|
|
|
def test_group_fileter(self):
|
|
self.assertFalse(Filters.group(self.message))
|
|
self.message.chat.type = "group"
|
|
self.assertTrue(Filters.group(self.message))
|
|
self.message.chat.type = "supergroup"
|
|
self.assertTrue(Filters.group(self.message))
|
|
|
|
def test_filters_chat(self):
|
|
with self.assertRaisesRegexp(ValueError, 'chat_id or username'):
|
|
Filters.chat(chat_id=-1, username='chat')
|
|
with self.assertRaisesRegexp(ValueError, 'chat_id or username'):
|
|
Filters.chat()
|
|
|
|
def test_filters_chat_id(self):
|
|
self.assertFalse(Filters.chat(chat_id=-1)(self.message))
|
|
self.message.chat.id = -1
|
|
self.assertTrue(Filters.chat(chat_id=-1)(self.message))
|
|
self.message.chat.id = -2
|
|
self.assertTrue(Filters.chat(chat_id=[-1, -2])(self.message))
|
|
self.assertFalse(Filters.chat(chat_id=-1)(self.message))
|
|
|
|
def test_filters_chat_username(self):
|
|
self.assertFalse(Filters.chat(username='chat')(self.message))
|
|
self.message.chat.username = 'chat'
|
|
self.assertTrue(Filters.chat(username='@chat')(self.message))
|
|
self.assertTrue(Filters.chat(username='chat')(self.message))
|
|
self.assertTrue(Filters.chat(username=['chat1', 'chat', 'chat2'])(self.message))
|
|
self.assertFalse(Filters.chat(username=['@chat1', 'chat_2'])(self.message))
|
|
|
|
def test_filters_user(self):
|
|
with self.assertRaisesRegexp(ValueError, 'user_id or username'):
|
|
Filters.user(user_id=1, username='user')
|
|
with self.assertRaisesRegexp(ValueError, 'user_id or username'):
|
|
Filters.user()
|
|
|
|
def test_filters_user_id(self):
|
|
self.assertFalse(Filters.user(user_id=1)(self.message))
|
|
self.message.from_user.id = 1
|
|
self.assertTrue(Filters.user(user_id=1)(self.message))
|
|
self.message.from_user.id = 2
|
|
self.assertTrue(Filters.user(user_id=[1, 2])(self.message))
|
|
self.assertFalse(Filters.user(user_id=1)(self.message))
|
|
|
|
def test_filters_username(self):
|
|
self.assertFalse(Filters.user(username='user')(self.message))
|
|
self.assertFalse(Filters.user(username='Testuser')(self.message))
|
|
self.message.from_user.username = 'user'
|
|
self.assertTrue(Filters.user(username='@user')(self.message))
|
|
self.assertTrue(Filters.user(username='user')(self.message))
|
|
self.assertTrue(Filters.user(username=['user1', 'user', 'user2'])(self.message))
|
|
self.assertFalse(Filters.user(username=['@username', '@user_2'])(self.message))
|
|
|
|
def test_and_filters(self):
|
|
self.message.text = 'test'
|
|
self.message.forward_date = True
|
|
self.assertTrue((Filters.text & Filters.forwarded)(self.message))
|
|
self.message.text = '/test'
|
|
self.assertFalse((Filters.text & Filters.forwarded)(self.message))
|
|
self.message.text = 'test'
|
|
self.message.forward_date = None
|
|
self.assertFalse((Filters.text & Filters.forwarded)(self.message))
|
|
|
|
self.message.text = 'test'
|
|
self.message.forward_date = True
|
|
self.message.entities = [self.e(MessageEntity.MENTION)]
|
|
self.assertTrue((Filters.text & Filters.forwarded & Filters.entity(MessageEntity.MENTION))(
|
|
self.message))
|
|
self.message.entities = [self.e(MessageEntity.BOLD)]
|
|
self.assertFalse((Filters.text & Filters.forwarded & Filters.entity(MessageEntity.MENTION)
|
|
)(self.message))
|
|
|
|
def test_or_filters(self):
|
|
self.message.text = 'test'
|
|
self.assertTrue((Filters.text | Filters.status_update)(self.message))
|
|
self.message.group_chat_created = True
|
|
self.assertTrue((Filters.text | Filters.status_update)(self.message))
|
|
self.message.text = None
|
|
self.assertTrue((Filters.text | Filters.status_update)(self.message))
|
|
self.message.group_chat_created = False
|
|
self.assertFalse((Filters.text | Filters.status_update)(self.message))
|
|
|
|
def test_and_or_filters(self):
|
|
self.message.text = 'test'
|
|
self.message.forward_date = True
|
|
self.assertTrue((Filters.text & (Filters.forwarded | Filters.entity(MessageEntity.MENTION))
|
|
)(self.message))
|
|
self.message.forward_date = False
|
|
self.assertFalse((Filters.text & (Filters.forwarded | Filters.entity(MessageEntity.MENTION)
|
|
))(self.message))
|
|
self.message.entities = [self.e(MessageEntity.MENTION)]
|
|
self.assertTrue((Filters.text & (Filters.forwarded | Filters.entity(MessageEntity.MENTION))
|
|
)(self.message))
|
|
|
|
self.assertEqual(
|
|
str((Filters.text & (Filters.forwarded | Filters.entity(MessageEntity.MENTION)))),
|
|
'<Filters.text and <Filters.forwarded or Filters.entity(mention)>>'
|
|
)
|
|
|
|
def test_inverted_filters(self):
|
|
self.message.text = '/test'
|
|
self.assertTrue((Filters.command)(self.message))
|
|
self.assertFalse((~Filters.command)(self.message))
|
|
self.message.text = 'test'
|
|
self.assertFalse((Filters.command)(self.message))
|
|
self.assertTrue((~Filters.command)(self.message))
|
|
|
|
def test_inverted_and_filters(self):
|
|
self.message.text = '/test'
|
|
self.message.forward_date = 1
|
|
self.assertTrue((Filters.forwarded & Filters.command)(self.message))
|
|
self.assertFalse((~Filters.forwarded & Filters.command)(self.message))
|
|
self.assertFalse((Filters.forwarded & ~Filters.command)(self.message))
|
|
self.assertFalse((~(Filters.forwarded & Filters.command))(self.message))
|
|
self.message.forward_date = None
|
|
self.assertFalse((Filters.forwarded & Filters.command)(self.message))
|
|
self.assertTrue((~Filters.forwarded & Filters.command)(self.message))
|
|
self.assertFalse((Filters.forwarded & ~Filters.command)(self.message))
|
|
self.assertTrue((~(Filters.forwarded & Filters.command))(self.message))
|
|
self.message.text = 'test'
|
|
self.assertFalse((Filters.forwarded & Filters.command)(self.message))
|
|
self.assertFalse((~Filters.forwarded & Filters.command)(self.message))
|
|
self.assertFalse((Filters.forwarded & ~Filters.command)(self.message))
|
|
self.assertTrue((~(Filters.forwarded & Filters.command))(self.message))
|
|
|
|
def test_faulty_custom_filter(self):
|
|
|
|
class _CustomFilter(BaseFilter):
|
|
pass
|
|
|
|
custom = _CustomFilter()
|
|
|
|
with self.assertRaises(NotImplementedError):
|
|
(custom & Filters.text)(self.message)
|
|
|
|
def test_language_filter_single(self):
|
|
self.message.from_user.language_code = 'en_US'
|
|
self.assertTrue((Filters.language('en_US'))(self.message))
|
|
self.assertTrue((Filters.language('en'))(self.message))
|
|
self.assertFalse((Filters.language('en_GB'))(self.message))
|
|
self.assertFalse((Filters.language('da'))(self.message))
|
|
self.message.from_user.language_code = 'en_GB'
|
|
self.assertFalse((Filters.language('en_US'))(self.message))
|
|
self.assertTrue((Filters.language('en'))(self.message))
|
|
self.assertTrue((Filters.language('en_GB'))(self.message))
|
|
self.assertFalse((Filters.language('da'))(self.message))
|
|
self.message.from_user.language_code = 'da'
|
|
self.assertFalse((Filters.language('en_US'))(self.message))
|
|
self.assertFalse((Filters.language('en'))(self.message))
|
|
self.assertFalse((Filters.language('en_GB'))(self.message))
|
|
self.assertTrue((Filters.language('da'))(self.message))
|
|
|
|
def test_language_filter_multiple(self):
|
|
f = Filters.language(['en_US', 'da'])
|
|
self.message.from_user.language_code = 'en_US'
|
|
self.assertTrue(f(self.message))
|
|
self.message.from_user.language_code = 'en_GB'
|
|
self.assertFalse(f(self.message))
|
|
self.message.from_user.language_code = 'da'
|
|
self.assertTrue(f(self.message))
|
|
|
|
def test_custom_unnamed_filter(self):
|
|
class Unnamed(BaseFilter):
|
|
def filter(self, message):
|
|
return True
|
|
|
|
unnamed = Unnamed()
|
|
self.assertEqual(str(unnamed), Unnamed.__name__)
|
|
|
|
|
|
if __name__ == '__main__':
|
|
unittest.main()
|