restructred viz settings

Author: floRaths

notebooks/sp_layout.py

@@ -24,30 +24,20 @@
 datax, datay = np.random.rand(50), np.random.rand(50)
 
 
-# %%
-import layout_v2 as l2
-from matplotlib.ticker import AutoMinorLocator, NullLocator
-
 # %%
 axs = sp.montage_plot(1, panel_size=(6.5, 4.5))
 axs.scatter(datax, datay)
 
 # axs.xaxis.set_minor_locator(AutoMinorLocator())
-l2.layout(
+sp.layout_v2(
     axs,
-    title='Scatter',
-    # ticks='all',
-    grid='major',
-    minor='2',
-    x_label_color='crimson',
-    x_label='X-axis',
-    y_label='Y-axis',
-    # grid_zorder=10
+    title='Scatter Plot',
+    x_grid='both',
+    minor=False
 )
 
 
 
-
 # %%
 axs = sp.montage_plot(1, panel_size=(4.5, 3.5))
 axs.scatter(datax, datay)

src/spaceplot/appearance/layout_v2.py

@@ -16,7 +16,6 @@
 # I think currently, tick visibility will override settings from other setters... need to fix that
 # implement allowed_params check like started in layout_v1
 # find solution for tick_labels
-# parse_axis_params needs better input filtering... currently everything goes through
 
 
 def layout_v2(
@@ -56,7 +55,7 @@ def layout_v2(
     x_label_params, x_tick_params, x_params = compile_axis_settings(axis_params, axis='x')
     y_label_params, y_tick_params, y_params = compile_axis_settings(axis_params, axis='y')
 
-    title_settings = get_hook_dict(static_kwargs, 'title_', remove_hook=True)
+    title_settings = utils.get_hook_dict_v2(static_kwargs, 'title_', remove_hook=True)
 
     # ensure axs is a list
     if not isinstance(axs, Iterable):
@@ -113,9 +112,25 @@ def viz(
     *,
     ticks: _tick_vis = None,
     grid: _grid_vis = None,
-    minor: bool = None,
+    minor: _tick_vis = None,
     **kwargs,
 ):
+    def value_check(param, value):
+        if value is None:
+            return
+        if type(value) is bool:
+            return
+        if value not in [v for v in _tick_vis.__args__ if type(v) is str]:
+            raise ValueError(f'Invalid {param} param: {value} ')
+
+    value_check('ticks', ticks)
+    value_check('minor', minor)
+    for k, v in kwargs.items():
+        if k.endswith('_ticks'):
+            value_check(k, v)
+        if k.endswith('_minor'):
+            value_check(k, v)
+
     viz_args = {
         k: v
         for k, v in {
@@ -135,35 +150,17 @@ def viz(
 
     # break down merged into x_ and y_ specific params
     viz_params = parse_axis_params(params=merged)
-    xviz = get_hook_dict(viz_params, 'x_', remove_hook=True)
-    yviz = get_hook_dict(viz_params, 'y_', remove_hook=True)
+    xviz = utils.get_hook_dict_v2(viz_params, 'x_', remove_hook=True, check=False)
+    yviz = utils.get_hook_dict_v2(viz_params, 'y_', remove_hook=True, check=False)
 
     # apply settings
     set_tick_grid_visibility(ax, axis='x', **xviz)
     set_tick_grid_visibility(ax, axis='y', **yviz)
 
 
-def parse_grid_visibility(
-    grid: _grid_vis | None = None,
-    minor: bool | None = None,
-):
-    if grid is None:
-        return None, None
-
-    if isinstance(grid, bool):
-        if not grid:
-            major_setter = minor_setter = False
-        else:
-            major_setter = grid
-            minor_setter = grid if minor is None else minor
-    elif isinstance(grid, str):
-        major_setter = True if grid in ('both', 'major') else False
-        minor_setter = True if grid in ('both', 'minor') else False
-
-    return major_setter, minor_setter
-
-
 def set_tick_grid_visibility(ax, *, axis='x', ticks=None, minor=None, grid=None):
+    axis_obj = getattr(ax, f'{axis}axis')
+
     # mapping for tick visibility in x/y axis
     p1 = 'bottom' if axis == 'x' else 'left'
     p2 = 'top' if axis == 'x' else 'right'
@@ -172,13 +169,6 @@ def set_tick_grid_visibility(ax, *, axis='x', ticks=None, minor=None, grid=None)
     def apply_logic(value):
         logic_1 = True if value in ('1', 'both', 'all', True) else False
         logic_2 = True if value in ('2', 'both', 'all') else False
-        return logic_1, logic_2
-
-    if ticks is None:
-        viz = {}
-        # viz_min = {}
-    else:
-        logic_1, logic_2 = apply_logic(ticks)
 
         viz = {
             p1: logic_1,
@@ -187,37 +177,49 @@ def apply_logic(value):
             f'label{p2}': logic_2,
         }
 
-    logic_1, logic_2 = apply_logic(minor)
+        return viz
 
-    viz_min = {
-        p1: viz.get(p1, logic_1),
-        f'label{p1}': viz.get(f'label{p1}', logic_1),
-        p2: viz.get(p2, logic_2),
-        f'label{p2}': viz.get(f'label{p2}', logic_2),
-    }
+    if ticks is None:
+        viz = {}
+    else:
+        viz = apply_logic(ticks)
+
+    if minor is None and ticks is None:
+        viz_min = {}
+    elif minor is None and ticks:
+        viz_min = {}
+    elif minor is True:
+        # axis_obj.minorticks_on()
+        viz_min = viz.copy()
+    else:
+        # axis_obj.minorticks_on()
+        viz_min = apply_logic(minor)
 
+    axis_obj.minorticks_on()
     grid_maj, grid_min = parse_grid_visibility(grid=grid, minor=minor)
 
-    axis_obj = getattr(ax, f'{axis}axis')
-
     axis_obj.set_tick_params(which='major', gridOn=grid_maj, **viz)
-    axis_obj.minorticks_on()
     axis_obj.set_tick_params(which='minor', gridOn=grid_min, **viz_min)
 
 
-def get_hook_dict(params, hook, remove_hook: bool = True) -> dict:
-    hook_params = {}
-    if params == {}:
-        return hook_params
+def parse_grid_visibility(
+    grid: _grid_vis | None = None,
+    minor: bool | None = None,
+):
+    if grid is None:
+        return None, None
 
-    for key, value in params.items():
-        if not key.startswith(hook):
-            continue
-        param = key.removeprefix(hook) if remove_hook else key
-        d = {param: value}
-        hook_params.update(d)
+    if isinstance(grid, bool):
+        if not grid:
+            major_setter = minor_setter = False
+        else:
+            major_setter = grid
+            minor_setter = grid if minor is None else minor
+    elif isinstance(grid, str):
+        major_setter = True if grid in ('both', 'major') else False
+        minor_setter = True if grid in ('both', 'minor') else False
 
-    return hook_params
+    return major_setter, minor_setter
 
 
 def parse_axis_params(params: dict):
@@ -241,7 +243,8 @@ def parse_axis_params(params: dict):
     # 4: check for duplicates and merge
     duplicate_keys = set(specific_axis_params.keys()) & set(axis_global.keys())
     if duplicate_keys:
-        raise ValueError(f'Duplicate keys found: {duplicate_keys}')
+        param_names = [p.removeprefix('x_') if p.startswith('x_') else p.removeprefix('y_') for p in duplicate_keys]
+        raise ValueError(f'Duplicate axis param for: {duplicate_keys} and {param_names}')
 
     axis_params = {**specific_axis_params, **axis_global}
 
@@ -265,10 +268,10 @@ def merge_axis_kwargs(kwargs):
 
 
 def compile_axis_settings(axis_params, axis: str) -> dict:
-    settings = get_hook_dict(axis_params, f'{axis}_', remove_hook=True)
-    tick_settings = get_hook_dict(settings, 'tick_', remove_hook=True)
-    grid_settings = get_hook_dict(settings, 'grid_', remove_hook=False)
-    label_settings = get_hook_dict(settings, 'label_', remove_hook=True)
+    settings = utils.get_hook_dict_v2(axis_params, f'{axis}_', remove_hook=True, check=False)
+    tick_settings = utils.get_hook_dict_v2(settings, 'tick_', remove_hook=True)
+    grid_settings = utils.get_hook_dict_v2(settings, 'grid_', remove_hook=False)
+    label_settings = utils.get_hook_dict_v2(settings, 'label_', remove_hook=True)
     tick_settings.update(grid_settings)
     other_params = {k: v for k, v in settings.items() if not (k.startswith('tick_') or k.startswith('grid_'))}
 

src/spaceplot/utils.py

@@ -2,7 +2,7 @@
 from matplotlib.colors import ListedColormap, to_rgba
 
 allowed_params = {
-    'tick': [
+    'tick_': [
         'size',
         'width',
         'color',
@@ -13,39 +13,26 @@
         'labelrotation',
         'labelfontfamily',
         'zorder',
-        # 'tick1On',
-        # 'tick2On',
-        # 'label1On',
-        # 'label2On',
         # 'tickdir',
-        # 'gridOn',
         # 'length',
-        # 'left',
-        # 'bottom',
-        # 'right',
-        # 'top',
-        # 'labelleft',
-        # 'labelbottom',
-        # 'labelright',
-        # 'labeltop',
     ],
-    'label': [
+    'label_': [
         'size',
         'color',
         'pad',
         'rotation',
         'fontfamily',
         'zorder',
     ],
-    'title': [
+    'title_': [
         'size',
         'color',
         'pad',
         'rotation',
         'fontfamily',
         'zorder',
     ],
-    'grid': [
+    'grid_': [
         'color',
         'alpha',
         'linestyle',
@@ -103,61 +90,27 @@
 }
 
 
-[
-    'grid_agg_filter',
-    'grid_alpha',
-    'grid_animated',
-    'grid_antialiased',
-    'grid_clip_box',
-    'grid_clip_on',
-    'grid_clip_path',
-    'grid_color',
-    'grid_dash_capstyle',
-    'grid_dash_joinstyle',
-    'grid_dashes',
-    'grid_data',
-    'grid_drawstyle',
-    'grid_figure',
-    'grid_fillstyle',
-    'grid_gapcolor',
-    'grid_gid',
-    'grid_in_layout',
-    'grid_label',
-    'grid_linestyle',
-    'grid_linewidth',
-    'grid_marker',
-    'grid_markeredgecolor',
-    'grid_markeredgewidth',
-    'grid_markerfacecolor',
-    'grid_markerfacecoloralt',
-    'grid_markersize',
-    'grid_markevery',
-    'grid_mouseover',
-    'grid_path_effects',
-    'grid_picker',
-    'grid_pickradius',
-    'grid_rasterized',
-    'grid_sketch_params',
-    'grid_snap',
-    'grid_solid_capstyle',
-    'grid_solid_joinstyle',
-    'grid_transform',
-    'grid_url',
-    'grid_visible',
-    'grid_xdata',
-    'grid_ydata',
-    'grid_zorder',
-    'grid_aa',
-    'grid_c',
-    'grid_ds',
-    'grid_ls',
-    'grid_lw',
-    'grid_mec',
-    'grid_mew',
-    'grid_mfc',
-    'grid_mfcalt',
-    'grid_ms',
-]
+def get_hook_dict_v2(params, hook, remove_hook: bool = True, check: bool = True) -> dict:
+    hook_params = {}
+    if params == {}:
+        return hook_params
+
+    for key, value in params.items():
+        if not key.startswith(hook):
+            continue
+        param = key.removeprefix(hook) if remove_hook else key
+
+        # print(f"recognized '{hook}' parameter: {key}")
+        if check:
+            if param not in allowed_params.get(hook, []):
+                raise ValueError(
+                    f"Invalid {hook} parameter: '{param}'.\nSupported parameters are: {allowed_params.get(hook, [])}"
+                )
+
+        d = {param: value}
+        hook_params.update(d)
+
+    return hook_params
 
 
 def get_hook_dict(params, hook, remove_hook=True) -> dict: