ENH: Implement xlabel and ylabel options in Series.plot and DataFrame.plot #34223

charlesdong1991 · 2020-05-17T11:42:08Z

closes [Feature Request] Add concise xlabel=, ylabel=, option in plot() method #9093
tests added / passed
passes black pandas
passes git diff upstream/master -u -- "*.py" | flake8 --diff
whatsnew entry

pep8speaks · 2020-05-17T11:42:14Z

Hello @charlesdong1991! 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 2020-06-25 15:57:49 UTC

MarcoGorelli · 2020-05-25T11:52:29Z

pandas/plotting/_matplotlib/core.py

+        xlabel: Optional[str] = None,
+        ylabel: Optional[str] = None,


Does this have to be string? Should work with e.g. int / float

Anyway, I tried running this and it looks good! Nice tests

yeah, I think it should be string? this is not calling any column of dataframe, but explicitly defined by users who want to give labels for x/y axis. I am not very sure about if users would name it using int/float, quite rare case though

I will later check to see if matplotlib allows to do so or not, if so, maybe we could support too! thanks!

I tried running it passing an int, and it worked fine - but yeah, typical case would be to label with a str, so it's fine as is, sorry for the noise :)

I will change to Label then and add a test case, so that we also support numbers!

Thanks for the feedback!

charlesdong1991 · 2020-05-25T18:42:37Z

maybe @WillAyd @jreback for a look?

WillAyd

Looks generally good. Possible improvement on test, maybe unnecessary change for annotation but otherwise lgtm

WillAyd · 2020-05-27T04:30:51Z

pandas/tests/plotting/test_frame.py

