Update Filters, CommandHandler and MessageHandler #1221

Eldinnie · 2018-09-21T12:46:35Z

See #1117 for discussion

Makes it possible to have filters work on an update instead of message, while keeping behavior for current filters

- remove allow_edited (deprecated for a while) - set deprecated defaults to None - Raise deprecation warning when they're used - add sensible defaults for filters. - rework tests

- rename update_types -> updates - added some clarification to docstrings

jsmnbom

While I do think that this change is overall good, it does introduce quite a lot of complexity to the user that wasn't there before (kwargs are easier to understand than negating filters imo). Therefore we need to be really sure that our docs are good.
That said, I think it mostly looks good. Mostly nitpicks :)

telegram/ext/commandhandler.py

telegram/ext/filters.py

telegram/ext/messagehandler.py

telegram/ext/commandhandler.py

tests/test_bot.py

telegram/ext/commandhandler.py

Makes it possible to have filters work on an update instead of message, while keeping behavior for current filters

- remove allow_edited (deprecated for a while) - set deprecated defaults to None - Raise deprecation warning when they're used - add sensible defaults for filters. - rework tests

- rename update_types -> updates - added some clarification to docstrings

Eldinnie · 2018-10-01T08:30:51Z

Can't figure out how to get it to build on CI. Guess we will see when we merge onto v12 and then PR v12 onto pmaster

telegram/ext/filters.py

jsmnbom · 2018-10-01T09:27:32Z

