Warn on a bad signature for an 'observe'-decorated function #1529
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.
This PR adds a runtime warning for an observe-decorated method whose signature is incompatible with 'observe'.
I'm in two minds about whether this is a good idea - it's unnecessary runtime overhead, but on the other hand that runtime overhead should be small and will typically only apply at import time.
One the other hand, forgetting the
event
parameter is a very common mistake withobserve
-decorated methods, especially since the event-less signature is compatible withon_trait_change
.I haven't extended the fix to dynamic applications of
observe
:a.observe(handler, expression)
; that does seem like a case where we don't want the extra runtime overhead, since there may be many hidden calls toobserve
in a codebase, but occurrences of theobserve
decorator are limited in comparison.Closes #1428.
Checklist