Refactor a bit animation start/save interaction. #16078
Merged
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
dopplershift
approved these changes
Jan 4, 2020
This avoids an obscure pytest assertion failure
```
> assert weakref_assertion_fn(f())
E assert False
E + where False = <function <lambda> at 0x7f49d8bfdb80>(None)
E + where None = <weakref at 0x7f49d76c3360; dead>()
```
if refactoring animation and causing the test to fail. One now gets
```
# If cache_frame_data is True, then the weakref should be alive;
# if cache_frame_data is False, then the weakref should be dead (None).
> assert (f() is None) != cache_frame_data
E assert (None is None) != True
E + where None = <weakref at 0x7f4a3416c7c0; dead>()
```
Animation connects to draw_event to figure out whether to start the animation, but needs to temporarily disconnect the draw_event handler to avoid triggering the animation start when saving the animation. Instead one can just reuse the canvas._is_saving flag in the draw_event handler to do that.
timhoffm
reviewed
Jan 5, 2020
| assert weakref_assertion_fn(f()) | ||
| # If cache_frame_data is True, then the weakref should be alive; | ||
| # if cache_frame_data is False, then the weakref should be dead (None). | ||
| assert (f() is None) != cache_frame_data |
There was a problem hiding this comment.
Woulndn't it be more clear to add a message to the assert?
There was a problem hiding this comment.
I think the comments above are good enough, and adding code to generate the correct message would actually obfuscate the issue at hand.
timhoffm
approved these changes
Jan 5, 2020
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
PR Summary
1st commit:
This avoids an obscure pytest assertion failure
if refactoring animation and causing the test to fail. One now gets
2nd commit:
Animation connects to draw_event to figure out whether to start the
animation, but needs to temporarily disconnect the draw_event handler to
avoid triggering the animation start when saving the animation.
Instead one can just reuse the canvas._is_saving flag in the draw_event
handler to do that.
PR Checklist