Skip to content

FIX: Guard against already-removed labels in ContourSet.remove() #31431

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

Merged
ksunden merged 9 commits into from
Apr 10, 2026
Merged

FIX: Guard against already-removed labels in ContourSet.remove() #31431

Show file tree
Hide file tree
Changes from 6 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
d157587
FIX: Guard against already removed labels in ContourSet.remove()
buddy0452004 Apr 1, 2026
ada7b70
FIX: Add blank lines before test function
buddy0452004 Apr 1, 2026
ff2eab9
FIX: Address review feedback - simpler fix and cleaner test
buddy0452004 Apr 1, 2026
8038b61
FIX: Remove trailing newline
buddy0452004 Apr 1, 2026
d35b9cd
FIX: Add warning and docs for manual label removal in ContourSet
buddy0452004 Apr 3, 2026
ca0515a
TST: Expect UserWarning when labels manually removed before CS.remove()
buddy0452004 Apr 3, 2026
b23fd27
FIX: Address timhoffm review feedback
buddy0452004 Apr 3, 2026
8eff292
FIX: Fix line too long in docstring
buddy0452004 Apr 3, 2026
5f1d6b0
Update lib/matplotlib/contour.py
buddy0452004 Apr 3, 2026
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
17 changes: 15 additions & 2 deletions lib/matplotlib/contour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -143,6 +143,10 @@ def clabel(self, levels=None, *,
-------
labels
A list of `.Text` instances for the labels.

Note: The returned .Text instances should not be individually
Comment thread
timhoffm marked this conversation as resolved.
Outdated
removed or have their geometry modified. To remove all labels,
Comment thread
timhoffm marked this conversation as resolved.
Outdated
remove the entire .ContourSet and recreate it.
Comment thread
timhoffm marked this conversation as resolved.
Outdated
"""

if self.filled:
Expand Down Expand Up @@ -514,8 +518,17 @@ def labels(self, inline, inline_spacing):

def remove(self):
super().remove()
for text in self.labelTexts:
text.remove()
for text in list(self.labelTexts):
Comment thread
timhoffm marked this conversation as resolved.
Outdated
try:
text.remove()
except ValueError:
import warnings
warnings.warn(
Comment thread
timhoffm marked this conversation as resolved.
Outdated
"Some labels were manually removed before the ContourSet. "
Comment thread
buddy0452004 marked this conversation as resolved.
Outdated
"To remove labels cleanly, remove the entire ContourSet "
"and recreate it.",
UserWarning, stacklevel=2)
self.labelTexts.clear()


def _find_closest_point_on_path(xys, p):
Expand Down
11 changes: 11 additions & 0 deletions lib/matplotlib/tests/test_contour.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -804,6 +804,17 @@ def test_contour_remove():
assert ax.get_children() == orig_children


def test_contour_remove_with_labels():
ax = plt.figure().add_subplot()
cs = ax.contour(np.arange(16).reshape((4, 4)))
labels = cs.clabel()
for label in labels:
Comment thread
timhoffm marked this conversation as resolved.
Outdated
label.remove()
cs.clabel()
Comment thread
timhoffm marked this conversation as resolved.
Outdated
with pytest.warns(UserWarning, match="Some labels were manually removed"):
cs.remove()


def test_contour_no_args():
fig, ax = plt.subplots()
data = [[0, 1], [1, 0]]
Expand Down
Loading