René's URL Explorer Experiment

Title: Undeprecate Cursor event handlers by ksunden · Pull Request #25129 · matplotlib/matplotlib · GitHub

Open Graph Title: Undeprecate Cursor event handlers by ksunden · Pull Request #25129 · matplotlib/matplotlib

X Title: Undeprecate Cursor event handlers by ksunden · Pull Request #25129 · matplotlib/matplotlib

Description: Revert "Fix deprecations of *Cursor widget event handlers" Revert: Deprecate access to Cursor/MultiCursor event handlers. Add simulated mouse events to cursor demos remove calls to set_visible(False) Closes #25107 PR Summary The event handlers were deprecated for mpl 3.7 in #19763 (with correction for the deprecation notices in #24750) This has not been released as a final matplotlib version (only the rc). However, one of examples demonstrated subclassing these classes specifically to override these methods. The callbacks registered internally were for the privitized version of the functions, thus the overrides did nothing. Given that it is suggested in our docs, we determiened in #25107 that we should undeprecate these methods. The original PR kept the calls to set_visible(False) in the un-prefixed versions of clear for Cursor and MultiCursor. Because clear is registered as a callback on a draw event, this was causing the cursor to disappear on the nbagg backend. clear is not actually run in our test suite, as observed on codecov. In ad hoc testing, removing seemed to have limited impact on the qt backend (seemed to function as expected). The problem from #19763 was reintroduced for the nbagg backend if the set_visible(False) was included. So I removed those lines entirely for the undeprecation. This feels odd, as I may have expected the clear function to explicitly turn off the cursor visibility. But as far as I can tell, it works like I'd expect. I suspect in the narrow case of a user calling clear directly (as opposed to relying on the internal callbacks) it may not actually remove the lines and thus be unexpected behavior. But I have no examples of doing such, and in most cases if the cursor was showing to begin with, the mouse is over the axes, and will cause the cursor to show up as soon as it moves anyway, I'd think. Anywho, while working on these, figured I'd also add a simulted mouse event to the examples so that the docs show what they actually do (if not interactively still) a bit more. I did so using _process() on the MouseEvent because that is what is done in our tests for simulating mouse events. I could have made the mouse event and passed it directly to the callback method, I think, which would have avoided using an _ method in our example. @anntzer suggested perhaps removing the widgets/annotated_cursor example all together because event_handlers/cursor_demo does effectively the same thing but in less code. @tacaswell voted in favor of keeping both for the time being (though did check that they are cross linked to each other). PR Checklist Documentation and Tests Has pytest style unit tests (and pytest passes) Documentation is sphinx and numpydoc compliant (the docs should build without error). New plotting related features are documented with examples. Release Notes New features are marked with a .. versionadded:: directive in the docstring and documented in doc/users/next_whats_new/ API changes are marked with a .. versionchanged:: directive in the docstring and documented in doc/api/next_api_changes/ Release notes conform with instructions in next_whats_new/README.rst or next_api_changes/README.rst

Open Graph Description: Revert "Fix deprecations of *Cursor widget event handlers" Revert: Deprecate access to Cursor/MultiCursor event handlers. Add simulated mouse events to cursor demos remove calls to set_vi...

X Description: Revert "Fix deprecations of *Cursor widget event handlers" Revert: Deprecate access to Cursor/MultiCursor event handlers. Add simulated mouse events to cursor demos remove calls t...

Opengraph URL: https://github.com/matplotlib/matplotlib/pull/25129

X: @github

direct link

Domain: github.com

Links:

Viewport: width=device-width