CLN: rename private functions used across modules (#36049)

Author: jbrockmendel

pandas/plotting/_matplotlib/boxplot.py

@@ -12,8 +12,8 @@
 
 from pandas.io.formats.printing import pprint_thing
 from pandas.plotting._matplotlib.core import LinePlot, MPLPlot
-from pandas.plotting._matplotlib.style import _get_standard_colors
-from pandas.plotting._matplotlib.tools import _flatten, _subplots
+from pandas.plotting._matplotlib.style import get_standard_colors
+from pandas.plotting._matplotlib.tools import create_subplots, flatten_axes
 
 if TYPE_CHECKING:
     from matplotlib.axes import Axes
@@ -84,7 +84,7 @@ def _validate_color_args(self):
             self.color = None
 
         # get standard colors for default
-        colors = _get_standard_colors(num_colors=3, colormap=self.colormap, color=None)
+        colors = get_standard_colors(num_colors=3, colormap=self.colormap, color=None)
         # use 2 colors by default, for box/whisker and median
         # flier colors isn't needed here
         # because it can be specified by ``sym`` kw
@@ -200,11 +200,11 @@ def _grouped_plot_by_column(
             by = [by]
         columns = data._get_numeric_data().columns.difference(by)
     naxes = len(columns)
-    fig, axes = _subplots(
+    fig, axes = create_subplots(
         naxes=naxes, sharex=True, sharey=True, figsize=figsize, ax=ax, layout=layout
     )
 
-    _axes = _flatten(axes)
+    _axes = flatten_axes(axes)
 
     ax_values = []
 
@@ -259,7 +259,7 @@ def _get_colors():
         #  num_colors=3 is required as method maybe_color_bp takes the colors
         #  in positions 0 and 2.
         #  if colors not provided, use same defaults as DataFrame.plot.box
-        result = _get_standard_colors(num_colors=3)
+        result = get_standard_colors(num_colors=3)
         result = np.take(result, [0, 0, 2])
         result = np.append(result, "k")
 
@@ -414,7 +414,7 @@ def boxplot_frame_groupby(
 ):
     if subplots is True:
         naxes = len(grouped)
-        fig, axes = _subplots(
+        fig, axes = create_subplots(
             naxes=naxes,
             squeeze=False,
             ax=ax,
@@ -423,7 +423,7 @@ def boxplot_frame_groupby(
             figsize=figsize,
             layout=layout,
         )
-        axes = _flatten(axes)
+        axes = flatten_axes(axes)
 
         ret = pd.Series(dtype=object)
 

pandas/plotting/_matplotlib/core.py

@@ -32,14 +32,14 @@
 from pandas.io.formats.printing import pprint_thing
 from pandas.plotting._matplotlib.compat import _mpl_ge_3_0_0
 from pandas.plotting._matplotlib.converter import register_pandas_matplotlib_converters
-from pandas.plotting._matplotlib.style import _get_standard_colors
+from pandas.plotting._matplotlib.style import get_standard_colors
 from pandas.plotting._matplotlib.tools import (
-    _flatten,
-    _get_all_lines,
-    _get_xlim,
-    _handle_shared_axes,
-    _subplots,
+    create_subplots,
+    flatten_axes,
     format_date_labels,
+    get_all_lines,
+    get_xlim,
+    handle_shared_axes,
     table,
 )
 
@@ -306,7 +306,7 @@ def _maybe_right_yaxis(self, ax: "Axes", axes_num):
 
     def _setup_subplots(self):
         if self.subplots:
-            fig, axes = _subplots(
+            fig, axes = create_subplots(
                 naxes=self.nseries,
                 sharex=self.sharex,
                 sharey=self.sharey,
@@ -325,7 +325,7 @@ def _setup_subplots(self):
                     fig.set_size_inches(self.figsize)
                 axes = self.ax
 
-        axes = _flatten(axes)
+        axes = flatten_axes(axes)
 
         valid_log = {False, True, "sym", None}
         input_log = {self.logx, self.logy, self.loglog}
@@ -457,7 +457,7 @@ def _adorn_subplots(self):
         if len(self.axes) > 0:
             all_axes = self._get_subplots()
             nrows, ncols = self._get_axes_layout()
-            _handle_shared_axes(
+            handle_shared_axes(
                 axarr=all_axes,
                 nplots=len(all_axes),
                 naxes=nrows * ncols,
@@ -744,7 +744,7 @@ def _get_colors(self, num_colors=None, color_kwds="color"):
         if num_colors is None:
             num_colors = self.nseries
 
-        return _get_standard_colors(
+        return get_standard_colors(
             num_colors=num_colors,
             colormap=self.colormap,
             color=self.kwds.get(color_kwds),
@@ -1123,8 +1123,8 @@ def _make_plot(self):
 
                 # reset of xlim should be used for ts data
                 # TODO: GH28021, should find a way to change view limit on xaxis
-                lines = _get_all_lines(ax)
-                left, right = _get_xlim(lines)
+                lines = get_all_lines(ax)
+                left, right = get_xlim(lines)
                 ax.set_xlim(left, right)
 
     @classmethod

pandas/plotting/_matplotlib/hist.py

@@ -8,7 +8,11 @@
 
 from pandas.io.formats.printing import pprint_thing
 from pandas.plotting._matplotlib.core import LinePlot, MPLPlot
-from pandas.plotting._matplotlib.tools import _flatten, _set_ticks_props, _subplots
+from pandas.plotting._matplotlib.tools import (
+    create_subplots,
+    flatten_axes,
+    set_ticks_props,
+)
 
 if TYPE_CHECKING:
     from matplotlib.axes import Axes
@@ -198,11 +202,11 @@ def _grouped_plot(
         grouped = grouped[column]
 
     naxes = len(grouped)
-    fig, axes = _subplots(
+    fig, axes = create_subplots(
         naxes=naxes, figsize=figsize, sharex=sharex, sharey=sharey, ax=ax, layout=layout
     )
 
-    _axes = _flatten(axes)
+    _axes = flatten_axes(axes)
 
     for i, (key, group) in enumerate(grouped):
         ax = _axes[i]
@@ -286,7 +290,7 @@ def plot_group(group, ax):
         rot=rot,
     )
 
-    _set_ticks_props(
+    set_ticks_props(
         axes, xlabelsize=xlabelsize, xrot=xrot, ylabelsize=ylabelsize, yrot=yrot
     )
 
@@ -337,7 +341,7 @@ def hist_series(
         ax.grid(grid)
         axes = np.array([ax])
 
-        _set_ticks_props(
+        set_ticks_props(
             axes, xlabelsize=xlabelsize, xrot=xrot, ylabelsize=ylabelsize, yrot=yrot
         )
 
@@ -419,7 +423,7 @@ def hist_frame(
     if naxes == 0:
         raise ValueError("hist method requires numerical columns, nothing to plot.")
 
-    fig, axes = _subplots(
+    fig, axes = create_subplots(
         naxes=naxes,
         ax=ax,
         squeeze=False,
@@ -428,7 +432,7 @@ def hist_frame(
         figsize=figsize,
         layout=layout,
     )
-    _axes = _flatten(axes)
+    _axes = flatten_axes(axes)
 
     can_set_label = "label" not in kwds
 
@@ -442,7 +446,7 @@ def hist_frame(
         if legend:
             ax.legend()
 
-    _set_ticks_props(
+    set_ticks_props(
         axes, xlabelsize=xlabelsize, xrot=xrot, ylabelsize=ylabelsize, yrot=yrot
     )
     fig.subplots_adjust(wspace=0.3, hspace=0.3)

pandas/plotting/_matplotlib/misc.py

@@ -10,8 +10,8 @@
 from pandas.core.dtypes.missing import notna
 
 from pandas.io.formats.printing import pprint_thing
-from pandas.plotting._matplotlib.style import _get_standard_colors
-from pandas.plotting._matplotlib.tools import _set_ticks_props, _subplots
+from pandas.plotting._matplotlib.style import get_standard_colors
+from pandas.plotting._matplotlib.tools import create_subplots, set_ticks_props
 
 if TYPE_CHECKING:
     from matplotlib.axes import Axes
@@ -36,7 +36,7 @@ def scatter_matrix(
     df = frame._get_numeric_data()
     n = df.columns.size
     naxes = n * n
-    fig, axes = _subplots(naxes=naxes, figsize=figsize, ax=ax, squeeze=False)
+    fig, axes = create_subplots(naxes=naxes, figsize=figsize, ax=ax, squeeze=False)
 
     # no gaps between subplots
     fig.subplots_adjust(wspace=0, hspace=0)
@@ -112,7 +112,7 @@ def scatter_matrix(
             locs = locs.astype(int)
         axes[0][0].yaxis.set_ticklabels(locs)
 
-    _set_ticks_props(axes, xlabelsize=8, xrot=90, ylabelsize=8, yrot=0)
+    set_ticks_props(axes, xlabelsize=8, xrot=90, ylabelsize=8, yrot=0)
 
     return axes
 
@@ -147,7 +147,7 @@ def normalize(series):
         ax = plt.gca(xlim=[-1, 1], ylim=[-1, 1])
 
     to_plot: Dict[Label, List[List]] = {}
-    colors = _get_standard_colors(
+    colors = get_standard_colors(
         num_colors=len(classes), colormap=colormap, color_type="random", color=color
     )
 
@@ -255,7 +255,7 @@ def f(t):
     t = np.linspace(-np.pi, np.pi, samples)
     used_legends: Set[str] = set()
 
-    color_values = _get_standard_colors(
+    color_values = get_standard_colors(
         num_colors=len(classes), colormap=colormap, color_type="random", color=color
     )
     colors = dict(zip(classes, color_values))
@@ -382,7 +382,7 @@ def parallel_coordinates(
     if ax is None:
         ax = plt.gca()
 
-    color_values = _get_standard_colors(
+    color_values = get_standard_colors(
         num_colors=len(classes), colormap=colormap, color_type="random", color=color
     )
 

pandas/plotting/_matplotlib/style.py

@@ -10,7 +10,7 @@
 import pandas.core.common as com
 
 
-def _get_standard_colors(
+def get_standard_colors(
     num_colors=None, colormap=None, color_type: str = "default", color=None
 ):
     import matplotlib.pyplot as plt

pandas/plotting/_matplotlib/tools.py

@@ -100,7 +100,7 @@ def _get_layout(nplots: int, layout=None, layout_type: str = "box") -> Tuple[int
 # copied from matplotlib/pyplot.py and modified for pandas.plotting
 
 
-def _subplots(
+def create_subplots(
     naxes: int,
     sharex: bool = False,
     sharey: bool = False,
@@ -194,7 +194,7 @@ def _subplots(
         fig = plt.figure(**fig_kw)
     else:
         if is_list_like(ax):
-            ax = _flatten(ax)
+            ax = flatten_axes(ax)
             if layout is not None:
                 warnings.warn(
                     "When passing multiple axes, layout keyword is ignored", UserWarning
@@ -221,7 +221,7 @@ def _subplots(
             if squeeze:
                 return fig, ax
             else:
-                return fig, _flatten(ax)
+                return fig, flatten_axes(ax)
         else:
             warnings.warn(
                 "To output multiple subplots, the figure containing "
@@ -264,7 +264,7 @@ def _subplots(
         for ax in axarr[naxes:]:
             ax.set_visible(False)
 
-    _handle_shared_axes(axarr, nplots, naxes, nrows, ncols, sharex, sharey)
+    handle_shared_axes(axarr, nplots, naxes, nrows, ncols, sharex, sharey)
 
     if squeeze:
         # Reshape the array to have the final desired dimension (nrow,ncol),
@@ -297,7 +297,7 @@ def _remove_labels_from_axis(axis: "Axis"):
     axis.get_label().set_visible(False)
 
 
-def _handle_shared_axes(
+def handle_shared_axes(
     axarr: Iterable["Axes"],
     nplots: int,
     naxes: int,
@@ -351,15 +351,15 @@ def _handle_shared_axes(
                     _remove_labels_from_axis(ax.yaxis)
 
 
-def _flatten(axes: Union["Axes", Sequence["Axes"]]) -> Sequence["Axes"]:
+def flatten_axes(axes: Union["Axes", Sequence["Axes"]]) -> Sequence["Axes"]:
     if not is_list_like(axes):
         return np.array([axes])
     elif isinstance(axes, (np.ndarray, ABCIndexClass)):
         return axes.ravel()
     return np.array(axes)
 
 
-def _set_ticks_props(
+def set_ticks_props(
     axes: Union["Axes", Sequence["Axes"]],
     xlabelsize=None,
     xrot=None,
@@ -368,7 +368,7 @@ def _set_ticks_props(
 ):
     import matplotlib.pyplot as plt
 
-    for ax in _flatten(axes):
+    for ax in flatten_axes(axes):
         if xlabelsize is not None:
             plt.setp(ax.get_xticklabels(), fontsize=xlabelsize)
         if xrot is not None:
@@ -380,7 +380,7 @@ def _set_ticks_props(
     return axes
 
 
-def _get_all_lines(ax: "Axes") -> List["Line2D"]:
+def get_all_lines(ax: "Axes") -> List["Line2D"]:
     lines = ax.get_lines()
 
     if hasattr(ax, "right_ax"):
@@ -392,7 +392,7 @@ def _get_all_lines(ax: "Axes") -> List["Line2D"]:
     return lines
 
 
-def _get_xlim(lines: Iterable["Line2D"]) -> Tuple[float, float]:
+def get_xlim(lines: Iterable["Line2D"]) -> Tuple[float, float]:
     left, right = np.inf, -np.inf
     for l in lines:
         x = l.get_xdata(orig=False)