Skip back-and-forth between pixels and points in contour code.

anntzer · anntzer · commit bb1e4b88e857 · 2021-04-30T13:44:24.000+02:00
Text.get_window_extents returns pixels, which get_label_width converts
to points, only for all call sites to immediately convert back to
pixels.  Just introduce a new internal API which uses pixels throughout,
and deprecate the old one.
diff --git a/doc/api/next_api_changes/deprecations/20108-AL.rst b/doc/api/next_api_changes/deprecations/20108-AL.rst
@@ -0,0 +1,3 @@
+``ContourLabeler.get_label_width``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+... is deprecated.
diff --git a/lib/matplotlib/contour.py b/lib/matplotlib/contour.py
@@ -242,10 +242,20 @@ def get_label_coords(self, distances, XX, YY, ysize, lw):
         x, y = XX[ind][hysize], YY[ind][hysize]
         return x, y, ind
 
+    def _get_nth_label_width(self, nth):
+        """Return the width of the *nth* label, in pixels."""
+        fig = self.axes.figure
+        return (
+            text.Text(0, 0,
+                      self.get_text(self.labelLevelList[nth], self.labelFmt),
+                      figure=fig,
+                      size=self.labelFontSizeList[nth],
+                      fontproperties=self.labelFontProps)
+            .get_window_extent(mpl.tight_layout.get_renderer(fig)).width)
+
+    @_api.deprecated("3.5")
     def get_label_width(self, lev, fmt, fsize):
-        """
-        Return the width of the label in points.
-        """
+        """Return the width of the label in points."""
         if not isinstance(lev, str):
             lev = self.get_text(lev, fmt)
         fig = self.axes.figure
@@ -498,11 +508,7 @@ def add_label_near(self, x, y, inline=True, inline_spacing=5,
         lmin = self.labelIndiceList.index(conmin)
 
         # Get label width for rotating labels and breaking contours
-        lw = self.get_label_width(self.labelLevelList[lmin],
-                                  self.labelFmt, self.labelFontSizeList[lmin])
-        # lw is in points.
-        lw *= self.axes.figure.dpi / 72  # scale to screen coordinates
-        # now lw in pixels
+        lw = self._get_nth_label_width(lmin)
 
         # Figure out label rotation.
         rotation, nlc = self.calc_label_rot_and_inline(
@@ -534,14 +540,15 @@ def labels(self, inline, inline_spacing):
         else:
             add_label = self.add_label
 
-        for icon, lev, fsize, cvalue in zip(
-                self.labelIndiceList, self.labelLevelList,
-                self.labelFontSizeList, self.labelCValueList):
+        for idx, (icon, lev, cvalue) in enumerate(zip(
+                self.labelIndiceList,
+                self.labelLevelList,
+                self.labelCValueList,
+        )):
 
             con = self.collections[icon]
             trans = con.get_transform()
-            lw = self.get_label_width(lev, self.labelFmt, fsize)
-            lw *= self.axes.figure.dpi / 72  # scale to screen coordinates
+            lw = self._get_nth_label_width(idx)
             additions = []
             paths = con.get_paths()
             for segNum, linepath in enumerate(paths):

Original file line number	Diff line number	Diff line change
`@@ -0,0 +1,3 @@`
	`1`	+``ContourLabeler.get_label_width``
	`2`	`+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~`
	`3`	`+... is deprecated.`