Fix WebhookHandler.add to able to corp with handler function with *args in its parameters #260
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
loloicci
force-pushed
the
fix-whhandler-wrapedfunc
branch
3 times, most recently
from
0583314 to
206ef2f
Compare
loloicci
force-pushed
the
fix-whhandler-wrapedfunc
branch
from
206ef2f to
ec635ca
Compare
Contributor
Author
|
Sorry, I had done some force-push to pass the CI test. |
Member
|
no problem. |
cryeo
reviewed
Jun 18, 2020
|
|
||
| @staticmethod | ||
| def __get_args_count(func): | ||
| HANDLER_ARGSIZE_MAXIMAM = 2 |
Member
There was a problem hiding this comment.
[imo]
How about returning the flag that function has varadic arguments or not in addition to the number of non-varadic arguments?
In this way, we should modify
line-bot-sdk-python/linebot/webhook.py
Lines 256 to 262 in ec635ca
to following, but I think that it is more clear.
has_varargs, args_count = self.__get_args_count(func)
if has_varargs or args_count >= 2:
func(event, payload.destination)
elif args_count == 1:
func(event)
else:
func()
cryeo
reviewed
Jun 18, 2020
Comment on lines
+532
to
+622
| def wrap(func): | ||
| def wrapper(*args): | ||
| if PY3: | ||
| arg_spec = inspect.getfullargspec(func) | ||
| else: | ||
| arg_spec = inspect.getargspec(func) | ||
| return func(*args[0:len(arg_spec.args)]) | ||
| return wrapper | ||
|
|
||
|
|
||
| class TestWebhookHandlerWithWrappedFunction(unittest.TestCase): | ||
| def setUp(self): | ||
| self.handler = WebhookHandler('channel_secret') | ||
|
|
||
| @self.handler.add(MessageEvent, message=TextMessage) | ||
| @wrap | ||
| def message_text(event, destination): | ||
| self.assertEqual('message', event.type) | ||
| self.assertEqual('text', event.message.type) | ||
| self.assertEqual('U123', destination) | ||
|
|
||
| @self.handler.add(MessageEvent, | ||
| message=(ImageMessage, VideoMessage, AudioMessage)) | ||
| @wrap | ||
| def message_content(event): | ||
| self.assertEqual('message', event.type) | ||
| self.assertIn( | ||
| event.message.type, | ||
| ['image', 'video', 'audio'] | ||
| ) | ||
|
|
||
| @self.handler.add(MessageEvent, message=StickerMessage) | ||
| @wrap | ||
| def message_sticker(event): | ||
| self.assertEqual('message', event.type) | ||
| self.assertEqual('sticker', event.message.type) | ||
|
|
||
| @self.handler.add(MessageEvent) | ||
| @wrap | ||
| def message(event): | ||
| self.assertEqual('message', event.type) | ||
| self.assertNotIn( | ||
| event.message.type, | ||
| ['text', 'image', 'video', 'audio', 'sticker'] | ||
| ) | ||
|
|
||
| @self.handler.add(FollowEvent) | ||
| @wrap | ||
| def follow(event, destination): | ||
| self.assertEqual('follow', event.type) | ||
| self.assertEqual('U123', destination) | ||
|
|
||
| @self.handler.add(JoinEvent) | ||
| @wrap | ||
| def join(event): | ||
| self.assertEqual('join', event.type) | ||
|
|
||
| @self.handler.add(PostbackEvent) | ||
| @wrap | ||
| def postback(event): | ||
| self.assertEqual('postback', event.type) | ||
|
|
||
| @self.handler.add(BeaconEvent) | ||
| @wrap | ||
| def beacon(event): | ||
| self.assertEqual('beacon', event.type) | ||
|
|
||
| @self.handler.add(AccountLinkEvent) | ||
| @wrap | ||
| def account_link(event): | ||
| self.assertEqual('accountLink', event.type) | ||
|
|
||
| @self.handler.default() | ||
| def default(event): | ||
| self.assertNotIn( | ||
| event.type, | ||
| ['message', 'follow', 'join', 'postback', 'beacon', 'accountLink'] | ||
| ) | ||
|
|
||
| def test_handler_with_wrapped_function(self): | ||
| file_dir = os.path.dirname(__file__) | ||
| webhook_sample_json_path = os.path.join(file_dir, 'text', 'webhook.json') | ||
| with open(webhook_sample_json_path) as fp: | ||
| body = fp.read() | ||
|
|
||
| # mock | ||
| self.handler.parser.signature_validator.validate = lambda a, b: True | ||
|
|
||
| self.handler.handle(body, 'signature') | ||
|
|
||
|
|
Member
There was a problem hiding this comment.
[imo]
Test seems good, but it seems redundant to makeTestWebhookHandlerWithWrappedFunction.
If we separate the part which invokes function from WebhookHandler.handle like following and test it, the test will be more clear and simple I think.
def __invoke_func(self, func, event, payload):
has_varargs, args_count = self.__get_args_count(func)
if has_varargs or args_count >= 2:
func(event, payload.destination)
elif args_count == 1:
func(event)
else:
func()
Contributor
Author
|
created a new PR (#276) that reflected the review. |
Member
Could you tell us the reason to create new PR? |
Contributor
Author
|
Because almost all differences with the master are changed and it looks better to make a new PR than revert the commits for me. |
Member
|
OK, let's move to #276. |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
3 participants
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Fix #259