Set figure options dynamically

chahak13 · chahak13 · commit fc91e617ec25 · 2022-10-18T13:53:55.000-05:00
Previously, for the figure options, things were hard coded for the X and
Y axes but were not implemented for the Z axis. With this commit, all
the options in the Figure options dialogue box are generated dynamically
based on the axes present in the figure. This removes all the hard coded
part and should make it more modular to make further changes.
diff --git a/lib/matplotlib/backends/qt_editor/figureoptions.py b/lib/matplotlib/backends/qt_editor/figureoptions.py
@@ -5,6 +5,7 @@
 
 """Module that provides a GUI-based editor for Matplotlib's figure options."""
 
+from itertools import chain
 from matplotlib import cbook, cm, colors as mcolors, markers, image as mimage
 from matplotlib.backends.qt_compat import QtGui
 from matplotlib.backends.qt_editor import _formlayout
@@ -38,30 +39,41 @@ def convert_limits(lim, converter):
         # Cast to builtin floats as they have nicer reprs.
         return map(float, lim)
 
-    xconverter = axes.xaxis.converter
-    xmin, xmax = convert_limits(axes.get_xlim(), xconverter)
-    yconverter = axes.yaxis.converter
-    ymin, ymax = convert_limits(axes.get_ylim(), yconverter)
-    general = [('Title', axes.get_title()),
-               sep,
-               (None, "<b>X-Axis</b>"),
-               ('Left', xmin), ('Right', xmax),
-               ('Label', axes.get_xlabel()),
-               ('Scale', [axes.get_xscale(),
-                          'linear', 'log', 'symlog', 'logit']),
-               sep,
-               (None, "<b>Y-Axis</b>"),
-               ('Bottom', ymin), ('Top', ymax),
-               ('Label', axes.get_ylabel()),
-               ('Scale', [axes.get_yscale(),
-                          'linear', 'log', 'symlog', 'logit']),
-               sep,
-               ('(Re-)Generate automatic legend', False),
-               ]
+    axis_map = axes._axis_map
+    axis_converter = {
+        axis: getattr(getattr(axes, f'{axis}axis'), 'converter')
+        for axis in axis_map.keys()
+    }
+    axis_limits = {
+        axis: tuple(convert_limits(
+            getattr(axes, f'get_{axis}lim')(), axis_converter[axis]
+        ))
+        for axis in axis_map.keys()
+    }
+    general = [
+        ('Title', axes.get_title()),
+        sep,
+    ]
+    axes_info = [
+        (
+            (None, f"<b>{axis.upper()}-Axis</b>"),
+            ('Min', axis_limits[axis][0]),
+            ('Max', axis_limits[axis][1]),
+            ('Label', getattr(axes, f"get_{axis}label")()),
+            ('Scale', [getattr(axes, f"get_{axis}scale")(),
+                       'linear', 'log', 'symlog', 'logit']),
+            sep,
+        )
+        for axis in axis_map.keys()
+    ]
+    general.extend(chain.from_iterable(axes_info))
+    general.append(('(Re-)Generate automatic legend', False))
 
     # Save the unit data
-    xunits = axes.xaxis.get_units()
-    yunits = axes.yaxis.get_units()
+    axis_units = {
+        axis: getattr(getattr(axes, f"{axis}axis"), "get_units")()
+        for axis in axis_map.keys()
+    }
 
     # Get / Curves
     labeled_lines = []
@@ -165,37 +177,35 @@ def prepare_data(d, init):
 
     def apply_callback(data):
         """A callback to apply changes."""
-        orig_xlim = axes.get_xlim()
-        orig_ylim = axes.get_ylim()
+        orig_limits = {
+            axis: getattr(axes, f"get_{axis}lim")()
+            for axis in axis_map.keys()
+        }
 
         general = data.pop(0)
         curves = data.pop(0) if has_curve else []
         mappables = data.pop(0) if has_sm else []
         if data:
             raise ValueError("Unexpected field")
 
-        # Set / General
-        (title, xmin, xmax, xlabel, xscale, ymin, ymax, ylabel, yscale,
-         generate_legend) = general
+        title = general.pop(0)
+        axes.set_title(title)
+        generate_legend = general.pop()
 
-        if axes.get_xscale() != xscale:
-            axes.set_xscale(xscale)
-        if axes.get_yscale() != yscale:
-            axes.set_yscale(yscale)
+        for i, axis in enumerate(axis_map.keys()):
+            ax = getattr(axes, f"{axis}axis")
+            axmin = general[4*i]
+            axmax = general[4*i + 1]
+            axlabel = general[4*i + 2]
+            axscale = general[4*i + 3]
+            if getattr(axes, f"get_{axis}scale")() != axscale:
+                getattr(axes, f"set_{axis}scale")(axscale)
 
-        axes.set_title(title)
-        axes.set_xlim(xmin, xmax)
-        axes.set_xlabel(xlabel)
-        axes.set_ylim(ymin, ymax)
-        axes.set_ylabel(ylabel)
-
-        # Restore the unit data
-        axes.xaxis.converter = xconverter
-        axes.yaxis.converter = yconverter
-        axes.xaxis.set_units(xunits)
-        axes.yaxis.set_units(yunits)
-        axes.xaxis._update_axisinfo()
-        axes.yaxis._update_axisinfo()
+            getattr(axes, f"set_{axis}lim")(axmin, axmax)
+            getattr(axes, f"set_{axis}label")(axlabel)
+            setattr(ax, 'converter', axis_converter[axis])
+            getattr(ax, 'set_units')(axis_units[axis])
+            ax._update_axisinfo()
 
         # Set / Curves
         for index, curve in enumerate(curves):
@@ -242,8 +252,10 @@ def apply_callback(data):
         # Redraw
         figure = axes.get_figure()
         figure.canvas.draw()
-        if not (axes.get_xlim() == orig_xlim and axes.get_ylim() == orig_ylim):
-            figure.canvas.toolbar.push_current()
+        for axis in axis_map.keys():
+            if getattr(axes, f"get_{axis}lim")() != orig_limits[axis]:
+                figure.canvas.toolbar.push_current()
+                break
 
     _formlayout.fedit(
         datalist, title="Figure options", parent=parent,
