Added get_xlabel(), get_ylabel(), get_title(), get_xscale(), get_yscale(), get_aspect(), transAxes(), and transData() functions to the named_arrays.plt module.

named_arrays/_scalars/scalar_named_array_functions.py

@@ -15,6 +15,9 @@
     "ASARRAY_LIKE_FUNCTIONS",
     "RANDOM_FUNCTIONS",
     "PLT_PLOT_LIKE_FUNCTIONS",
+    "PLT_AXES_SETTERS",
+    "PLT_AXES_GETTERS",
+    "PLT_AXES_ATTRIBUTES",
     "HANDLED_FUNCTIONS",
     "random",
     "jacobian",
@@ -43,6 +46,18 @@
     na.plt.set_yscale,
     na.plt.set_aspect,
 )
+PLT_AXES_GETTERS = (
+    na.plt.get_xlabel,
+    na.plt.get_ylabel,
+    na.plt.get_title,
+    na.plt.get_xscale,
+    na.plt.get_yscale,
+    na.plt.get_aspect,
+)
+PLT_AXES_ATTRIBUTES = (
+    na.plt.transAxes,
+    na.plt.transData,
+)
 NDFILTER_FUNCTIONS = (
     na.ndfilters.mean_filter,
     na.ndfilters.trimmed_mean_filter,
@@ -829,6 +844,7 @@
         y = scalars._normalize(y)
         s = scalars._normalize(s)
         ax = scalars._normalize(ax)
+        kwargs = {k: scalars._normalize(kwargs[k]) for k in kwargs}
     except na.ScalarTypeError:  # pragma: nocover
         return NotImplemented
 
@@ -838,15 +854,17 @@
     y = y.broadcast_to(shape)
     s = s.broadcast_to(shape)
     ax = ax.broadcast_to(shape)
+    kwargs = {k: kwargs[k].broadcast_to(shape) for k in kwargs}
 
     result = na.ScalarArray.empty(shape, dtype=matplotlib.axes.Axes)
 
     for index in na.ndindex(shape):
+        kwargs_index = {k: kwargs[k][index].ndarray for k in kwargs}
         result[index] = ax[index].ndarray.text(
             x=x[index].ndarray,
             y=y[index].ndarray,
             s=s[index].ndarray,
-            **kwargs,
+            **kwargs_index,
         )
 
     return result
@@ -880,6 +898,48 @@
         getattr(ax[index].ndarray, method.__name__)(*args_index, **kwargs_index)
 
 
+def plt_axes_getter(
+    method: str,
+    ax: na.AbstractScalarArray,
+) -> na.ScalarArray:
+
+    try:
+        ax = scalars._normalize(ax)
+    except na.ScalarTypeError:  # pragma: nocover
+        return NotImplemented
+
+    result = na.ScalarArray.empty(shape=ax.shape, dtype=object)
+
+    for index in na.ndindex(ax.shape):
+        ax_index = ax[index].ndarray
+        if ax_index is None:
+            ax_index = plt.gca()
+        result[index] = getattr(ax_index, method.__name__)()
+
+    return result
+
+
+def plt_axes_attribute(
+    method: str,
+    ax: na.AbstractScalarArray,
+) -> na.ScalarArray:
+
+    try:
+        ax = scalars._normalize(ax)
+    except na.ScalarTypeError:  # pragma: nocover
+        return NotImplemented
+
+    result = na.ScalarArray.empty(shape=ax.shape, dtype=object)
+
+    for index in na.ndindex(ax.shape):
+        ax_index = ax[index].ndarray
+        if ax_index is None:
+            ax_index = plt.gca()
+        result[index] = getattr(ax_index, method.__name__)
+
+    return result
+
+
 @_implements(na.jacobian)
 def jacobian(
         function: Callable[[na.AbstractScalar], na.AbstractScalar],

named_arrays/_scalars/scalars.py

@@ -565,6 +565,12 @@
         if func in scalar_named_array_functions.PLT_AXES_SETTERS:
             return scalar_named_array_functions.plt_axes_setter(func, *args, **kwargs)
 
+        if func in scalar_named_array_functions.PLT_AXES_GETTERS:
+            return scalar_named_array_functions.plt_axes_getter(func, *args, **kwargs)
+
+        if func in scalar_named_array_functions.PLT_AXES_ATTRIBUTES:
+            return scalar_named_array_functions.plt_axes_attribute(func, *args, **kwargs)
+
         if func in scalar_named_array_functions.NDFILTER_FUNCTIONS:
             return scalar_named_array_functions.ndfilter(func, *args, **kwargs)
 

named_arrays/plt.py

@@ -1,5 +1,7 @@
 from __future__ import annotations
 from typing import Literal, Any
+import matplotlib.axes
+import matplotlib.transforms
 import matplotlib.animation
 import matplotlib.pyplot as plt
 import astropy.units as u
@@ -18,11 +20,19 @@
     "text",
     "brace_vertical",
     "set_xlabel",
+    "get_xlabel",
     "set_ylabel",
+    "get_ylabel",
     "set_title",
+    "get_title",
     "set_xscale",
+    "get_xscale",
     "set_yscale",
+    "get_yscale",
     "set_aspect",
+    "get_aspect",
+    "transAxes",
+    "transData",
 ]
 
 
@@ -885,6 +895,24 @@
     )
 
 
