Add markersize alias for s and markerscale kwarg

chahak13 · chahak13 · commit 9ac788de4f30 · 2023-03-13T21:41:10.000-05:00
diff --git a/lib/matplotlib/axes/_axes.py b/lib/matplotlib/axes/_axes.py
@@ -4465,7 +4465,7 @@ def invalid_shape_exception(csize, xsize):
     @_docstring.interpd
     def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
                 vmin=None, vmax=None, alpha=None, linewidths=None, *,
-                edgecolors=None, plotnonfinite=False, markersize=None, **kwargs):
+                edgecolors=None, plotnonfinite=False, markerscale=2, **kwargs):
         """
         A scatter plot of *y* vs. *x* with varying marker size and/or color.
 
@@ -4545,10 +4545,9 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
             or ``nan``). If ``True`` the points are drawn with the *bad*
             colormap color (see `.Colormap.set_bad`).
 
-        markersize : float or array-like, shape (n, ), optional
-            The marker size in points. This differs from `s` as it sets the
-            size directly in points instead of points**2. `s` is used by
-            default to set the size if neither are passed.
+        markerscale : 1 or 2, optional, default: 2
+            Scaling factor used to set the size as points or points**2.
+            Default value is set as 2 to set the size values as points**2.
 
         Returns
         -------
@@ -4589,19 +4588,18 @@ def scatter(self, x, y, s=None, c=None, marker=None, cmap=None, norm=None,
         if x.size != y.size:
             raise ValueError("x and y must be the same size")
 
-        if s is not None and markersize is not None:
+        if s is not None and 'markersize' in kwargs:
             raise ValueError(
-                "Only one of s or markersize should be passed. "
+                "Only one of `s` or `markersize` should be passed. "
                 "Please refer to the docs for more details about usage.")
 
         if s is None:
-            s = (20 if mpl.rcParams['_internal.classic_mode'] else
-                 mpl.rcParams['lines.markersize'] ** 2.0)
+            if 'markersize' not in kwargs:
+                s = (20 if mpl.rcParams['_internal.classic_mode'] else
+                        mpl.rcParams['lines.markersize'] ** 2.0)
+            else:
+                s = kwargs.pop('markersize')
         s = np.ma.ravel(s)
-        markerscale = 2
-        if markersize is not None:
-            s = np.ma.ravel(markersize)
-            markerscale = 1
         if (len(s) not in (1, x.size) or
                 (not np.issubdtype(s.dtype, np.floating) and
                  not np.issubdtype(s.dtype, np.integer))):
diff --git a/lib/matplotlib/collections.py b/lib/matplotlib/collections.py
@@ -940,24 +940,43 @@ def update_from(self, other):
         self.stale = True
 
 
+@_api.define_aliases({
+    "sizes": ["s", "markersize"]
+})
 class _CollectionWithSizes(Collection):
     """
     Base class for collections that have an array of sizes.
     """
     _factor = 1.0
-    _markerscale = 2
 
     def get_sizes(self):
         """
-        Return the sizes ('areas') of the elements in the collection.
+        Return the sizes of the elements in the collection.
+
+        The sizes of the elements in the collection will be returned in
+        the last set scale of the markers, i.e. if the markerscale was
+        set to 1 then the sizes are set in points and if markerscale was
+        set to 2 then the sizes returned are such that the marker size is
+        in points**2.
 
         Returns
         -------
         array
-            The 'area' of each element.
+            The 'size' of each element.
         """
         return self._sizes
 
+    def get_markerscale(self):
+        """
+        Return the scale used for marker sizing.
+
+        Returns
+        -------
+        int
+            The scale used to set the marker sizes.
+        """
+        return self._markerscale
+
     def set_sizes(self, sizes, dpi=72.0, markerscale=2):
         """
         Set the sizes of each member of the collection.
@@ -969,19 +988,19 @@ def set_sizes(self, sizes, dpi=72.0, markerscale=2):
             value is the 'area' of the element.
         dpi : float, default: 72
             The dpi of the canvas.
-        markerscale : int, default: 2
-            Scaling factor used to set the size as points or points**2.
-            Default value is set as 2 used for `s` and changed to 1 if
-            `markersize` is provided instead of `s`.
+        markerscale : 1 or 2, default: 2
+            Scaling factor used to set the size as points (1) or points**2 (2).
         """
+        # breakpoint()
+        print(markerscale)
         self._markerscale = markerscale
         if sizes is None:
             self._sizes = np.array([])
             self._transforms = np.empty((0, 3, 3))
         else:
             self._sizes = np.asarray(sizes)
             self._transforms = np.zeros((len(self._sizes), 3, 3))
-            s = np.sqrt(self._sizes) if markerscale == 2 else self._sizes
+            s = np.sqrt(self._sizes) if self._markerscale == 2 else self._sizes
             scale = s * dpi / 72.0 * self._factor
             self._transforms[:, 0, 0] = scale
             self._transforms[:, 1, 1] = scale
@@ -1009,6 +1028,8 @@ def __init__(self, paths, sizes=None, markerscale=2, **kwargs):
             The factor by which to scale each drawn `~.path.Path`. One unit
             squared in the Path's data space is scaled to be ``sizes**2``
             points when rendered.
+        markerscale : 1 or 2, default: 2
+            Scaling factor used to set the size as points (1) or points**2 (2).
         **kwargs
             Forwarded to `.Collection`.
         """
diff --git a/lib/matplotlib/pyplot.py b/lib/matplotlib/pyplot.py
@@ -2831,13 +2831,13 @@ def quiverkey(Q, X, Y, U, label, **kwargs):
 def scatter(
         x, y, s=None, c=None, marker=None, cmap=None, norm=None,
         vmin=None, vmax=None, alpha=None, linewidths=None, *,
-        edgecolors=None, plotnonfinite=False, markersize=None,
+        edgecolors=None, plotnonfinite=False, markerscale=2,
         data=None, **kwargs):
     __ret = gca().scatter(
         x, y, s=s, c=c, marker=marker, cmap=cmap, norm=norm,
         vmin=vmin, vmax=vmax, alpha=alpha, linewidths=linewidths,
         edgecolors=edgecolors, plotnonfinite=plotnonfinite,
-        markersize=markersize,
+        markerscale=markerscale,
         **({"data": data} if data is not None else {}), **kwargs)
     sci(__ret)
     return __ret
diff --git a/lib/matplotlib/tests/test_collections.py b/lib/matplotlib/tests/test_collections.py
@@ -1216,3 +1216,25 @@ def test_striped_lines(fig_test, fig_ref, gapcolor):
     for x, gcol, ls in zip(x, itertools.cycle(gapcolor),
                            itertools.cycle(linestyles)):
         ax_ref.axvline(x, 0, 1, linestyle=ls, gapcolor=gcol, alpha=0.5)
+
+
+@check_figures_equal(extensions=["png"])
+def test_markerscale(fig_test, fig_ref):
+    ax_test = fig_test.add_subplot()
+    ax_ref = fig_ref.add_subplot()
+
+    x = np.arange(1, 6)**2
+
+    ax_test.scatter(x, x, s=x, markerscale=1)
+    ax_ref.scatter(x, x, s=x**2, markerscale=2)
+
+
+@check_figures_equal(extensions=["png"])
+def test_markersize_alias(fig_test, fig_ref):
+    ax_test = fig_test.add_subplot()
+    ax_ref = fig_ref.add_subplot()
+
+    x = np.arange(1, 6)**2
+
+    ax_test.scatter(x, x, s=x)
+    ax_ref.scatter(x, x, markersize=x)