Might wanna remove the v12 from travis again. Though I wonder if the reason its not working is because of case sensitivity?
Or maybe the travis.yml file with "v12" needs to actually be on the v12 branch? (in which case just keep it like it is - maybe even change it so that it builds master and /^[vV]\d+$/

Eldinnie · 2018-10-04T09:12:23Z

Ok,

The last thing we need to decide IMO is what to do with context.match and Filters.regex
A couple of things have passed as an option:

Allow only one Filters.regex and out it's result in context.match
- To decide. What to do when multiple regex filters are added?
Change context.match -> context.matches which will be a list.
- will contain all the match object for regex filters (in sequential order)
- means we will have to change regexhandler to also add it as a list
- Will allow for phasing out RegexHandler and thus reducing the numbers of handlers (RegexHandler can then be substituted with MessageHandler(Filters.regex,. ..) for the same functionality

I prefer the second option.

tsnoam · 2018-10-04T19:30:35Z

@Eldinnie

I prefer the second option.

I agree with you here.

Also I suggest to keep RegexHandler as a wrapper over the new MessageHandler.
In general I think that for common patterns we should have wrappers as they'll be more user friendly.

tsnoam · 2018-10-04T19:41:03Z

after discussing the concept of the wrapper in the developers group I now understand that:

The old RegexHandler will have less functionality than MessageHandler - it will be missing the filters argument.
By adding the filters argument to RegexHandler it will be identical to MessageHandler

As of the above I change my mind on the subject of wrappers and suggest that we don't add filters argument toRegexHandler. Instead we should mark the entire handler as deprecated (and issue a warning).

jsmnbom · 2018-10-04T21:45:25Z

I agree with that 👍

Now returns a list of match objects for every regexfilter

And raise deprecationWarning on creation

telegram/ext/filters.py

telegram/ext/messagehandler.py

- use data_filter instead of regex_filter on BaseFilter - have these filters return a dict that is then updated onto CallbackContext instead of using a list is before - Add a .match property on CallbackContext that returns .matches[0] or None

Too many changes since review

jsmnbom · 2019-02-13T11:07:17Z

Gave another lookover, merging with the intention of releasing a V12 beta to squash bugs.

Eldinnie added 7 commits May 22, 2018 22:28

update_filter attribute on filters

c5d5680

Makes it possible to have filters work on an update instead of message, while keeping behavior for current filters

add update_type filter

a9c166d

Messagehandler rework

bb54b19

- remove allow_edited (deprecated for a while) - set deprecated defaults to None - Raise deprecation warning when they're used - add sensible defaults for filters. - rework tests

Commandhandler rework

5220aef

Remove deprecation test from new handler

a5f8412

Some tweaks per CR

391fb03

- rename update_types -> updates - added some clarification to docstrings

run webhook set test only on 3.6 on appveyor

d3cb62a

Eldinnie changed the base branch from master to V12 September 21, 2018 12:47

jsmnbom requested changes Sep 21, 2018

View reviewed changes

Eldinnie added 8 commits September 21, 2018 15:03

update_filter attribute on filters

417f473

Makes it possible to have filters work on an update instead of message, while keeping behavior for current filters

add update_type filter

cc30125

Messagehandler rework

afdf63a

- remove allow_edited (deprecated for a while) - set deprecated defaults to None - Raise deprecation warning when they're used - add sensible defaults for filters. - rework tests

Commandhandler rework

84b8e43

Remove deprecation test from new handler

0e8bcd2

Some tweaks per CR

0e3377a

- rename update_types -> updates - added some clarification to docstrings

run webhook set test only on 3.6 on appveyor

b749570

Merge remote-tracking branch 'origin/filters-rework' into filters-rework

fc7b00f

jsmnbom modified the milestones: V11, V12 Sep 25, 2018

jsmnbom mentioned this pull request Sep 25, 2018

Channel filter #1104

Closed

Eldinnie added 3 commits October 1, 2018 10:13

Changes per CR

68f03fc

Update travis to build v12

06de977

small doc update

ad40d38

jsmnbom reviewed Oct 1, 2018

View reviewed changes

telegram/ext/filters.py Show resolved Hide resolved

jsmnbom previously approved these changes Oct 1, 2018

View reviewed changes

try to make ci build version branches

c05e641

Eldinnie mentioned this pull request Oct 1, 2018

V12 #1230

Closed

Eldinnie added 2 commits October 4, 2018 09:42

Merge branch 'V12' into filters-rework

c5a69ff

doc for BaseFilter

131ef85

Eldinnie added 6 commits October 5, 2018 15:07

Modify regexfilter and mergedfilter

c3cb0b1

Now returns a list of match objects for every regexfilter

Change callbackcontext (+ docs)

471b1ec

integrate in CommandHandler and PrefixHandler

ab60c7b

integrate in MessageHandler

c7bf56a

cbqhandler, iqhandler and srhandler

3c6890c

make regexhandler a shell over MessageHandler

e2b8a5b

And raise deprecationWarning on creation

Eldinnie requested a review from tsnoam October 8, 2018 14:08

jsmnbom reviewed Oct 8, 2018

View reviewed changes

telegram/ext/filters.py Outdated Show resolved Hide resolved

telegram/ext/filters.py Outdated Show resolved Hide resolved

telegram/ext/filters.py Show resolved Hide resolved

telegram/ext/messagehandler.py Outdated Show resolved Hide resolved

Eldinnie and others added 2 commits October 9, 2018 11:09

clean up code and add some comments

c6ca20b

Merge branch 'V12' into filters-rework

149fce9

jsmnbom mentioned this pull request Feb 8, 2019

Create Filters.channel #1327

Closed

jsmnbom added 4 commits February 8, 2019 20:16

Rework based on internal group feedback

dcbf341

- use data_filter instead of regex_filter on BaseFilter - have these filters return a dict that is then updated onto CallbackContext instead of using a list is before - Add a .match property on CallbackContext that returns .matches[0] or None

Merge branch 'V12' into filters-rework

85ad92a

Merge branch 'V12' into filters-rework

0b00b66

Fix and add test for callbackcontext.match

a35d908

Lots of documentation fixes and improvements [ci skip]

fb61fe9

jsmnbom merged commit 2c5eade into V12 Feb 13, 2019

jsmnbom mentioned this pull request Feb 13, 2019

Inheiting docstring for Filter.filter is highly confusing in documentation #1339

Closed

Eldinnie deleted the filters-rework branch February 14, 2019 12:49

jh0ker mentioned this pull request Nov 1, 2019

Custom Filters: Wiki and code are in conflict #1595

Closed

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

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Update Filters, CommandHandler and MessageHandler #1221

Update Filters, CommandHandler and MessageHandler #1221

Eldinnie commented Sep 21, 2018

jsmnbom left a comment

Eldinnie commented Oct 1, 2018

jsmnbom commented Oct 1, 2018

Eldinnie commented Oct 4, 2018

tsnoam commented Oct 4, 2018

tsnoam commented Oct 4, 2018

jsmnbom commented Oct 4, 2018

jsmnbom commented Feb 13, 2019

Update Filters, CommandHandler and MessageHandler #1221

Update Filters, CommandHandler and MessageHandler #1221

Conversation

Eldinnie commented Sep 21, 2018

jsmnbom left a comment

Choose a reason for hiding this comment

Eldinnie commented Oct 1, 2018

jsmnbom commented Oct 1, 2018

Eldinnie commented Oct 4, 2018

tsnoam commented Oct 4, 2018

tsnoam commented Oct 4, 2018

jsmnbom commented Oct 4, 2018

jsmnbom commented Feb 13, 2019