MNT: Remove deprecated axes kwargs collision detection (version 2) by lpsinger · Pull Request #19153 · matplotlib/matplotlib · GitHub

This replaces #18978, and addresses the comments from @tacaswell and @jklymak to preserve the behavior of repeated calls to plt.subplot with the same subplot spec.

PR Summary

In Matplotlib 2.1, the behavior of reusing existing axes when created with the same arguments was deprecated (see #9037). This behavior is now removed.

The behavior of the functions to create new axes (pyplot.axes, pyplot.subplot, figure.Figure.add_axes, figure.Figure.add_subplot) has changed. In the past, these functions would detect if you were attempting to create Axes with the same keyword arguments as already-existing axes in the current figure, and if so, they would return the existing Axes. Now, these functions will always create new Axes. A special exception is pyplot.subplot, which will reuse any existing subplot with a matching subplot spec. However, if there is a subplot with a matching subplot spec, then that subplot will be returned, even if the keyword arguments with which it was created differ.

Correspondingly, the behavior of the functions to get the current Axes (pyplot.gca, figure.Figure.gca) has changed. In the past, these functions accepted keyword arguments. If the keyword arguments matched an already-existing Axes, then that Axes would be returned, otherwise new Axes would be created with those keyword arguments. Now, the keyword arguments are only considered if there are no axes at all in the current figure. In a future release, these functions will not accept keyword arguments at all.

Fixes #18832.

PR Checklist

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

This new behaviour sounds right to me, but have you tested it all? ie. I do not see a test that we create new axes, but maybe I read too quickly.

@jklymak, I did not add any new unit tests. I only modified existing unit tests so that they would pass.

Hi, any feedback on this PR? This is just a gentle poke because the submission was badly timed, right before the holidays. Thank you!

Please do keep pinging us! OTOH, the ball is still in your court to add new tests for the new behaviour ;-)

@jklymak, as requested, I added a unit test.

@jklymak, as requested, I added a unit test.

Thanks a lot, the unit tests really make the new behaviour clear. This all seems reasonable to me, but lets ping @tacaswell, @timhoffm and @QuLogic to make sure we have all that was discussed in #18978 correct.

@timhoffm, thank you, I addressed all of your comments.

@QuLogic, I believe that I addressed all of your comments.

It looks like you'll need to update the tests for the wording changes.

