Skip to content

Fix for issue 17769: wx interactive figure close cause crash #19596

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 7 commits into from
Mar 3, 2021

Conversation

tohc1
Copy link
Contributor

@tohc1 tohc1 commented Feb 26, 2021

PR Summary

Fix for issue #17769

  1. On figure window (FigureFrameWx) close - remove figure manager from from Gcf class
    previously Gcf.destroy was called with FigureFrameWx not FigureManagerWx instance so figure was not removed correctly.

  2. Destroy now done from FigureManagerWx.destroy() method to prevent multiple calls to the close event handler.

  3. Remove unneeded wx mainloop yield calls that cause crash on windows from both FigureManagerWx.destroy and FigureFrameWx.Destroy.

Tested on windows 10, and mint 20.1.

PR Checklist

  • [N/A ] Has pytest style unit tests (and pytest passes).
  • [N/A] Is Flake 8 compliant (run flake8 on changed files to check).
  • [N/A] New features are documented, with examples if plot related.
  • [N/A] Documentation is sphinx and numpydoc compliant (the docs should build without error).
  • [N/A ] Conforms to Matplotlib style conventions (install flake8-docstrings and run flake8 --docstring-convention=all).
  • [N/A] New features have an entry in doc/users/next_whats_new/ (follow instructions in README.rst there).
  • [N/A] API changes documented in doc/api/next_api_changes/ (follow instructions in README.rst there).

1) On figure window (FigureFrameWx) close - remove figure manager from from Gcf class
 previously Gcf.destroy was called with FigureFrameWx not FigureManagerWx instance so figure was not removed.
2) Destroy now done from FigureManagerWx.destroy() method to prevent multiple calls to the close event handler.
3) Remove unneeded wx mainloop yield calls that cause crash on windows form both FigureManagerWx.destroy and FigureFrameWx.Destroy
Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for opening your first PR into Matplotlib!

If you have not heard from us in a while, please feel free to ping @matplotlib/developers or anyone who has commented on the PR. Most of our reviewers are volunteers and sometimes things fall through the cracks.

You can also join us on gitter for real-time discussion.

For details on testing, writing docs, and our review process, please see the developer guide

We strive to be a welcoming and open project. Please follow our Code of Conduct.

Prevent multiple attempts to close the frame by setting to FigureManagerWx.frame to None when closed by GUI.
When closed by plt.close() call, the frame is closed in a threadsafe way using wx.CallAfter( frame.Close )
@tohc1
Copy link
Contributor Author

tohc1 commented Feb 27, 2021

Slightly revised to pass thread tests.

  1. On figure window (FigureFrameWx) close - remove figure manager from from Gcf class
    previously Gcf.destroy was called with FigureFrameWx not FigureManagerWx instance so figure was not removed correctly.

  2. The frame close event handler will now, set the FigureManagerWx.frame to None to prevent Close being called again from FigureManagerWx.destroy.

  3. If closed via plt.close() the FigureManagerWx.destroy() method is called first, and will close the frame via the threadsafe wx.CallAfter call.

Other notes:
The close event handler now allows the event to propagate which will automatically destroy the Frame, and children. So the toolbar does not need to be destroyed in FigureFrameWx.Destroy()

Also the unneeded wx mainloop yield calls are removed from both FigureManagerWx.destroy and FigureFrameWx.Destroy as these cause crashes on windows.

@tacaswell
Copy link
Member

Thanks @tohc1 !

@tacaswell tacaswell added this to the v3.4.0 milestone Mar 1, 2021
tohc1 and others added 2 commits March 2, 2021 20:09
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
Copy link
Member

@QuLogic QuLogic left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Don't know why flake8 doesn't flag this.

tohc1 and others added 2 commits March 3, 2021 15:50
Co-authored-by: Elliott Sales de Andrade <quantum.analyst@gmail.com>
@tacaswell tacaswell merged commit b7d57c9 into matplotlib:master Mar 3, 2021
meeseeksmachine pushed a commit to meeseeksmachine/matplotlib that referenced this pull request Mar 3, 2021
@tacaswell
Copy link
Member

Thank you @tohc1 and congratulations on your first Matplotlib PR 🎉 Hopefully we will hear from you again!

@QuLogic QuLogic added the GUI: wx label Mar 3, 2021
QuLogic added a commit that referenced this pull request Mar 3, 2021
…596-on-v3.4.x

Backport PR #19596 on branch v3.4.x (Fix for issue 17769: wx interactive figure close cause crash)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants