Skip to content

Add warning when subplot kwargs are ignored #19436

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.

Sign up for GitHub

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

Closed
wants to merge 1 commit into from
Closed

Add warning when subplot kwargs are ignored #19436

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions lib/matplotlib/pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1232,6 +1232,10 @@ def subplot(*args, **kwargs):
# If no existing axes match, then create a new one.
if ax is None:
ax = fig.add_subplot(*args, **kwargs)
elif kwargs:
_api.warn_external(f"An Axes with subplot spec {args} already exists. "
"The existing Axes will be returned, with all "
"keyword arguments ignored.")

bbox = ax.bbox
axes_to_delete = []
Expand Down
8 changes: 8 additions & 0 deletions lib/matplotlib/tests/test_pyplot.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -153,3 +153,11 @@ def test_nested_ion_ioff():
with plt.ioff():
plt.ion()
assert not mpl.is_interactive()


def test_subplot_warning():
ax1 = plt.subplot(2, 1, 1)
with pytest.warns(UserWarning, match='An Axes with subplot spec '
r'\(2, 1, 1\) already exists'):
ax2 = plt.subplot(2, 1, 1, polar=True)
assert ax1 is ax2