Add ytick label right/left properties in matplotlibrc #10306

esvhd · 2018-01-23T22:05:19Z

PR Summary

Add y-axis tick label positions into matplotlibrc for issue #10267

New properties named as:
ytick.labelleft
ytick.labelright

Will also work on a PR for x-axis tick label top/bottom properties for matplotlibrc

jklymak · 2018-01-26T17:29:45Z

lib/matplotlib/axes/_base.py

            which='minor')

        self.tick_params(
            top=rcParams['xtick.top'] and rcParams['xtick.major.top'],
            bottom=rcParams['xtick.bottom'] and rcParams['xtick.major.bottom'],
            left=rcParams['ytick.left'] and rcParams['ytick.major.left'],
            right=rcParams['ytick.right'] and rcParams['ytick.major.right'],
+            labelleft=rcParams['ytick.labelleft'] and
+            rcParams['ytick.major.left'],


You should indent a 8 spaces or so here...

yep sounds good.

Actually when I indented like the below I got some PEP 8 complains. Was this what you meant?

Alternatively I can have this in a single line but it breaches 80 line margin.

labelleft=rcParams['ytick.labelleft'] and rcParams['ytick.major.left'],

Put the RHS in parentheses and then it should work with indenting...

jklymak · 2018-01-26T17:31:08Z

This at least needs a test. w/o looking at the rest of the code, I don't quite understand how this propagates to the axis drawing.

esvhd · 2018-01-26T21:39:10Z

Essentially I traced down how matplotlibrc was read and how the properties are then set in axes._base__init__(). So I made the change to pick up these two new properties. This did the trick.

All up for testing, any suggestion on how this should be tested? Any example tests you can point me to perhaps?

jklymak · 2018-01-26T21:44:26Z

Tests are in matplotlib/lib/tests. If possible it'd be great if you could set up a testing environment on your local machine before pushing. https://matplotlib.org/devel/testing.html

esvhd · 2018-01-27T09:45:26Z

Good idea.

…

Sent from my iPhone

On 26 Jan 2018, at 21:45, Jody Klymak ***@***.***> wrote: @jklymak commented on this pull request. In lib/matplotlib/axes/_base.py: > which='minor') self.tick_params( top=rcParams['xtick.top'] and rcParams['xtick.major.top'], bottom=rcParams['xtick.bottom'] and rcParams['xtick.major.bottom'], left=rcParams['ytick.left'] and rcParams['ytick.major.left'], right=rcParams['ytick.right'] and rcParams['ytick.major.right'], + labelleft=rcParams['ytick.labelleft'] and + rcParams['ytick.major.left'], Put the RHS in parentheses and then it should work with indenting... — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

…o issue_10267

esvhd · 2018-01-28T21:29:34Z

Added a test case test_axes.py::test_axes_tick_params_ylabelside(), similar to test_axes.py::test_axis_set_tick_params_labelsize_labelcolor(), let me know what you think.

I tested the test case manually in a notebook and all asserts worked. However, when I tried to run pytest I got the following error message:

pytest test_axes.py::test_axes_tick_params_ylabelside
INTERNALERROR> Traceback (most recent call last):
INTERNALERROR>   File "/usr/anaconda3/lib/python3.6/site-packages/_pytest/main.py", line 101, in wrap_session
INTERNALERROR>     config._do_configure()
INTERNALERROR>   File "/usr/anaconda3/lib/python3.6/site-packages/_pytest/config.py", line 921, in _do_configure
INTERNALERROR>     self.hook.pytest_configure.call_historic(kwargs=dict(config=self))
INTERNALERROR>   File "/usr/anaconda3/lib/python3.6/site-packages/pluggy/__init__.py", line 628, in call_historic
INTERNALERROR>     res = self._hookexec(self, self._nonwrappers + self._wrappers, kwargs)
INTERNALERROR>   File "/usr/anaconda3/lib/python3.6/site-packages/pluggy/__init__.py", line 222, in _hookexec
INTERNALERROR>     return self._inner_hookexec(hook, methods, kwargs)
INTERNALERROR>   File "/usr/anaconda3/lib/python3.6/site-packages/pluggy/__init__.py", line 216, in <lambda>
INTERNALERROR>     firstresult=hook.spec_opts.get('firstresult'),
INTERNALERROR>   File "/usr/anaconda3/lib/python3.6/site-packages/pluggy/callers.py", line 201, in _multicall
INTERNALERROR>     return outcome.get_result()
INTERNALERROR>   File "/usr/anaconda3/lib/python3.6/site-packages/pluggy/callers.py", line 76, in get_result
INTERNALERROR>     raise ex[1].with_traceback(ex[2])
INTERNALERROR>   File "/usr/anaconda3/lib/python3.6/site-packages/pluggy/callers.py", line 180, in _multicall
INTERNALERROR>     res = hook_impl.function(*args)
INTERNALERROR>   File "/home/esvhd/git/esvhd_matplotlib/lib/matplotlib/testing/conftest.py", line 12, in pytest_configure
INTERNALERROR>     matplotlib._init_tests()
INTERNALERROR>   File "/home/esvhd/git/esvhd_matplotlib/lib/matplotlib/__init__.py", line 1448, in _init_tests
INTERNALERROR>     from matplotlib import ft2font
INTERNALERROR> ImportError: cannot import name 'ft2font'

When I ran from matplotlib import ft2font in a python console it actually works fine... Couldn't find much useful info googling this error... Any suggests?

Thx

jklymak · 2018-01-28T21:37:32Z

Are you sure you are using the same environment in each case?

esvhd · 2018-01-28T22:05:45Z

Sorry not an expert in this clearly. Could you please clarify what you mean by same environment? Thx

…

On Sun, Jan 28, 2018 at 9:37 PM, Jody Klymak ***@***.***> wrote: Are you sure you are using the same environment in each case? — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#10306 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AG_aUd41pYaazH1w3EPMjqA_e85qXnkBks5tPOikgaJpZM4RqZFS> .

jklymak · 2018-01-28T22:14:16Z

If you are using conda environments, then fontconfig has to be installed in your test environment. If you aren't using environments you should 😉 https://conda.io/docs/user-guide/tasks/manage-environments.html

esvhd · 2018-01-28T22:30:17Z

I see, conda environments. Yes, the env that has this code change has `fontconfig`. I was being lazy so I hacked my installed `matplotlib` code with these changes and tested in my notebooks manually (including running the test code)..

…

On Sun, Jan 28, 2018 at 10:14 PM, Jody Klymak ***@***.***> wrote: If you are using conda environments, then fontconfig has to be installed in your test environment. If you aren't using environments you should 😉 https://conda.io/docs/user-guide/tasks/manage-environments.html — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#10306 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AG_aUVD2OkcAdYySv-cz7q68HDvYQoPVks5tPPFCgaJpZM4RqZFS> .

jklymak · 2018-01-29T17:02:41Z

OK, this is almost done. This could use a "whats-new" entry: see doc/users/next_whats_new

Ideally, you would also have an example for it, particulaly one that differentiates it from ax.yaxis.tick_right()... examples/ticks_and_spines I expect. I note that we don't have any examples with tick_right(), so if you could include that too, it'd be fabulous.

Thanks for all your work on this!

esvhd · 2018-01-29T21:55:16Z

Sounds good, let me look into these. Thx for the pointers.

…

On Mon, Jan 29, 2018 at 5:02 PM, Jody Klymak ***@***.***> wrote: OK, this is almost done. This could use a "whats-new" entry: see doc/users/next_whats_new Ideally, you would also have an example for it, particulaly one that differentiates it from ax.yaxis.tick_right()... examples/ticks_and_spines I expect. I note that we don't have any examples with tick_right(), so if you could include that too, it'd be fabulous. Thanks for all your work on this! — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub <#10306 (comment)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AG_aUYSj1vWQeXWzvK1Al8IrIp8iASfJks5tPfm-gaJpZM4RqZFS> .

…o issue_10267

esvhd · 2018-01-30T21:48:13Z

Added example to show how to set these new properties in rcParams as well as using tick_right() or tick_left(). Created entry for what's new as well. Let me know how this looks. Thanks.

jklymak · 2018-01-30T22:15:45Z

Hmmm. Is this how the example is supposed to look? I'd have expected the ticks and labels to be on the right for the last subplot (ax[2]).

https://5811-1385122-gh.circle-artifacts.com/0/home/circleci/project/doc/build/html/gallery/ticks_and_spines/tick_label_right.html#sphx-glr-gallery-ticks-and-spines-tick-label-right-py

afvincent · 2018-01-30T22:41:34Z

I think that the rcParams might be read at the figure instantiation, i.e. changing them afterwards like in the example will have no effect. (But I may be wrong.)

QuLogic · 2018-01-30T22:56:40Z

Not Figure, but Axes instantiation (though that's essentially the same time with subplots).

esvhd · 2018-01-30T23:01:12Z

Fixed the example. Needed to set rcParams before the plt.subplots() is created. Let me know how it looks.

jklymak · 2018-01-30T23:36:35Z

examples/ticks_and_spines/tick_label_right.py

+============================================
+
+Example to show how to change two new properties in rcParams to put yaxis tick
+lables on either left or right by default.


I think the text should not refer to "new" properties (unless you plan to edit this in a year). Also some formatting changes. (Note I didn't check the comment below for length).

Otherwise looks great!

""" We can use :rc:`ytick.labelright` (default False) and :rc:`ytick.right` (default False) and :rc:`ytick.labelleft` (default True) and :rc:`ytick.left` (default False) to control where on the axes ticks and their labels appear. These properties can also be set in the ``.matplotlib/matplotlibrc``. """

esvhd · 2018-01-31T07:48:00Z

Sure, will add these changes later today.

…

Sent from my iPhone

On 30 Jan 2018, at 23:37, Jody Klymak ***@***.***> wrote: @jklymak requested changes on this pull request. In examples/ticks_and_spines/tick_label_right.py: > @@ -0,0 +1,33 @@ +""" +============================================ +Set default y-axis tick labels on the right +============================================ + +Example to show how to change two new properties in rcParams to put yaxis tick +lables on either left or right by default. I think the text should not refer to "new" properties (unless you plan to edit this in a year). Also some formatting changes. (Note I didn't check the comment below for length). Otherwise looks great! """ We can use :rc:`ytick.labelright` (default False) and :rc:`ytick.right` (default False) and :rc:`ytick.labelleft` (default True) and :rc:`ytick.left` (default False) to control where on the axes ticks and their labels appear. These properties can also be set in the ``.matplotlib/matplotlibrc``. """ — You are receiving this because you authored the thread. Reply to this email directly, view it on GitHub, or mute the thread.

…o issue_10267

esvhd · 2018-01-31T21:25:37Z

Hope this looks good. Thanks guys!

afvincent · 2018-02-02T19:11:17Z

About the issue with having the x-ticks and x-tick labels at the top that do not play well with a possible title, I do not think that adding new rcParams is very different from the current situation when the x-ticks and their label are tuned through the proper Axes methods.

I guess that a quick workaround if some core devs are afraid of this issue might be to simply advertise that one can increase the title padding. A genuine first thought that comes to me is something like.

import matplotlib.pyplot as plt

# If a fixed title padding is good enough
#plt.rcParams["axes.titlepad"] = 36  # 24 without x-label

fig, axs = plt.subplots(ncols=2)
for ax, xlbl in zip(axs.flat, ("X-label", "")):
    ax.plot([0, 1])

    ax.set_title("A title")
    ax.set_xlabel(xlbl)
    ax.xaxis.tick_top()
    ax.xaxis.set_label_position('top')

# Dynamic title padding if one prefers
for ax in axs.flat:
    ax.set_title(ax.get_title(), pad=36 if len(ax.get_xlabel()) > 0 else 24)

fig.tight_layout()
plt.show()

jklymak · 2018-02-02T19:12:38Z

Or, you know, #9498 which will do this automatically.

afvincent · 2018-02-02T19:16:30Z

I knew that it felt like something that was discussed recently 🐑! Thanks @jklymak for x-referencing.

Edit: I would suggest assuming that #9498 will be merged one day, and thus not bother too much about the top tick labels and x-label overlapping with the title.

…o issue_10267

esvhd · 2018-02-03T21:35:21Z

Here we go. Added xtick.labeltop and xtick.labelbottom for matplotlibrc. Also added tests, examples and modified what's new.

Currently this quick solution does not take care of title position. I understood that this is being worked on separately as @jklymak suggested.

Let me know how this looks. Thanks everyone.

efiring · 2018-02-03T21:41:43Z

I have a concern about the git history; someone with more git knowledge can comment on whether something should be done about it, and if so, what.

Normally we do not merge master into feature branches. Instead, to keep them up to date, we rebase them on top of the master branch.

esvhd · 2018-02-03T21:47:06Z

Would be great if someone can shed some light on this, not a git pro here. Thx

jklymak · 2018-02-03T22:48:13Z

I think these are just merge commits and are OK. OTOH these commits would be better if they were rebased into one commit.

Oddly, given how much we ask people to squash things:

https://matplotlib.org/devdocs/devel/gitwash/development_workflow.html

doesn't describe the process, but this is what I do:

https://github.com/todotxt/todo.txt-android/wiki/Squash-All-Commits-Related-to-a-Single-Issue-into-a-Single-Commit

jklymak

Re-approve the new changes.

QuLogic · 2018-02-04T19:56:45Z

examples/ticks_and_spines/tick_label_right.py

+plt.rcParams['ytick.left'], plt.rcParams['ytick.labelleft'] = False, False
+
+
+x = np.array([x for x in range(10)])


np.arange(10)

QuLogic · 2018-02-04T19:56:55Z

examples/ticks_and_spines/tick_xlabel_top.py

+plt.rcParams['xtick.bottom'], plt.rcParams['xtick.labelbottom'] = False, False
+plt.rcParams['xtick.top'], plt.rcParams['xtick.labeltop'] = True, True
+
+x = np.array([x for x in range(10)])


np.arange(10)

QuLogic · 2018-02-04T19:57:46Z

examples/ticks_and_spines/tick_label_right.py

+import matplotlib.pyplot as plt
+import numpy as np
+
+plt.rcParams['ytick.right'], plt.rcParams['ytick.labelright'] = True, True


Chained assignment would be a bit simpler:

plt.rcParams['ytick.right'] = plt.rcParams['ytick.labelright'] = True

QuLogic · 2018-02-04T19:58:23Z

lib/matplotlib/tests/test_axes.py

+    ax.tick_params(labelleft=False, labelright=True,
+                   which='minor')
+    # expects left false, right true
+    assert(ax.yaxis.majorTicks[0].label1On is False)


Unnecessary parentheses.

…o issue_10267

QuLogic · 2018-02-04T21:03:36Z

examples/ticks_and_spines/tick_label_right.py



-x = np.array([x for x in range(10)])
+x = np.array([x for x in np.range(10)])


No, I mean you can replace the entire line with np.arange(10).

esvhd · 2018-02-04T21:06:17Z

Added suggested changes from @QuLogic

esvhd · 2018-02-04T21:08:10Z

good idea. let me do that.

…

On Sun, Feb 4, 2018 at 9:03 PM, Elliott Sales de Andrade < ***@***.***> wrote: ***@***.**** commented on this pull request. ------------------------------ In examples/ticks_and_spines/tick_label_right.py <#10306 (comment)> : > -x = np.array([x for x in range(10)]) +x = np.array([x for x in np.range(10)]) No, I mean you can replace the entire line with np.arange(10). — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub <#10306 (review)>, or mute the thread <https://github.com/notifications/unsubscribe-auth/AG_aUTt6HtkuzMQ3tI1xkBVs1nB3M4l4ks5tRhsxgaJpZM4RqZFS> .

esvhd · 2018-02-07T23:06:06Z

Hi guys, checking in on this, is there any more work need on this PR, particularly from my side?
Thx

jklymak · 2018-02-07T23:27:08Z

Excellent. Thanks so much @esvhd! Great contribution....

OOification of the new examples from #10306

esvhd · 2018-02-08T07:44:16Z

Great, thank you everyone. Glad to help!

…

Sent from my iPhone

On 7 Feb 2018, at 23:27, Jody Klymak ***@***.***> wrote: Excellent. Thanks so much @esvhd! Great contribution.... — You are receiving this because you were mentioned. Reply to this email directly, view it on GitHub, or mute the thread.

Add ytick label right/left properties in matplotlibrc. issue #10267

6fe05fb

jklymak reviewed Jan 26, 2018

View reviewed changes

jklymak changed the title ~~Add ytick label right/left properties in matplotlibrc. issue #10267~~ Add ytick label right/left properties in matplotlibrc Jan 26, 2018

esvhd added 3 commits January 28, 2018 20:30

reformat code

3a7cebf

Merge branch 'master' of https://github.com/matplotlib/matplotlib int…

8013fe7

…o issue_10267

added test for issue #10267, yaxis tick label left/right

f30e583

esvhd added 2 commits January 30, 2018 21:07

Merge branch 'master' of https://github.com/matplotlib/matplotlib int…

c0712ca

…o issue_10267

Added example and whatsnew for issue 10267 yaxis tick label side.

c09536b

fix tick label right example

b5d3a11

jklymak requested changes Jan 30, 2018

View reviewed changes

esvhd added 2 commits January 31, 2018 21:22

Merge branch 'master' of https://github.com/matplotlib/matplotlib int…

a98cabc

…o issue_10267

tick_label_right example comment changes.

600d761

esvhd added 3 commits February 3, 2018 20:50

Merge branch 'master' of https://github.com/matplotlib/matplotlib int…

6bdef9f

…o issue_10267

Added xtick.labeltop and xtick.labelbottom for matplotlibrc

82ef9cf

Added xtick.labeltop/labelbottom in whatsnew

d805368

jklymak approved these changes Feb 3, 2018

View reviewed changes

QuLogic reviewed Feb 4, 2018

View reviewed changes

esvhd added 2 commits February 4, 2018 20:58

Merge branch 'master' of https://github.com/matplotlib/matplotlib int…

a7d17f7

…o issue_10267

test and example minor code changes.

d7fcb5e

QuLogic reviewed Feb 4, 2018

View reviewed changes

example minor code change.

d1efa25

replace with np.arange()

145b409

timhoffm merged commit 0ec4633 into matplotlib:master Feb 7, 2018

This was referenced Feb 7, 2018

matplotlibrc: new entry for placing y-axis tick label on Right or Left hand side. #10267

Closed

Missing keys in matplotlibrc.template to move x-axis labels to top #10343

Closed

afvincent mentioned this pull request Feb 8, 2018

OOification of the new examples from #10306 #10393

Merged

2 tasks

QuLogic added a commit that referenced this pull request Feb 8, 2018

Merge pull request #10393 from afvincent/ooify_examples_from_10306

84008ea

OOification of the new examples from #10306

QuLogic modified the milestones: needs sorting, v2.2.0 Feb 12, 2018

ImportanceOfBeingErnest mentioned this pull request Mar 25, 2018

Update legend to automatically grow with marker_size #10765

Closed

2 tasks

		plt.rcParams['ytick.left'], plt.rcParams['ytick.labelleft'] = False, False


		x = np.array([x for x in range(10)])



		x = np.array([x for x in range(10)])
		x = np.array([x for x in np.range(10)])

Add ytick label right/left properties in matplotlibrc #10306

Add ytick label right/left properties in matplotlibrc #10306

Conversation

esvhd commented Jan 23, 2018 • edited Loading

PR Summary

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

jklymak commented Jan 26, 2018

esvhd commented Jan 26, 2018

jklymak commented Jan 26, 2018

esvhd commented Jan 27, 2018 via email

esvhd commented Jan 28, 2018 • edited Loading

jklymak commented Jan 28, 2018

esvhd commented Jan 28, 2018 via email

jklymak commented Jan 28, 2018

esvhd commented Jan 28, 2018 via email

jklymak commented Jan 29, 2018

esvhd commented Jan 29, 2018 via email

esvhd commented Jan 30, 2018

jklymak commented Jan 30, 2018

afvincent commented Jan 30, 2018 • edited Loading

QuLogic commented Jan 30, 2018

esvhd commented Jan 30, 2018 • edited Loading

Choose a reason for hiding this comment

esvhd commented Jan 31, 2018 via email

esvhd commented Jan 31, 2018

afvincent commented Feb 2, 2018

jklymak commented Feb 2, 2018

afvincent commented Feb 2, 2018 • edited Loading

esvhd commented Feb 3, 2018

efiring commented Feb 3, 2018

esvhd commented Feb 3, 2018

jklymak commented Feb 3, 2018

jklymak left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

esvhd commented Feb 4, 2018

esvhd commented Feb 4, 2018 via email

esvhd commented Feb 7, 2018

jklymak commented Feb 7, 2018

esvhd commented Feb 8, 2018 via email

esvhd commented Jan 23, 2018 •

edited

Loading

esvhd commented Jan 28, 2018 •

edited

Loading

afvincent commented Jan 30, 2018 •

edited

Loading

esvhd commented Jan 30, 2018 •

edited

Loading

afvincent commented Feb 2, 2018 •

edited

Loading