Skip to content

adding check_xytext for NaN values #30381

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
AndrGutierrez wants to merge 13 commits into from
Closed

adding check_xytext for NaN values #30381

Changes from 3 commits
Commits
Show all changes
13 commits
Select commit Hold shift + click to select a range
1909378
check xytext
AndrGutierrez Aug 3, 2025
07130be
fix case xytext is None
AndrGutierrez Aug 3, 2025
5623364
check_xytext finite
AndrGutierrez Aug 3, 2025
5c979f8
raise ValueError for invalid xytext
AndrGutierrez Aug 4, 2025
f680e3f
fix transformation error
AndrGutierrez Aug 5, 2025
f64a90f
fix unbound coords
AndrGutierrez Aug 5, 2025
b03ea7b
fix support for units
AndrGutierrez Aug 5, 2025
8cf348a
Update lib/matplotlib/text.py
AndrGutierrez Aug 11, 2025
a80baa2
Update lib/matplotlib/text.py
AndrGutierrez Aug 17, 2025
48559ca
applying suggestions
AndrGutierrez Aug 17, 2025
45bea11
replacing try-except loop to unit convertion for xytext
AndrGutierrez Aug 21, 2025
ddfa661
Merge branch 'main' of github.com:AndrGutierrez/matplotlib into bugfi…
AndrGutierrez Aug 31, 2025
f5452a6
validate if Bbox is null
AndrGutierrez Sep 7, 2025
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
23 changes: 21 additions & 2 deletions lib/matplotlib/text.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,6 +5,7 @@
import functools
import logging
import math
import numbers
from numbers import Real
import weakref

Expand Down Expand Up @@ -1862,6 +1863,7 @@ def transform(renderer) -> Transform
xy,
xycoords=xycoords,
annotation_clip=annotation_clip)
self.xytext = xytext
Comment thread
AndrGutierrez marked this conversation as resolved.
Resolved
# warn about wonky input data
if (xytext is None and
textcoords is not None and
Expand Down Expand Up @@ -2027,7 +2029,12 @@ def draw(self, renderer):
# docstring inherited
if renderer is not None:
self._renderer = renderer
if not self.get_visible() or not self._check_xy(renderer):

visible = (self.get_visible() and
self._check_xy(renderer) and
self._check_xytext())

if not visible:
return
# Update text positions before `Text.draw` would, so that the
# FancyArrowPatch is correctly positioned.
Expand All @@ -2046,7 +2053,10 @@ def get_window_extent(self, renderer=None):
# docstring inherited
# This block is the same as in Text.get_window_extent, but we need to
# set the renderer before calling update_positions().
if not self.get_visible() or not self._check_xy(renderer):
visible = (self.get_visible() and
self._check_xy(renderer) and
self._check_xytext())
if not visible:
return Bbox.unit()
if renderer is not None:
self._renderer = renderer
Expand All @@ -2072,4 +2082,13 @@ def get_tightbbox(self, renderer=None):
return super().get_tightbbox(renderer)


def _check_xytext(self, renderer=None):
Comment thread
AndrGutierrez marked this conversation as resolved.
Resolved
"""Check whether the annotation at *xy_pixel* should be drawn."""
valid = True
if self.xytext is None:
return valid

if all(isinstance(xyt, numbers.Number) for xyt in self.xytext):
valid = not np.isnan(self.xytext).any() and np.isfinite(self.xytext).all()

@rcomer rcomer Aug 3, 2025

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

To fix the polar case, you need to check these values after they are transformed to "screen space", for which you can use self.axes.transData.transform. See the Transforms Tutorial for more details.

I'm not really sure if invalid values here should make the annotation invisible or raise a more helpful error message.

return valid
_docstring.interpd.register(Annotation=Annotation.__init__.__doc__)