+def get_xlabel(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
+) -> str | na.AbstractScalar:
+    """
+    A thin wrapper around :meth:`matplotlib.axes.Axes.get_xlabel` for named arrays.
+
+    Parameters
+    ----------
+    ax
+        The matplotlib axes instance(s) to get the horizontal axis label from.
+    """
+    return na._named_array_function(
+        get_xlabel,
+        ax=na.as_named_array(ax),
+    )
+
+
+
 def set_ylabel(
     ylabel: str | na.AbstractScalar,
     ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
@@ -908,6 +936,23 @@
     )
 
 
+def get_ylabel(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
+) -> str | na.AbstractScalar:
+    """
+    A thin wrapper around :meth:`matplotlib.axes.Axes.get_ylabel` for named arrays.
+
+    Parameters
+    ----------
+    ax
+        The matplotlib axes instance(s) to get the vertical axis label from.
+    """
+    return na._named_array_function(
+        get_ylabel,
+        ax=na.as_named_array(ax),
+    )
+
+
 def set_title(
     label: str | na.AbstractScalar,
     ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
@@ -931,6 +976,23 @@
     )
 
 
+def get_title(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
+) -> str | na.AbstractScalar:
+    """
+    A thin wrapper around :meth:`matplotlib.axes.Axes.get_title` for named arrays.
+
+    Parameters
+    ----------
+    ax
+        The matplotlib axes instance(s) to get the title label from.
+    """
+    return na._named_array_function(
+        get_title,
+        ax=na.as_named_array(ax),
+    )
+
+
 def set_xscale(
     value: str | na.AbstractScalar,
     ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
@@ -954,6 +1016,23 @@
     )
 
 
+def get_xscale(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
+) -> str | na.AbstractScalar:
+    """
+    A thin wrapper around :meth:`matplotlib.axes.Axes.get_xscale` for named arrays.
+
+    Parameters
+    ----------
+    ax
+        The matplotlib axes instance(s) to get the horizontal axis scale from.
+    """
+    return na._named_array_function(
+        get_xscale,
+        ax=na.as_named_array(ax),
+    )
+
+
 def set_yscale(
     value: str | na.AbstractScalar,
     ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
@@ -977,6 +1056,23 @@
     )
 
 
+def get_yscale(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
+) -> str | na.AbstractScalar:
+    """
+    A thin wrapper around :meth:`matplotlib.axes.Axes.get_yscale` for named arrays.
+
+    Parameters
+    ----------
+    ax
+        The matplotlib axes instance(s) to get the vertical axis scale from.
+    """
+    return na._named_array_function(
+        get_yscale,
+        ax=na.as_named_array(ax),
+    )
+
+
 def set_aspect(
     aspect: float | str | na.AbstractScalar,
     ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
@@ -1000,6 +1096,57 @@
     )
 
 
