Add 'color' and 'size' to arguments #44856

mosc9575 · 2021-12-12T14:34:22Z

This changes use more intuitive names for 'color' and 'size' and use the same notation like in '_bar_or_line_doc'.

closes BUG: Pandas plot does not accept Columns for color keyword #44670

This changes use more intuitive names for 'color' and 'size' and use the same notation like in '_bar_or_line_doc'.

jreback · 2021-12-12T14:35:56Z

pandas/plotting/_core.py

@@ -1582,7 +1582,7 @@ def pie(self, **kwargs):
            raise ValueError("pie requires either y column or 'subplots=True'")
        return self(kind="pie", **kwargs)

-    def scatter(self, x, y, s=None, c=None, **kwargs):


you can deprecate but not rename as that is a breaking change

these are matpotlib names but not objecting to the change per se

I see your point but I need some help to solve it. What is best practice in this situation and how does a deprication warning work?

@mosc9575 check some other PRs which deprecate arguments for examples https://github.com/pandas-dev/pandas/pulls?q=is%3Apr+depr+is%3Amerged+

@jreback I used the wrong word. I did not "rename", I added size and color to avoid braking code.

I wouldn't keep both in the signature, that'd be confusing

I'd suggest:

use color and size in the signature

if color is None, take c from kwargs (likewise for size and s)

raise an error if someone passes both color and c

check that the docs consistently use color and size

@MarcoGorelli Thank you. I go with your suggestions. I will edit my PR.

thanks - will also need tests to cover the new behaviour

attack68 · 2021-12-12T15:27:27Z

pandas/plotting/_core.py

@@ -1582,7 +1582,7 @@ def pie(self, **kwargs):
            raise ValueError("pie requires either y column or 'subplots=True'")
        return self(kind="pie", **kwargs)

-    def scatter(self, x, y, s=None, c=None, **kwargs):
+    def scatter(self, x, y, size=None, s=None, color=None, c=None, **kwargs):


this can be used as positional arguments and your change is not backwards compatible, best to use the order:

self, x, y, s, c, size, color, **kwargs

actually I misread the purpose of this PR, shouldn't we be replicating matplotlibs arguments? Can you indicate why you want to make this change?

this can be used as positional arguments

ah yes, thanks - @mosc9575 please ignore part of my previous comment

let's keep s and c in the signature then, add color and size after them, and deprecate s and c?

Can you indicate why you want to make this change?

Just for consistency really, as in bar and barh it's color

Can you indicate why you want to make this change?

I opend this issue, because c was not intuitive for me. I don't have the matplotlib background, I normally work with bokeh, and they have the same functionality of c named color. Then I was searching the pandas documentation and found color used for hbar and bar. Therefor I thought this is not consitent and a misstake by this function. To be honest, I first understood the naming when I looked into matplotlib today. But it is still not "intuitive" to me.

Please let me know if you think this shouldn't be changed at all.

I was reading the matplotlib documentation for a while and the same problem can be found there. I will wait for a response to my issue #21795 and change both in one step, if this is approved.

i think we could also accept color size and and not deprecate

Yes, agreed, I'd go with:

keep signature as is

if c is None, take color from kwargs (likewise for s and size)

raise an error if someone passes both color and c, or size and s (and test this)

Conversely, for bar:

keep signature as is

if color is None, take c from kwargs

raise an error if someone passes both color and c (and test this)

Matplolib won't change and I think the sugessted changes by @MarcoGorelli are good. I try to edit my PR soon.

jreback · 2022-01-16T17:38:51Z

@mosc9575 if you'd merge master and addrress comments

pep8speaks · 2022-01-17T14:03:16Z

Hello @mosc9575! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

There are currently no PEP 8 issues detected in this Pull Request. Cheers! 🍻

Comment last updated at 2022-04-06 15:00:47 UTC

MarcoGorelli

Left a comment on error messages (also, will need tests)

pandas/plotting/_core.py

This reverts commit 1f30d45

pandas/plotting/_core.py

pandas/tests/plotting/test_series.py

pandas/tests/plotting/frame/test_frame_color.py

attack68

This is now looking pretty good to me. one or two comments just to remove code duplication in the tests, but it's looking quite minimal now.
After it goes green Im happy to approve.

