New filters for handling messages from specific chat/user id #677

evgfilim1 · 2017-06-19T18:34:26Z

No description provided.

jsmnbom · 2017-06-19T18:38:23Z

I'd personally prefer if these filter were made a bit smarter by allowing them to use a username or a User object.
Either by doing something akin to:
def __init__(self, user_id=None, username=None, user=None):
or by doing some type checking using isinstance, so you don't need several kwargs (this might be cleaner since they would be mutually exclusive?) (or maybe not, since type checking isn't really pythonic?)

evgfilim1 · 2017-06-20T05:55:53Z

@bomjacob I think that User object is not very necessary because filters are usually used in handlers. I don't think that anyone would create User instance when they can specify user id or username

evgfilim1 · 2017-06-20T08:36:49Z

@bomjacob Done

jsmnbom · 2017-06-20T08:46:13Z

Okay yeah, that's probably true, looks good then :)
As far as error checking goes, we could probably have gotten away with simply:
if not (chat_id or username):
But I guess this works too :)

tsnoam

@evgfilim1
Thank you for you contribution. I have left some comments on the code to be fixed.
Also, I believe @bomjacob had an additional request before accepting this PR, so you can wait on fixing my comments until @bomjacob replies too.

tsnoam · 2017-06-20T20:49:48Z

telegram/ext/filters.py

@@ -324,6 +324,65 @@ def filter(self, message):

    group = _Group()

+    class user(BaseFilter):


class names are CamelCase according to pep8. Please fix.

I know about it, but in the same file we have classes, which names are not CamelCase (for example, language class below)

Yeah, we ignore pep8 in this instance @tsnoam

Sorry for the delay, just saw your replies here.

Uhm. I'm not sure.
In contrary to other fillers we provide, this filter still needs to be instantiated and cannot be used otherwise.

after discussing about it with @bomjacob I remove my objection here.
I don't think it is "pretty" but it is reasonable and makes a clear API.

tsnoam · 2017-06-20T20:51:56Z

telegram/ext/filters.py

+                specified
+            username(Optional[str]): which username to allow through. Required if user_id is not
+                specified
+


Documentation should be explicit on the fact that one and only one of user_id & username must be specified.

please add a period at the end of your sentences.

We use the extension of pep8 allowing 99 chars per line, so you can have the lines in matching size.

tsnoam · 2017-06-20T20:53:03Z

telegram/ext/filters.py

+        """
+
+        def __init__(self, user_id=None, username=None):
+            if (user_id is None and username is None) or (bool(user_id) and bool(username)):


Too complicated. You can do instead:

if not (bool(user_id) ^ bool(username)):

Thanks, I didn't know about this

tsnoam · 2017-06-20T20:53:48Z

telegram/ext/filters.py

+
+        def __init__(self, user_id=None, username=None):
+            if (user_id is None and username is None) or (bool(user_id) and bool(username)):
+                raise ValueError('You must specify either user_id or username')


I prefer:

raise ValueError('One and only one of user_id or username must be used')

tsnoam · 2017-06-20T20:56:16Z

telegram/ext/filters.py

+                return bool(message.from_user and message.from_user.username and
+                            message.from_user.username == self.username)
+
+    class chat(BaseFilter):


Same comment about CamelCase

tsnoam · 2017-06-20T21:00:17Z

telegram/ext/filters.py

+            chat_id(Optional[int]): which chat ID to allow through. Required if username is not
+                specified
+            username(Optional[str]): which username to allow through. Required if chat_id is not
+                specified


Same comments about documentation.

tsnoam · 2017-06-20T21:00:40Z

telegram/ext/filters.py

+
+        def __init__(self, chat_id=None, username=None):
+            if (chat_id is None and username is None) or (bool(chat_id) and bool(username)):
+                raise ValueError('You must specify either chat_id or username')


same comments about string to give to ValueError and how to make the if more simple.

tsnoam · 2017-06-20T21:02:05Z

tests/test_filters.py

+    def test_filters_chat(self):
+        with self.assertRaisesRegexp(ValueError, 'either chat_id or username'):
+            Filters.chat(chat_id=0, username='chat')
+            Filters.chat()


This line will never be tested. I needs to have its own with statement.

jsmnbom · 2017-06-20T21:09:11Z

Could you make it so it accepts either what it does now, or a list of said types? Something akin to https://github.com/python-telegram-bot/python-telegram-bot/blob/master/telegram/ext/filters.py#L353-L356 could probably work (and then use in instead of ==)

evgfilim1 · 2017-06-22T10:21:48Z

@tsnoam @bomjacob Done

tsnoam · 2017-06-22T18:25:58Z

@evgfilim1 thank you for your contribution.

evgfilim1 added 2 commits June 19, 2017 22:50

Added new filters for handling specific chat id and user id

5a62255

Added tests

e18ebd0

evgfilim1 added 2 commits June 20, 2017 12:43

Added ability to filter by username

9bccbda

Fixed tests

3bf4399

tsnoam requested a review from jsmnbom June 20, 2017 20:33

tsnoam assigned tsnoam and unassigned tsnoam Jun 20, 2017

tsnoam self-requested a review June 20, 2017 20:33

tsnoam requested changes Jun 20, 2017

View reviewed changes

evgfilim1 added 3 commits June 22, 2017 13:39

Simplified if statement, fixed docs

ca9068f

Added ability to process list of ids/usernames

7e81a15

Fixed tests

ecfcc69

jsmnbom approved these changes Jun 22, 2017

View reviewed changes

tsnoam approved these changes Jun 22, 2017

View reviewed changes

tsnoam merged commit 470ee86 into python-telegram-bot:master Jun 22, 2017

evgfilim1 deleted the new-filters branch June 22, 2017 19:07

github-actions bot locked and limited conversation to collaborators Aug 23, 2020

		@@ -324,6 +324,65 @@ def filter(self, message):

		group = _Group()

		class user(BaseFilter):

New filters for handling messages from specific chat/user id #677

New filters for handling messages from specific chat/user id #677

Uh oh!

Conversation

evgfilim1 commented Jun 19, 2017

Uh oh!

jsmnbom commented Jun 19, 2017

Uh oh!

evgfilim1 commented Jun 20, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

evgfilim1 commented Jun 20, 2017

Uh oh!

jsmnbom commented Jun 20, 2017

Uh oh!

tsnoam left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

jsmnbom commented Jun 20, 2017

Uh oh!

evgfilim1 commented Jun 22, 2017

Uh oh!

tsnoam commented Jun 22, 2017

Uh oh!

Uh oh!

evgfilim1 commented Jun 20, 2017 •

edited

Loading