For polar plots, report cursor position with correct precision.

anntzer · anntzer · commit 20589052978d · 2021-05-31T23:57:50.000+02:00
... similar to what's done for cartesian plots (in
ScalarFormatter.format_data_short).
diff --git a/lib/matplotlib/projections/polar.py b/lib/matplotlib/projections/polar.py
@@ -1,4 +1,5 @@
 from collections import OrderedDict
+import math
 import types
 
 import numpy as np
@@ -187,6 +188,7 @@ class ThetaFormatter(mticker.Formatter):
     Used to format the *theta* tick labels.  Converts the native
     unit of radians into degrees and adds a degree symbol.
     """
+
     def __call__(self, x, pos=None):
         vmin, vmax = self.axis.get_view_interval()
         d = np.rad2deg(abs(vmax - vmin))
@@ -1403,11 +1405,40 @@ def set_rgrids(self, radii, labels=None, angle=None, fmt=None, **kwargs):
 
     def format_coord(self, theta, r):
         # docstring inherited
+        screen_xy = self.transData.transform((theta, r))
+        screen_xys = screen_xy + np.stack(
+            np.meshgrid([-1, 0, 1], [-1, 0, 1])).reshape((2, -1)).T
+        ts, rs = self.transData.inverted().transform(screen_xys).T
+        delta_t = abs((ts - theta + np.pi) % (2 * np.pi) - np.pi).max()
+        delta_t_halfturns = delta_t / np.pi
+        delta_t_degrees = delta_t_halfturns * 180
+        delta_r = abs(rs - r).max()
         if theta < 0:
             theta += 2 * np.pi
-        theta /= np.pi
-        return ('\N{GREEK SMALL LETTER THETA}=%0.3f\N{GREEK SMALL LETTER PI} '
-                '(%0.3f\N{DEGREE SIGN}), r=%0.3f') % (theta, theta * 180.0, r)
+        theta_halfturns = theta / np.pi
+        theta_degrees = theta_halfturns * 180
+
+        # See ScalarFormatter.format_data_short.  For r, use #g-formatting
+        # (as for linear axes), but for theta, use f-formatting as scientific
+        # notation doesn't make sense and the trailing dot is ugly.
+        def format_sig(value, delta, opt, fmt):
+            digits_post_decimal = math.floor(math.log10(delta))
+            digits_offset = (
+                # For "f", only count digits after decimal point.
+                0 if fmt == "f"
+                # For "g", offset by digits before the decimal point.
+                else math.floor(math.log10(abs(value))) + 1 if value
+                # For "g", 0 contributes 1 "digit" before the decimal point.
+                else 1)
+            fmt_prec = max(0, digits_offset - digits_post_decimal)
+            return f"{value:-{opt}.{fmt_prec}{fmt}}"
+
+        return ('\N{GREEK SMALL LETTER THETA}={}\N{GREEK SMALL LETTER PI} '
+                '({}\N{DEGREE SIGN}), r={}').format(
+                    format_sig(theta_halfturns, delta_t_halfturns, "", "f"),
+                    format_sig(theta_degrees, delta_t_degrees, "", "f"),
+                    format_sig(r, delta_r, "#", "g"),
+                )
 
     def get_data_ratio(self):
         """
diff --git a/lib/matplotlib/tests/test_polar.py b/lib/matplotlib/tests/test_polar.py
@@ -410,3 +410,17 @@ def test_axvline_axvspan_do_not_modify_rlims():
     ax.axvline(.5)
     ax.plot([.1, .2])
     assert ax.get_ylim() == (0, .2)
+
+
+def test_cursor_precision():
+    ax = plt.subplot(projection="polar")
+    # Higher radii correspond to higher theta-precisions.
+    assert ax.format_coord(0, 0) == "θ=0π (0°), r=0.000"
+    assert ax.format_coord(0, .1) == "θ=0.00π (0°), r=0.100"
+    assert ax.format_coord(0, 1) == "θ=0.000π (0.0°), r=1.000"
+    assert ax.format_coord(1, 0) == "θ=0.3π (57°), r=0.000"
+    assert ax.format_coord(1, .1) == "θ=0.32π (57°), r=0.100"
+    assert ax.format_coord(1, 1) == "θ=0.318π (57.3°), r=1.000"
+    assert ax.format_coord(2, 0) == "θ=0.6π (115°), r=0.000"
+    assert ax.format_coord(2, .1) == "θ=0.64π (115°), r=0.100"
+    assert ax.format_coord(2, 1) == "θ=0.637π (114.6°), r=1.000"