In Matplotlib 2.1, the behavior of reusing existing axes when created with the same arguments was deprecated (see matplotlib#9037). This behavior is now removed. The behavior of the functions to create new axes (`pyplot.axes`, `pyplot.subplot`, `figure.Figure.add_axes`, `figure.Figure.add_subplot`) has changed. In the past, these functions would detect if you were attempting to create Axes with the same keyword arguments as already-existing axes in the current figure, and if so, they would return the existing Axes. Now, these functions will always create new Axes. A special exception is `pyplot.subplot`, which will reuse any existing subplot with a matching subplot spec. However, if there is a subplot with a matching subplot spec, then that subplot will be returned, even if the keyword arguments with which it was created differ. Correspondingly, the behavior of the functions to get the current Axes (`pyplot.gca`, `figure.Figure.gca`) has changed. In the past, these functions accepted keyword arguments. If the keyword arguments matched an already-existing Axes, then that Axes would be returned, otherwise new Axes would be created with those keyword arguments. Now, the keyword arguments are only considered if there are no axes at all in the current figure. In a future release, these functions will not accept keyword arguments at all. Fixes matplotlib#18832.

It looks like you'll need to update the tests for the wording changes.

Whoops! Should be fixed now.

lpsinger force-pushed the do-not-detect-axes-collisions-v2 branch 2 times, most recently from a886c4e to bcee8ab Compare December 19, 2020 04:25

lpsinger force-pushed the do-not-detect-axes-collisions-v2 branch from bcee8ab to e6df62e Compare December 20, 2020 15:39

dstansby added the Maintenance label Dec 26, 2020

lpsinger mentioned this pull request Dec 26, 2020

Example in allsky.py give error "TypeError: unhashable type: 'SkyCoord'" lpsinger/ligo.skymap#9

Closed

jklymak added the status: needs tests label Jan 5, 2021

lpsinger force-pushed the do-not-detect-axes-collisions-v2 branch from e6df62e to f0ca259 Compare January 7, 2021 16:34

jklymak removed the status: needs tests label Jan 7, 2021

timhoffm reviewed Jan 11, 2021

View reviewed changes

Comment thread doc/api/next_api_changes/removals/19153-LPS.rst Outdated

Comment thread lib/matplotlib/pyplot.py Outdated

Comment thread lib/matplotlib/figure.py Outdated

Comment thread lib/matplotlib/figure.py Outdated

Comment thread lib/matplotlib/tests/test_axes.py Outdated

lpsinger force-pushed the do-not-detect-axes-collisions-v2 branch from f6d425f to 400aa25 Compare January 11, 2021 22:01

timhoffm approved these changes Jan 12, 2021

View reviewed changes

timhoffm added the API: changes Changes to the public API, typically requiring deprecation. label Jan 12, 2021

timhoffm added this to the v3.4.0 milestone Jan 12, 2021

QuLogic reviewed Jan 19, 2021

View reviewed changes

QuLogic mentioned this pull request Jan 19, 2021

API: Remove deprecated axes kwargs collision detection #18978

Closed

6 tasks done

lpsinger force-pushed the do-not-detect-axes-collisions-v2 branch 3 times, most recently from 78d231f to 0db9c6c Compare January 19, 2021 13:17

lpsinger requested a review from QuLogic January 19, 2021 13:19

lpsinger force-pushed the do-not-detect-axes-collisions-v2 branch from 0db9c6c to 2377702 Compare January 19, 2021 16:32

lpsinger force-pushed the do-not-detect-axes-collisions-v2 branch from 2377702 to 68498c6 Compare January 21, 2021 14:04

QuLogic approved these changes Jan 22, 2021

View reviewed changes

QuLogic merged commit b5e714a into matplotlib:master Jan 22, 2021

lpsinger deleted the do-not-detect-axes-collisions-v2 branch January 22, 2021 04:01

QuLogic mentioned this pull request Jan 22, 2021

use only hashable objects #14595

Closed

4 of 6 tasks

pllim mentioned this pull request Jan 22, 2021

TST: mpl-dev job, test_misc.py failing astropy/astropy#11267

Closed

1 task done

astrofrog mentioned this pull request Feb 2, 2021

Unexpected change in behavior in plt.subplot #19432

Closed

lpsinger added a commit to lpsinger/matplotlib that referenced this pull request Feb 2, 2021

DOC: fix an overlooked docs change from matplotlib#19153

1606570

lpsinger mentioned this pull request Feb 2, 2021

DOC: fix an overlooked docs change from #19153 #19433

Closed

7 tasks done

dstansby mentioned this pull request Feb 2, 2021

Add warning when subplot kwargs are ignored #19436

Closed

tacaswell mentioned this pull request Feb 3, 2021

FIX: restore creating new axes via plt.subplot with different kwargs #19438

Merged

5 of 7 tasks

This was referenced Mar 2, 2021

Axes order changed in 3.4.0rc1 #19598

Closed

Restore _AxesStack to track a Figure's Axes order. #19625

Merged

jklymak mentioned this pull request Aug 1, 2021

[Doc]: How to replicate behaviour of plt.gca(projection=...)? #20770

Closed

timhoffm mentioned this pull request Sep 18, 2021

[Bug]: Second and subsequent calls to plt.polar() return an Axis object and do not plot #21113

Closed

QuLogic mentioned this pull request Aug 1, 2023

Reactivating pyplot.subplot throws warning. #12513

Closed

MNT: Remove deprecated axes kwargs collision detection (version 2) by lpsinger · Pull Request #19153 · matplotlib/matplotlib · GitHub

Repository navigation

MNT: Remove deprecated axes kwargs collision detection (version 2) - #19153

MNT: Remove deprecated axes kwargs collision detection (version 2)#19153QuLogic merged 1 commit intomatplotlib:mastermatplotlib/matplotlib:masterfrom lpsinger:do-not-detect-axes-collisions-v2lpsinger/matplotlib:do-not-detect-axes-collisions-v2Copy head branch name to clipboard

Conversation

lpsinger commented Dec 19, 2020

PR Summary

PR Checklist

Uh oh!

jklymak commented Dec 19, 2020

Uh oh!

lpsinger commented Dec 20, 2020

Uh oh!

lpsinger commented Jan 5, 2021

Uh oh!

jklymak commented Jan 5, 2021

Uh oh!

lpsinger commented Jan 7, 2021

Uh oh!

jklymak commented Jan 7, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpsinger commented Jan 11, 2021

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

Uh oh!

lpsinger commented Jan 19, 2021

Uh oh!

QuLogic commented Jan 20, 2021

Uh oh!

lpsinger commented Jan 21, 2021

Uh oh!

Reviewers

Uh oh!

Assignees

Labels

Projects

Milestone

Development

Uh oh!

5 participants

MNT: Remove deprecated axes kwargs collision detection (version 2)#19153
QuLogic merged 1 commit into
matplotlib:masterfrom
lpsinger:do-not-detect-axes-collisions-v2