+def get_aspect(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
+) -> str | na.AbstractScalar:
+    """
+    A thin wrapper around :meth:`matplotlib.axes.Axes.get_aspect` for named arrays.
+
+    Parameters
+    ----------
+    ax
+        The matplotlib axes instance(s) to get the aspect ratio from.
+    """
+    return na._named_array_function(
+        get_aspect,
+        ax=na.as_named_array(ax),
+    )
+
+
+def transAxes(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
+) -> matplotlib.transforms.Transform | na.AbstractScalar:
+    """
+    A thin wrapper around :attr:`matplotlib.axes.Axes.transAxes` for named arrays.
+
+    Parameters
+    ----------
+    ax
+        The matplotlib axes instance(s) to get the axes transformation from.
+    """
+    return na._named_array_function(
+        transAxes,
+        ax=na.as_named_array(ax),
+    )
+
+
+def transData(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar = None,
+) -> matplotlib.transforms.Transform | na.AbstractScalar:
+    """
+    A thin wrapper around :attr:`matplotlib.axes.Axes.transData` for named arrays.
+
+    Parameters
+    ----------
+    ax
+        The matplotlib axes instance(s) to get the axes transformation from.
+    """
+    return na._named_array_function(
+        transData,
+        ax=na.as_named_array(ax),
+    )
+
+
 def brace_vertical(
     x: float | u.Quantity | na.AbstractScalar,
     width: float | u.Quantity | na.AbstractScalar,

named_arrays/tests/test_plt.py

@@ -1,4 +1,5 @@
 import pytest
+import numpy as np
 import matplotlib.axes
 import matplotlib.animation
 import named_arrays as na
@@ -58,6 +59,8 @@
     ax: None | matplotlib.axes.Axes | na.AbstractScalar,
 ):
     na.plt.set_xlabel(xlabel, ax=ax)
+    result = na.plt.get_xlabel(ax)
+    assert np.all(result == xlabel)
 
 
 @pytest.mark.parametrize(
@@ -72,6 +75,8 @@
     ax: None | matplotlib.axes.Axes | na.AbstractScalar,
 ):
     na.plt.set_ylabel(ylabel, ax=ax)
+    result = na.plt.get_ylabel(ax)
+    assert np.all(result == ylabel)
 
 
 @pytest.mark.parametrize(
@@ -86,6 +91,8 @@
     ax: None | matplotlib.axes.Axes | na.AbstractScalar,
 ):
     na.plt.set_title(label, ax=ax)
+    result = na.plt.get_title(ax)
+    assert np.all(result == label)
 
 
 @pytest.mark.parametrize(
@@ -100,6 +107,8 @@
     ax: None | matplotlib.axes.Axes | na.AbstractScalar,
 ):
     na.plt.set_xscale(value, ax=ax)
+    result = na.plt.get_xscale(ax)
+    assert np.all(result == value)
 
 
 @pytest.mark.parametrize(
@@ -114,13 +123,15 @@
     ax: None | matplotlib.axes.Axes | na.AbstractScalar,
 ):
     na.plt.set_yscale(value, ax=ax)
+    result = na.plt.get_yscale(ax)
+    assert np.all(result == value)
 
 
 @pytest.mark.parametrize(
     argnames="aspect,ax",
     argvalues=[
-        ("equal", None),
-        ("equal", na.plt.subplots(ncols=3)[1]),
+        (1, None),
+        (1, na.plt.subplots(ncols=3)[1]),
         (2, na.plt.subplots(ncols=3)[1]),
     ]
 )
@@ -129,3 +140,35 @@
     ax: None | matplotlib.axes.Axes | na.AbstractScalar,
 ):
     na.plt.set_aspect(aspect, ax=ax)
+    result = na.plt.get_aspect(ax)
+    assert np.all(result == aspect)
+
+
+@pytest.mark.parametrize(
+    argnames="ax",
+    argvalues=[
+        None,
+        na.plt.subplots(ncols=3)[1]
+    ]
+)
+def test_transAxes(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar,
+):
+    result = na.plt.transAxes(ax)
+    assert isinstance(result, na.AbstractArray)
+    assert result.shape == na.shape(ax)
+
+
+@pytest.mark.parametrize(
+    argnames="ax",
+    argvalues=[
+        None,
+        na.plt.subplots(ncols=3)[1]
+    ]
+)
+def test_transData(
+    ax: None | matplotlib.axes.Axes | na.AbstractScalar,
+):
+    result = na.plt.transData(ax)
+    assert isinstance(result, na.AbstractArray)
+    assert result.shape == na.shape(ax)