Better doc string support.

Author: isaacrobinson2000

matplotview/__init__.py

@@ -1,12 +1,14 @@
 from typing import Optional, Iterable, Type, Union
 from matplotlib.artist import Artist
 from matplotlib.axes import Axes
-from matplotview._view_axes import view_wrapper, ViewSpecification
+from matplotview._view_axes import view_wrapper, ViewSpecification, DEFAULT_RENDER_DEPTH
+from matplotview._docs import dynamic_doc_string, get_interpolation_list_str
 
 
 __all__ = ["view", "inset_zoom_axes", "ViewSpecification"]
 
 
+@dynamic_doc_string(render_depth=DEFAULT_RENDER_DEPTH, interp_list=get_interpolation_list_str())
 def view(
     axes: Axes,
     axes_to_view: Axes,
@@ -28,29 +30,31 @@ def view(
         The axes to display the contents of in the first axes, the 'viewed'
         axes.
 
-    image_interpolation: string, default of "nearest"
+    image_interpolation: string, default of '{image_interpolation}'
         The image interpolation method to use when displaying scaled images
-        from the axes being viewed. Defaults to "nearest". Supported options
-        are 'antialiased', 'nearest', 'bilinear', 'bicubic', 'spline16',
-        'spline36', 'hanning', 'hamming', 'hermite', 'kaiser', 'quadric',
-        'catrom', 'gaussian', 'bessel', 'mitchell', 'sinc', 'lanczos',
-        or 'none'
+        from the axes being viewed. Defaults to '{image_interpolation}'. Supported options
+        are {interp_list}.
 
     render_depth: optional int, positive, defaults to None
         The number of recursive draws allowed for this view, this can happen
         if the view is a child of the axes (such as an inset axes) or if
         two views point at each other. If None, uses the default render depth
-        of 5, unless the axes passed is already a view axes, in which case the
+        of {render_depth}, unless the axes passed is already a view axes, in which case the
         render depth the view already has will be used.
 
     filter_set: Iterable[Union[Type[Artist], Artist]] or None
         An optional filter set, which can be used to select what artists
         are drawn by the view. Any artists or artist types in the set are not
         drawn.
 
-    scale_lines: bool, defaults to True
+    scale_lines: bool, defaults to {scale_lines}
         Specifies if lines should be drawn thicker based on scaling in the
         view.
+
+    Returns
+    -------
+    axes
+        The modified `~.axes.Axes` instance which is now a view.
     """
     view_obj = view_wrapper(type(axes)).from_axes(axes, render_depth)
     view_obj.view_specifications[axes_to_view] = ViewSpecification(
@@ -61,6 +65,7 @@ def view(
     return view_obj
 
 
+@dynamic_doc_string(render_depth=DEFAULT_RENDER_DEPTH, interp_list=get_interpolation_list_str())
 def inset_zoom_axes(
     axes: Axes,
     bounds: Iterable,
@@ -69,7 +74,7 @@ def inset_zoom_axes(
     render_depth: Optional[int] = None,
     filter_set: Optional[Iterable[Union[Type[Artist], Artist]]] = None,
     scale_lines: bool = True,
-    transform=None,
+    transform = None,
     zorder: int = 5,
     **kwargs
 ) -> Axes:
@@ -90,31 +95,28 @@ def inset_zoom_axes(
         Axes-relative coordinates.
 
     zorder: number
-        Defaults to 5 (same as `.Axes.legend`).  Adjust higher or lower
+        Defaults to {zorder} (same as `.Axes.legend`).  Adjust higher or lower
         to change whether it is above or below data plotted on the
         parent Axes.
 
     image_interpolation: string
-        Supported options are 'antialiased', 'nearest', 'bilinear',
-        'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite',
-        'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell',
-        'sinc', 'lanczos', or 'none'. The default value is 'nearest'. This
+        Supported options are {interp_list}. The default value is '{image_interpolation}'. This
         determines the interpolation used when attempting to render a
         zoomed version of an image.
 
     render_depth: optional int, positive, defaults to None
         The number of recursive draws allowed for this view, this can happen
         if the view is a child of the axes (such as an inset axes) or if
         two views point at each other. If None, uses the default render depth
-        of 5, unless the axes passed is already a view axes, in which case the
+        of {render_depth}, unless the axes passed is already a view axes, in which case the
         render depth the view already has will be used.
 
     filter_set: Iterable[Union[Type[Artist], Artist]] or None
         An optional filter set, which can be used to select what artists
         are drawn by the view. Any artists or artist types in the set are not
         drawn.
 
-    scale_lines: bool, defaults to True
+    scale_lines: bool, defaults to {scale_lines}
         Specifies if lines should be drawn thicker based on scaling in the
         view.
 

matplotview/_docs.py

@@ -0,0 +1,20 @@
+import inspect
+from inspect import signature
+
+
+def dynamic_doc_string(**kwargs):
+    def convert(func):
+        default_vals = {
+            k: v.default for k, v in signature(func).parameters.items() if(v.default is not inspect.Parameter.empty)
+        }
+        default_vals.update(kwargs)
+        func.__doc__ = func.__doc__.format(**default_vals)
+
+        return func
+
+    return convert
+
+
+def get_interpolation_list_str():
+    from matplotlib.image import _interpd_
+    return ", ".join([f"'{k}'" if(i != len(_interpd_) - 1) else f"or '{k}'" for i, k in enumerate(_interpd_)])

matplotview/_transform_renderer.py

@@ -6,6 +6,7 @@
 import matplotlib._image as _image
 import numpy as np
 from matplotlib.image import _interpd_
+from matplotview._docs import dynamic_doc_string, get_interpolation_list_str
 
 
 class _TransformRenderer(RendererBase):
@@ -15,6 +16,7 @@ class _TransformRenderer(RendererBase):
     original renderer.
     """
 
+    @dynamic_doc_string(interp_list=get_interpolation_list_str())
     def __init__(
         self,
         base_renderer,
@@ -42,22 +44,19 @@ def __init__(
 
         transform: `~matplotlib.transforms.Transform`
             The main transform to be used for plotting all objects once
-            converted into the mock_transform coordinate space. Typically this
+            converted into the mock_transform coordinate space. Typically, this
             is the child axes data coordinate space (transData).
 
         bounding_axes: `~matplotlib.axes.Axes`
             The axes to plot everything within. Everything outside of this
             axes will be clipped.
 
         image_interpolation: string
-            Supported options are 'antialiased', 'nearest', 'bilinear',
-            'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite',
-            'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell',
-            'sinc', 'lanczos', or 'none'. The default value is 'nearest'. This
+            Supported options are {interp_list}. The default value is '{image_interpolation}'. This
             determines the interpolation used when attempting to render a
             zoomed version of an image.
 
-        scale_linewidths: bool, default is True
+        scale_linewidths: bool, default is {scale_linewidths}
             Specifies if line widths should be scaled, in addition to the
             paths themselves.
 

matplotview/_view_axes.py

@@ -8,6 +8,7 @@
 from matplotlib.artist import Artist
 from matplotlib.backend_bases import RendererBase
 from dataclasses import dataclass
+from matplotview._docs import dynamic_doc_string, get_interpolation_list_str
 
 DEFAULT_RENDER_DEPTH = 5
 
@@ -96,6 +97,7 @@ def _view_from_pickle(builder, args):
     return res
 
 
+@dynamic_doc_string(render_depth=DEFAULT_RENDER_DEPTH, interp_list=get_interpolation_list_str())
 @dataclass
 class ViewSpecification:
     """
@@ -105,19 +107,16 @@ class ViewSpecification:
     Parameters:
     -----------
     image_interpolation: string
-        Supported options are 'antialiased', 'nearest', 'bilinear',
-        'bicubic', 'spline16', 'spline36', 'hanning', 'hamming', 'hermite',
-        'kaiser', 'quadric', 'catrom', 'gaussian', 'bessel', 'mitchell',
-        'sinc', 'lanczos', or 'none'. The default value is 'nearest'. This
+        Supported options are {interp_list}. The default value is '{image_interpolation}'. This
         determines the interpolation used when attempting to render a
         zoomed version of an image.
 
-    filter_set: Iterable[Union[Type[Artist], Artist]] or None
+    filter_set: Iterable[Union[Type[Artist], Artist]] or {filter_set}
         An optional filter set, which can be used to select what artists
         are drawn by the view. Any artists or artist types in the set are not
         drawn.
 
-    scale_lines: bool, defaults to True
+    scale_lines: bool, defaults to {scale_lines}
         Specifies if lines should be drawn thicker based on scaling in the
         view.
     """
@@ -170,6 +169,8 @@ class View(axes_class, __ViewType):
         An axes which automatically displays elements of another axes. Does not
         require Artists to be plotted twice.
         """
+
+        @dynamic_doc_string()
         def __init__(
             self,
             *args,
@@ -181,17 +182,14 @@ def __init__(
 
             Parameters
             ----------
-            axes_to_view: `~.axes.Axes`
-                The axes to create a view of.
-
             *args
                 Additional arguments to be passed to the Axes class this
                 ViewAxes wraps.
 
-            render_depth: int, positive, defaults to 5
+            render_depth: int, positive, defaults to {render_depth}
                 The number of recursive draws allowed for this view, this can
                 happen if the view is a child of the axes (such as an inset
-                axes) or if two views point at each other. Defaults to 5.
+                axes) or if two views point at each other. Defaults to {render_depth}.
 
             **kwargs
                 Other optional keyword arguments supported by the Axes
@@ -342,6 +340,7 @@ def view_specifications(self) -> Dict[Axes, ViewSpecification]:
         view_specs = view_specifications
 
         @classmethod
+        @dynamic_doc_string(render_depth=DEFAULT_RENDER_DEPTH)
         def from_axes(
             cls,
             axes: Axes,
@@ -362,7 +361,7 @@ def from_axes(
                 The number of recursive draws allowed for this view, this can
                 happen if the view is a child of the axes (such as an inset
                 axes) or if two views point at each other. If none, use the
-                default value (5) if the render depth is not already set.
+                default value ({render_depth}) if the render depth is not already set.
 
             Returns
             -------

matplotview/tests/test_view_obj.py

@@ -5,7 +5,6 @@
 from matplotview._view_axes import DEFAULT_RENDER_DEPTH, view_wrapper
 import numpy as np
 
-
 def test_obj_comparison():
     from matplotlib.axes import Subplot, Axes