+    @pytest.mark.parametrize(
+        "index_name, old_xlabel, new_xlabel, old_ylabel, new_ylabel",
+        [
+            (None, "", "new_x", "", ""),


Not a huge issue but instead of parametrizing xlabel / ylabel as individual arguments can you not just pass one set of labels and maybe have another parametrization on transpose to test the other axis? Would probably help readability

you are right, actually we can also remove the need of transpose, and simply use old_label and new_label instead. As commented in the PR, for default, ylabel should always be empty string, while xlabel be the index name. And if assigned, they will be overriden by assigned value.

Pls let me know your thoughts on the simplified tests! thanks! @WillAyd

WillAyd · 2020-05-27T04:31:19Z

pandas/plotting/_matplotlib/core.py

        self.legend = legend
-        self.legend_handles = []
-        self.legend_labels = []
+        self.legend_handles: List = []


What error does this solve?

this solves mypy complaint, exactly the same as in #28373

charlesdong1991 · 2020-06-14T16:13:23Z

@WillAyd thanks for reviews, and changes are made accordingly

cc @jreback

WillAyd

lgtm @jreback

charlesdong1991 · 2020-06-20T14:30:12Z

some further reviews are very appreciated! @jreback

jreback

code and tests look good, can you update the visualization.rst to add this in (and potentially update one or more existing examples).

charlesdong1991 · 2020-06-21T07:05:00Z

thanks for the review, @jreback , done! updated in visualization.rst and with an existing df used there as example.

jreback

lgtm. @datapythonista @TomAugspurger if any comments.

datapythonista

Nice PR @charlesdong1991, lgtm. Just couple of small things, but looks good.

datapythonista · 2020-06-25T09:46:18Z

pandas/plotting/_matplotlib/core.py

+            # GH9093, currently Pandas does not show ylabel, so if users provide
+            # ylabel will set it as ylabel in the plot.
+            if self.ylabel is not None:
+                ax.set_ylabel(self.ylabel)


Is this consistent with xlabel, which seems to pprint the value?

May be I'm wrong, but feels like df.plot(xlabel=a_complex_structure) will make a_complex_structure (may be a dict of lists) look "nice". While df.plot(ylabel=a_complex_structure) may fail, or just convert to string with str instead of pprint_thing.

Would be probably good to add a test in the parametrization to make sure this works as expected.

good call! i think matplotlib's ax.set_ylabel already could make the complex structure case look nice by converting to string automatically without using pprint_thing, e.g. inputs like [1, 2, 3] will be shown as '[1, 2, 3]' same in matplotlib plot.

But i think it might be indeed nicer to be consistent with xlabel so I added pprint_thing for ylabel as well, and add the test case in parametrization! thanks!

datapythonista · 2020-06-25T09:48:20Z

pandas/plotting/_core.py

        Set the x limits of the current axes.
    ylim : 2-tuple/list
        Set the y limits of the current axes.
+    xlabel : label, default None


Suggested change

xlabel : label, default None

xlabel : label, optional

We usually use default None when the None is being used (imagine you have something like fill_with=None). When None means that the value is simply not provided, and the parameter won't be use, we use optional. A bit complex, but we've been somehow consistent with that.

yep, thats fair! changed

datapythonista · 2020-06-25T09:48:31Z

pandas/plotting/_core.py

+
+        .. versionadded:: 1.1.0
+
+    ylabel : label, default None


Suggested change

ylabel : label, default None

ylabel : label, optional

datapythonista · 2020-06-25T09:49:03Z

doc/source/user_guide/visualization.rst

+.. versionadded:: 1.1.0
+
+You may set the ``xlabel`` and ``ylabel`` arguments to give the plot custom labels
+for x and y axis. By default, Pandas will pick up index name as xlabel, while leaving


Suggested change

for x and y axis. By default, Pandas will pick up index name as xlabel, while leaving

for x and y axis. By default, pandas will pick up index name as xlabel, while leaving

We use pandas in lowercase.

charlesdong1991 · 2020-06-25T19:38:12Z

done. any further feedbacks are welcome!

cc @jreback @WillAyd @datapythonista

jreback · 2020-06-25T22:45:43Z

@datapythonista pls merge if good

datapythonista · 2020-06-26T00:37:20Z

Thanks @charlesdong1991, nice PR.

….plot (pandas-dev#34223)

charlesdong1991 added 10 commits December 3, 2018 17:43

remove \n from docstring

7e461a1

fix conflicts

1314059

Merge remote-tracking branch 'upstream/master'

8bcb313

Merge remote-tracking branch 'upstream/master'

24c3ede

fix issue 17038

dea38f2

revert change

cd9e7ac

revert change

e5e912b

Merge remote-tracking branch 'upstream/master'

045a76f

Merge remote-tracking branch 'upstream/master' into fix_issue_9093

e69c080

allow xlabel ylabel

bc7bad4

charlesdong1991 added 4 commits May 17, 2020 17:41

fixup

4ae4f17

add more tests and fix docs

0d32836

annotation

4d7216b

add whatsnew

cc1b6d6

charlesdong1991 changed the title ~~ENH: Add xlabel, ylabel options in plot~~ ENH: Implement xlabel and ylabel options in Series.plot and DataFrame.plot May 17, 2020

charlesdong1991 added Enhancement Visualization plotting labels May 17, 2020

charlesdong1991 added 3 commits May 17, 2020 18:34

linting

dbf8f1a

fix annotation

3fb1faa

fix conflict

f8ad37a

charlesdong1991 requested review from WillAyd and jreback and removed request for jreback May 20, 2020 17:29

MarcoGorelli reviewed May 25, 2020

View reviewed changes

allow number as labels

3f34099

WillAyd reviewed May 27, 2020

View reviewed changes

Merge remote-tracking branch 'upstream/master' into fix_issue_9093

4246f6e

charlesdong1991 added 2 commits June 14, 2020 14:40

fix linting

8a24a40

Merge remote-tracking branch 'upstream/master' into fix_issue_9093

6bb571a

charlesdong1991 requested a review from WillAyd June 14, 2020 16:13

Merge remote-tracking branch 'upstream/master' into fix_issue_9093

66cf42f

WillAyd approved these changes Jun 17, 2020

View reviewed changes

charlesdong1991 requested review from jreback and removed request for jreback June 20, 2020 09:00

jreback added this to the 1.1 milestone Jun 20, 2020

jreback requested changes Jun 20, 2020

View reviewed changes

charlesdong1991 added 6 commits June 20, 2020 18:25

Merge remote-tracking branch 'upstream/master' into fix_issue_9093

7e2a7c9

add user guide

31c8ccf

fix test

9d1d942

use current df

5335de8

Merge remote-tracking branch 'upstream/master' into fix_issue_9093

2a8406d

fix typo

8f12150

charlesdong1991 requested a review from jreback June 24, 2020 06:10

jreback approved these changes Jun 24, 2020

View reviewed changes

datapythonista approved these changes Jun 25, 2020

View reviewed changes

charlesdong1991 added 2 commits June 25, 2020 17:57

code change on reviews

e1ade53

Merge remote-tracking branch 'upstream/master' into fix_issue_9093

26bfa6e

datapythonista merged commit 998e2ab into pandas-dev:master Jun 26, 2020

fangchenli pushed a commit to fangchenli/pandas that referenced this pull request Jun 27, 2020

ENH: Implement xlabel and ylabel options in Series.plot and DataFrame…

3deb437

….plot (pandas-dev#34223)

treuherz mentioned this pull request Oct 9, 2020

VIS: Allow xlabel and ylabel in DataFrame.plot.scatter plot and hexbin plot #37001

Closed

3 tasks

abeltavares mentioned this pull request Apr 20, 2024

BUG: Series.plot(kind="pie") does not respect ylabel argument #58254

Merged

5 tasks

	for x and y axis. By default, Pandas will pick up index name as xlabel, while leaving
	for x and y axis. By default, pandas will pick up index name as xlabel, while leaving

Uh oh!

ENH: Implement xlabel and ylabel options in Series.plot and DataFrame.plot #34223

ENH: Implement xlabel and ylabel options in Series.plot and DataFrame.plot #34223

Uh oh!

Conversation

charlesdong1991 commented May 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

pep8speaks commented May 17, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Comment last updated at 2020-06-25 15:57:49 UTC

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

charlesdong1991 commented May 25, 2020

Uh oh!

WillAyd left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

charlesdong1991 commented Jun 14, 2020

Uh oh!

WillAyd left a comment

Choose a reason for hiding this comment

Uh oh!

charlesdong1991 commented Jun 20, 2020

Uh oh!

jreback left a comment

Choose a reason for hiding this comment

Uh oh!

charlesdong1991 commented Jun 21, 2020 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

jreback left a comment

Choose a reason for hiding this comment

Uh oh!

datapythonista left a comment

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

Choose a reason for hiding this comment

Uh oh!

charlesdong1991 commented Jun 25, 2020

Uh oh!

jreback commented Jun 25, 2020

Uh oh!

datapythonista commented Jun 26, 2020

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

6 participants

charlesdong1991 commented May 17, 2020 •

edited

Loading

pep8speaks commented May 17, 2020 •

edited

Loading

charlesdong1991 commented Jun 21, 2020 •

edited

Loading