Remove apply_theta_transforms argument (matplotlib#30004)

* Remove apply_theta_transforms argument

* Improve formatting

* Rename xxxxxx-DS.rst to 30004-DS.rst

* Delete extra line

Author: dstansby

doc/api/next_api_changes/removals/30004-DS.rst

@@ -0,0 +1,10 @@
+``apply_theta_transforms`` option in ``PolarTransform``
+~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
+
+Applying theta transforms in `~matplotlib.projections.polar.PolarTransform` and
+`~matplotlib.projections.polar.InvertedPolarTransform` has been removed, and
+the ``apply_theta_transforms`` keyword argument removed from both classes.
+
+If you need to retain the behaviour where theta values
+are transformed, chain the ``PolarTransform`` with a `~matplotlib.transforms.Affine2D`
+transform that performs the theta shift and/or sign shift.

doc/api/next_api_changes/removals/xxxxxx-DS.rst

@@ -22,7 +22,7 @@ def setup_axes(fig, rect):
     grid_helper = GridHelperCurveLinear(
         (
             Affine2D().scale(np.pi/180., 1.) +
-            PolarAxes.PolarTransform(apply_theta_transforms=False)
+            PolarAxes.PolarTransform()
         ),
         extreme_finder=angle_helper.ExtremeFinderCycle(
             20, 20,

galleries/examples/axisartist/demo_axis_direction.py

@@ -54,8 +54,7 @@ def curvelinear_test2(fig):
 
     # PolarAxes.PolarTransform takes radian. However, we want our coordinate
     # system in degree
-    tr = Affine2D().scale(np.pi/180, 1) + PolarAxes.PolarTransform(
-        apply_theta_transforms=False)
+    tr = Affine2D().scale(np.pi/180, 1) + PolarAxes.PolarTransform()
     # Polar projection, which involves cycle, and also has limits in
     # its coordinates, needs a special method to find the extremes
     # (min, max of the coordinate within the view).

galleries/examples/axisartist/demo_curvelinear_grid.py

@@ -54,7 +54,7 @@ def setup_axes2(fig, rect):
     With custom locator and formatter.
     Note that the extreme values are swapped.
     """
-    tr = PolarAxes.PolarTransform(apply_theta_transforms=False)
+    tr = PolarAxes.PolarTransform()
 
     pi = np.pi
     angle_ticks = [(0, r"$0$"),
@@ -99,8 +99,7 @@ def setup_axes3(fig, rect):
     # scale degree to radians
     tr_scale = Affine2D().scale(np.pi/180., 1.)
 
-    tr = tr_rotate + tr_scale + PolarAxes.PolarTransform(
-        apply_theta_transforms=False)
+    tr = tr_rotate + tr_scale + PolarAxes.PolarTransform()
 
     grid_locator1 = angle_helper.LocatorHMS(4)
     tick_formatter1 = angle_helper.FormatterHMS()

galleries/examples/axisartist/demo_floating_axes.py

@@ -22,8 +22,7 @@
 def curvelinear_test2(fig):
     """Polar projection, but in a rectangular box."""
     # see demo_curvelinear_grid.py for details
-    tr = Affine2D().scale(np.pi / 180., 1.) + PolarAxes.PolarTransform(
-        apply_theta_transforms=False)
+    tr = Affine2D().scale(np.pi / 180., 1.) + PolarAxes.PolarTransform()
 
     extreme_finder = angle_helper.ExtremeFinderCycle(20,
                                                      20,

galleries/examples/axisartist/demo_floating_axis.py

@@ -21,8 +21,7 @@ def setup_axes(fig, rect):
     """Polar projection, but in a rectangular box."""
 
     # see demo_curvelinear_grid.py for details
-    tr = Affine2D().scale(np.pi/180., 1.) + PolarAxes.PolarTransform(
-        apply_theta_transforms=False)
+    tr = Affine2D().scale(np.pi/180., 1.) + PolarAxes.PolarTransform()
 
     extreme_finder = angle_helper.ExtremeFinderCycle(20, 20,
                                                      lon_cycle=360,

galleries/examples/axisartist/simple_axis_pad.py

@@ -15,20 +15,6 @@
 from matplotlib.spines import Spine
 
 
-def _apply_theta_transforms_warn():
-    _api.warn_deprecated(
-                "3.9",
-                message=(
-                    "Passing `apply_theta_transforms=True` (the default) "
-                    "is deprecated since Matplotlib %(since)s. "
-                    "Support for this will be removed in Matplotlib in %(removal)s. "
-                    "To prevent this warning, set `apply_theta_transforms=False`, "
-                    "and make sure to shift theta values before being passed to "
-                    "this transform."
-                )
-            )
-
-
 class PolarTransform(mtransforms.Transform):
     r"""
     The base polar transform.
@@ -48,8 +34,7 @@ class PolarTransform(mtransforms.Transform):
 
     input_dims = output_dims = 2
 
-    def __init__(self, axis=None, use_rmin=True, *,
-                 apply_theta_transforms=True, scale_transform=None):
+    def __init__(self, axis=None, use_rmin=True, *, scale_transform=None):
         """
         Parameters
         ----------
@@ -64,15 +49,12 @@ def __init__(self, axis=None, use_rmin=True, *,
         super().__init__()
         self._axis = axis
         self._use_rmin = use_rmin
-        self._apply_theta_transforms = apply_theta_transforms
         self._scale_transform = scale_transform
-        if apply_theta_transforms:
-            _apply_theta_transforms_warn()
 
     __str__ = mtransforms._make_str_method(
         "_axis",
-        use_rmin="_use_rmin",
-        apply_theta_transforms="_apply_theta_transforms")
+        use_rmin="_use_rmin"
+    )
 
     def _get_rorigin(self):
         # Get lower r limit after being scaled by the radial scale transform
@@ -82,11 +64,6 @@ def _get_rorigin(self):
     def transform_non_affine(self, values):
         # docstring inherited
         theta, r = np.transpose(values)
-        # PolarAxes does not use the theta transforms here, but apply them for
-        # backwards-compatibility if not being used by it.
-        if self._apply_theta_transforms and self._axis is not None:
-            theta *= self._axis.get_theta_direction()
-            theta += self._axis.get_theta_offset()
         if self._use_rmin and self._axis is not None:
             r = (r - self._get_rorigin()) * self._axis.get_rsign()
         r = np.where(r >= 0, r, np.nan)
@@ -148,10 +125,7 @@ def transform_path_non_affine(self, path):
 
     def inverted(self):
         # docstring inherited
-        return PolarAxes.InvertedPolarTransform(
-            self._axis, self._use_rmin,
-            apply_theta_transforms=self._apply_theta_transforms
-        )
+        return PolarAxes.InvertedPolarTransform(self._axis, self._use_rmin)
 
 
 class PolarAffine(mtransforms.Affine2DBase):
@@ -209,8 +183,7 @@ class InvertedPolarTransform(mtransforms.Transform):
     """
     input_dims = output_dims = 2
 
-    def __init__(self, axis=None, use_rmin=True,
-                 *, apply_theta_transforms=True):
+    def __init__(self, axis=None, use_rmin=True):
         """
         Parameters
         ----------
@@ -225,37 +198,24 @@ def __init__(self, axis=None, use_rmin=True,
         super().__init__()
         self._axis = axis
         self._use_rmin = use_rmin
-        self._apply_theta_transforms = apply_theta_transforms
-        if apply_theta_transforms:
-            _apply_theta_transforms_warn()
 
     __str__ = mtransforms._make_str_method(
         "_axis",
-        use_rmin="_use_rmin",
-        apply_theta_transforms="_apply_theta_transforms")
+        use_rmin="_use_rmin")
 
     def transform_non_affine(self, values):
         # docstring inherited
         x, y = values.T
         r = np.hypot(x, y)
         theta = (np.arctan2(y, x) + 2 * np.pi) % (2 * np.pi)
-        # PolarAxes does not use the theta transforms here, but apply them for
-        # backwards-compatibility if not being used by it.
-        if self._apply_theta_transforms and self._axis is not None:
-            theta -= self._axis.get_theta_offset()
-            theta *= self._axis.get_theta_direction()
-            theta %= 2 * np.pi
         if self._use_rmin and self._axis is not None:
             r += self._axis.get_rorigin()
             r *= self._axis.get_rsign()
         return np.column_stack([theta, r])
 
     def inverted(self):
         # docstring inherited
-        return PolarAxes.PolarTransform(
-            self._axis, self._use_rmin,
-            apply_theta_transforms=self._apply_theta_transforms
-        )
+        return PolarAxes.PolarTransform(self._axis, self._use_rmin)
 
 
 class ThetaFormatter(mticker.Formatter):
@@ -895,7 +855,6 @@ def _set_lim_and_transforms(self):
         # data.  This one is aware of rmin
         self.transProjection = self.PolarTransform(
             self,
-            apply_theta_transforms=False,
             scale_transform=self.transScale
         )
         # Add dependency on rorigin.

lib/matplotlib/projections/polar.py

@@ -18,7 +18,6 @@ class PolarTransform(mtransforms.Transform):
         axis: PolarAxes | None = ...,
         use_rmin: bool = ...,
         *,
-        apply_theta_transforms: bool = ...,
         scale_transform: mtransforms.Transform | None = ...,
     ) -> None: ...
     def inverted(self) -> InvertedPolarTransform: ...
@@ -35,8 +34,6 @@ class InvertedPolarTransform(mtransforms.Transform):
         self,
         axis: PolarAxes | None = ...,
         use_rmin: bool = ...,
-        *,
-        apply_theta_transforms: bool = ...,
     ) -> None: ...
     def inverted(self) -> PolarTransform: ...
 

lib/matplotlib/projections/polar.pyi

@@ -891,8 +891,7 @@ def test_str_transform():
                 Affine2D().scale(1.0))),
         PolarTransform(
             PolarAxes(0.125,0.1;0.775x0.8),
-            use_rmin=True,
-            apply_theta_transforms=False)),
+            use_rmin=True)),
     CompositeGenericTransform(
         CompositeGenericTransform(
             PolarAffine(