Refactoring: Removing axis parameter from scales #29988
Conversation
There was a problem hiding this comment.
Thank you for opening your first PR into Matplotlib!
If you have not heard from us in a week or so, please leave a new comment below and that should bring it to our attention. 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.
|
Apologies for the sequence of commits — I wanted to ensure each feedback point was properly addressed and tested incrementally. Please let me know if this is the appropriate way to validate ruff, mypy-stubtest, and CI tests in general, or if you'd prefer a cleaner commit history or a different workflow. I changed back the deprecation warning function, and changed the decorator as well. However, in the decorator i had many errors when trying to check "if args and isinstance(args[0], ScaleBase):", so instead of using ScaleBase as a reference i changed to "if args and isinstance(args[0], mpl.axis.Axis):". Does it make sense? Let me know if anything else needs to be refined or if the structure of the changes could be improved further. Thanks again for your time and guidance throughout the review! |
There was a problem hiding this comment.
Apologies for the sequence of commits — I wanted to ensure each feedback point was properly addressed and tested incrementally. Please let me know if this is the appropriate way to validate ruff, mypy-stubtest, and CI tests in general, or if you'd prefer a cleaner commit history or a different workflow.
It does not matter for small PRs. We'll typically review the full diff and squash-merge.
However, in the decorator i had many errors when trying to check "if args and isinstance(args[0], ScaleBase):", so instead of using ScaleBase as a reference i changed to "if args and isinstance(args[0], mpl.axis.Axis):". Does it make sense?
Yes. Sorry my bad for the incorrect suggestion.
Let me know if anything else needs to be refined or if the structure of the changes could be improved further. Thanks again for your time and guidance throughout the review!
You should add a test that the decorated scales can be created with and without axis passed. - Either test on one of the scales, or write an explicit test for the decorator.
|
I started having this error with linting, but i don't understand why. It seems the error is in the _mathtext.py file, but i never changed it |
|
Looks like mypy just made a new release, so I suspect we will now see the same linting errors on all PRs. You can ignore them here. |
|
Do i still need to make some change in the code? I see that it was accepted but some tests are failing It's my first PR so i'm not sure 😅 |
|
We require two reviews from core developers. The second one is still pending. IIRC the test failures were unrelated, but since the test runs have been cleaned up, you could rebase onto main and force-push. |
Updated my refactor based on the feedbacks received
Co-authored-by: Tim Hoffmann <[email protected]>
Co-authored-by: Tim Hoffmann <[email protected]>
Co-authored-by: Tim Hoffmann <[email protected]>
Co-authored-by: Tim Hoffmann <[email protected]>
Co-authored-by: Tim Hoffmann <[email protected]>
Co-authored-by: Tim Hoffmann <[email protected]>
223dc30 to
dabac62
Compare
Co-authored-by: Elliott Sales de Andrade <[email protected]>
Co-authored-by: Elliott Sales de Andrade <[email protected]>
|
Thanks @vagnermcj! Congratulations on your first PR to Matplotlib 🎉 We hope to hear from you again. |
This PR addresses issue #29349 by refactoring built-in scale classes to make the axis parameter optional. The goal is to support future removal of axis while maintaining backward compatibility with current usage.
To achieve this, a decorator was introduced to allow constructors to accept or ignore axis. This was applied across all built-in scales. The scale_factory() function was updated to handle scale classes that do or do not use axis, and register_scale() now issues a deprecation warning if the constructor still expects it.
These changes prepare the codebase for eventual deprecation of axis in scale initializers, while avoiding any breaking changes in current usage.
My only doubt is which initializers for the scales should have the parameter as "axis = None". If all of them should have it, then i have to change the way my decorator works because axis could change position in parameters index