From 604704c65775426d14798c12e5971093162f5a18 Mon Sep 17 00:00:00 2001
From: Tim Hoffmann <2836374+timhoffm@users.noreply.github.com>
Date: Tue, 19 Sep 2023 00:13:59 +0200
Subject: [PATCH] Reoder safe_first_element() and _safe_first_finite() code

This does not change functionality. The code path for
`safe_first_element` is `_safe_first_finite(skip_nonfinite=False)` which
 is separate code block and does not interact with the
 skip_nonfinite=True case. IMHO this is more readable.

 Also add a comment on the exception handling recently modified in #26806.
---
 lib/matplotlib/cbook.py | 37 ++++++++++++++++++-------------------
 1 file changed, 18 insertions(+), 19 deletions(-)

diff --git a/lib/matplotlib/cbook.py b/lib/matplotlib/cbook.py
index f02486a0e280..b56de559532d 100644
--- a/lib/matplotlib/cbook.py
+++ b/lib/matplotlib/cbook.py
@@ -1679,10 +1679,20 @@ def safe_first_element(obj):
     This is a type-independent way of obtaining the first element,
     supporting both index access and the iterator protocol.
     """
-    return _safe_first_finite(obj, skip_nonfinite=False)
+    if isinstance(obj, collections.abc.Iterator):
+        # needed to accept `array.flat` as input.
+        # np.flatiter reports as an instance of collections.Iterator but can still be
+        # indexed via []. This has the side effect of re-setting the iterator, but
+        # that is acceptable.
+        try:
+            return obj[0]
+        except TypeError:
+            pass
+        raise RuntimeError("matplotlib does not support generators as input")
+    return next(iter(obj))
 
 
-def _safe_first_finite(obj, *, skip_nonfinite=True):
+def _safe_first_finite(obj):
     """
     Return the first finite element in *obj* if one is available and skip_nonfinite is
     True. Otherwise, return the first element.
@@ -1698,6 +1708,9 @@ def safe_isfinite(val):
         try:
             return math.isfinite(val)
         except (TypeError, ValueError):
+            # if the outer object is 2d, then val is a 1d array, and
+            # - math.isfinite(numpy.zeros(3)) raises TypeError
+            # - math.isfinite(torch.zeros(3)) raises ValueError
             pass
         try:
             return np.isfinite(val) if np.isscalar(val) else True
@@ -1705,26 +1718,12 @@ def safe_isfinite(val):
             # This is something that NumPy cannot make heads or tails of,
             # assume "finite"
             return True
-    if skip_nonfinite is False:
-        if isinstance(obj, collections.abc.Iterator):
-            # needed to accept `array.flat` as input.
-            # np.flatiter reports as an instance of collections.Iterator
-            # but can still be indexed via [].
-            # This has the side effect of re-setting the iterator, but
-            # that is acceptable.
-            try:
-                return obj[0]
-            except TypeError:
-                pass
-            raise RuntimeError("matplotlib does not support generators "
-                               "as input")
-        return next(iter(obj))
-    elif isinstance(obj, np.flatiter):
+
+    if isinstance(obj, np.flatiter):
         # TODO do the finite filtering on this
         return obj[0]
     elif isinstance(obj, collections.abc.Iterator):
-        raise RuntimeError("matplotlib does not "
-                           "support generators as input")
+        raise RuntimeError("matplotlib does not support generators as input")
     else:
         for val in obj:
             if safe_isfinite(val):