Oh, and this should also be added to the doc strings and there should be a release note in the whatsnew if you havent added it already.

This reverts commit abf377e

MarcoGorelli

needs a whatsnew note for 1.5.0

MarcoGorelli · 2022-03-07T11:34:39Z

pandas/plotting/_core.py

+        size : str, int or array-like, optional
+                The color of each point. Alias for `s`.
+                `s` and `size` aren't allowed at the same time.
+                .. versionadded:: 1.4.1


jreback · 2022-03-07T13:47:45Z

pandas/plotting/_core.py

@@ -1603,7 +1603,8 @@ def scatter(self, x, y, s=None, c=None, **kwargs):
            The column name or column position to be used as vertical
            coordinates for each point.
        s : str, scalar or array-like, optional
-            The size of each point. Possible values are:
+            The size of each point. ``size`` is also accepted as an alternate keyword


i think we can list s, size : str.... here (i don't know if we do this for aliases elsewhere but should follow the same pattern), e.g. see read_csv where we have some aliases

If I follow the syntax of read_csv I have to write

size : str, scalar or array-like, optional Alias for s

I did not find a notation like s, size: str.

MarcoGorelli

jreback · 2022-04-07T16:42:58Z

should we deprecate passing c/s ? (or are these also accepted by mpl)?

MarcoGorelli · 2022-04-07T17:00:24Z

are these also accepted by mpl?

looks like they're inconsistent, scatter takes c, bar takes color

https://matplotlib.org/3.5.0/api/_as_gen/matplotlib.pyplot.scatter.html
https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.bar.html

jreback · 2022-04-07T17:26:00Z

are these also accepted by mpl?

looks like they're inconsistent, scatter takes c, bar takes color

https://matplotlib.org/3.5.0/api/_as_gen/matplotlib.pyplot.scatter.html https://matplotlib.org/stable/api/_as_gen/matplotlib.pyplot.bar.html

ok over time prob a good idea to use color/size (even if mpl accepts more).

jreback · 2022-04-07T17:26:13Z

thanks @mosc9575

mosc9575 · 2022-04-07T17:28:23Z

You are welcome. I appreciated your cooperation and help.

This reverts commit 8a4abfa. # Conflicts: # doc/source/whatsnew/v1.5.0.rst # pandas/plotting/_core.py # pandas/tests/plotting/frame/test_frame_color.py

* Revert "Add 'color' and 'size' to arguments (#44856)" This reverts commit 8a4abfa. # Conflicts: # doc/source/whatsnew/v1.5.0.rst # pandas/plotting/_core.py # pandas/tests/plotting/frame/test_frame_color.py * Add whatsnew

Co-authored-by: Patrick Hoefler <61934744+phofl@users.noreply.github.com>

…as-dev#49734) * Revert "Add 'color' and 'size' to arguments (pandas-dev#44856)" This reverts commit 8a4abfa. # Conflicts: # doc/source/whatsnew/v1.5.0.rst # pandas/plotting/_core.py # pandas/tests/plotting/frame/test_frame_color.py * Add whatsnew

Rename 'c' to 'color' and 's' to 'size'

2f54813

This changes use more intuitive names for 'color' and 'size' and use the same notation like in '_bar_or_line_doc'.

jreback requested changes Dec 12, 2021

View reviewed changes

mosc9575 changed the title ~~Rename 'c' to 'color' and 's' to 'size'~~ Add 'color' and 'size' to arguments Dec 12, 2021

attack68 reviewed Dec 12, 2021

View reviewed changes

jreback added API - Consistency Internal Consistency of API/Behavior Visualization plotting labels Dec 14, 2021

Rework after comments

3feaabc

remove whitespace

68f2551

MarcoGorelli requested changes Jan 17, 2022

View reviewed changes

pandas/plotting/_core.py Show resolved Hide resolved

Add Tests

390fc86

MarcoGorelli self-requested a review January 19, 2022 16:57

Moritz Schreiber added 5 commits January 21, 2022 11:26

Split test into two

865b7ac

t

1f30d45

Revert 't'

543c64e

This reverts commit 1f30d45

delete trailling whitespaces

d1fd7bc

delete default_colors

eda1fbc