add which kwarg to autofmt_xdate #8157

patniharshit · 2017-02-26T14:29:12Z

refs #8128
Review required.
Also help needed in writing the test. Firstly I am not sure where to write the test, because a quick search in test_figure.py did not return any tests related to autofmt_xdate.

tacaswell · 2017-02-26T17:35:13Z

lib/matplotlib/figure.py

            The horizontal alignment of the xticklabels
+
+        which : {None, 'major', 'minor', 'both'}
+            Selects which ticklabels to return


'which ticks to rotate'?

What 'which' is referring to is not clear or is this a suggestion to change 'return' to 'rotate'?

Tom meant that you should change "Selects which ticklabels to return" to "Selects which ticklabels to rotate"

tacaswell · 2017-02-26T17:57:04Z

If there are no tests, then you are in luck as you get to meaningfully increase our test coverage!

It is a figure method so putting it in test_figure would make sense, but it is also date-specific so putting in test_dates would also make sense. I lean slightly towards the second, but does not matter that much.

patniharshit · 2017-02-26T19:19:22Z

No tests found in test_dates as well.

NelleV · 2017-03-06T20:50:19Z

I agree with @tacaswell that a test is needed for this new feature.

tacaswell · 2017-03-10T21:25:45Z

lib/matplotlib/tests/test_figure.py

+        minors = [1,2,3,4,5,6,7]
+
+        x = mdates.datestr2num(date)
+	y = mdates.datestr2num(time)


It looks like you have a mix of tabs and spaces, can you please make them all spaces (many editors have tools to help with this, and a minimum find and replace `\t' -> ' '.

tacaswell · 2017-03-10T21:27:19Z

Can you also drop a file in https://github.com/matplotlib/matplotlib/tree/master/doc/users/whats_new so that this gets properly advertised?

tacaswell · 2017-03-10T21:30:49Z

lib/matplotlib/figure.py

        """
        allsubplots = all(hasattr(ax, 'is_last_row') for ax in self.axes)
        if len(self.axes) == 1:
-            for label in self.axes[0].get_xticklabels():
+            for label in self.axes[0].get_xticklabels(False, which):


You can also pass this in as get_xticklabels(which=which) which is less cryptic than the leading False.

Which we support both minor and which is an interesting question...which the answer to is it is my fault: 08d961a 😞 .

patniharshit · 2017-03-17T05:40:49Z

whats the problem here? PEP8?

phobson · 2017-03-17T15:48:44Z

@patniharshit yeah you've got a number of PEP8 violations.
https://travis-ci.org/matplotlib/matplotlib/jobs/210002135#L1691

test added, tabs replaced by spaces.

patniharshit · 2017-03-18T13:59:19Z

"AppVeyor build failed" what does this mean? BTW while fixing for PEP8 violations in my code I noticed several other files also have these violations.

phobson · 2017-03-20T20:23:48Z

@patniharshit Travis CI tests the code on a linux operating system. AppVeyor tests the code on Windows. However, AppVeyor (the system) is generally broken for us right now, so we're not too concerned that the build failed.

phobson

If you have the availability and desire, I'd recommend two things:

squashing these commits in a single commit
parametrizing your test

However, those are minor comments and I don't think they should hold up this PR.

patniharshit · 2017-03-21T06:54:24Z

What do you mean by parameterizing the tests?

phobson · 2017-03-21T16:00:14Z

@patniharshit

In this case, I would take away the for loop and pass those values into the test function itself. This has the advantage of testing every value of which independently. That means, for example, that if None fails for some reason, the other values still get tested. In your case, that means your test would become:

@pytest.mark.parametrize('which', [None, 'both', 'major', 'minor'])
def test_autofmt_xdate(which):
     date = ['3 Jan 2013', '4 Jan 2013', '5 Ja....
     ...

phobson · 2017-03-21T17:53:05Z

lib/matplotlib/tests/test_figure.py

@@ -234,3 +237,38 @@ def test_figaspect():
    assert h / w == 0.5
    w, h = plt.figaspect(np.zeros((2, 2)))
    assert h / w == 1
+
+@pytest.mark.parametrize('which', [None, 'both', 'major', 'minor'])


pep8 will want another blank line here

patniharshit · 2017-03-28T09:29:17Z

Can someone help me here? All tests are passing locally.
Why Travis is failing? I can't open its job log.

phobson · 2017-03-28T14:52:36Z

Travis failure looks like it's just a flaky test unrelated to your PR. Looks like the Appveyor build is old enough that it was suffering from systematic failures.

tacaswell · 2017-04-04T04:44:09Z

doc/users/whats_new/autofmt_xdate.rst

@@ -0,0 +1 @@
+The autofmt_xdate of the figure.Figure class previously formatted only major tick labels but now formats both minor and major tick labels by passing the argument "which = {None, 'minor', 'major', 'both'}".


Can you please use the template in README.rst? That makes in very easy to combine each of these files when it comes time for a release.

Didn't notice there was a template. Updated now.

I think this file needs to be deleted now, as the next one covers it?

Yup, forgot to delete that. Deleted now.

tacaswell · 2017-04-04T04:44:40Z

👍 except for the change to the docs.

QuLogic

LGTM implementation-wise; test could be tweaked a bit.

QuLogic · 2017-04-11T23:05:29Z

lib/matplotlib/tests/test_figure.py

+@pytest.mark.parametrize('which', [None, 'both', 'major', 'minor'])
+def test_autofmt_xdate(which):
+    date = ['3 Jan 2013', '4 Jan 2013', '5 Jan 2013', '6 Jan 2013',
+    '7 Jan 2013', '8 Jan 2013', '9 Jan 2013', '10 Jan 2013', '11 Jan 2013',


Align with the opening bracket.

QuLogic · 2017-04-11T23:05:35Z

lib/matplotlib/tests/test_figure.py

+    '12 Jan 2013', '13 Jan 2013', '14 Jan 2013']
+
+    time = ['16:44:00', '16:45:00', '16:46:00', '16:47:00', '16:48:00',
+    '16:49:00', '16:51:00', '16:52:00', '16:53:00', '16:55:00', '16:56:00',


QuLogic · 2017-04-11T23:06:15Z

lib/matplotlib/tests/test_figure.py

+
+    fig.autofmt_xdate(0.2, angle, 'right', which)
+
+    if((which == 'both') or (which == 'major') or (which is None)):


if which in ('both', 'major', None):

QuLogic · 2017-04-11T23:06:26Z

lib/matplotlib/tests/test_figure.py

+        for label in fig.axes[0].get_xticklabels(False, 'major'):
+            assert (int(label.get_rotation()) == angle)
+
+    if(which == 'both' or which == 'minor'):


if which in ('both', 'minor'):

QuLogic · 2017-04-11T23:06:43Z

lib/matplotlib/tests/test_figure.py

+
+    if((which == 'both') or (which == 'major') or (which is None)):
+        for label in fig.axes[0].get_xticklabels(False, 'major'):
+            assert (int(label.get_rotation()) == angle)


Unnecessary parentheses.

QuLogic · 2017-04-11T23:06:46Z

lib/matplotlib/tests/test_figure.py

+
+    if(which == 'both' or which == 'minor'):
+        for label in fig.axes[0].get_xticklabels(True, 'minor'):
+            assert (int(label.get_rotation()) == angle)


Unnecessary parentheses.

QuLogic · 2017-04-11T23:06:58Z

lib/matplotlib/figure.py

@@ -1838,7 +1844,6 @@ def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,

        Right clicking cancels last input.

-        The buttons used for the various actions (adding points, removing


Why is this removed?

Thanks for pointing that out, it was probably a mistake on my part.

QuLogic · 2017-04-11T23:07:36Z

lib/matplotlib/figure.py

            The horizontal alignment of the xticklabels
+
+        which : {None, 'major', 'minor', 'both'}
+            Selects which ticklabels to rotate


This should indicate what the default (None) means; both, neither?

… of default value of which

QuLogic

Dunno if you want to squash, but LGTM.

Missed the earlier discussion about where to put the test and the curious fact that this is a figure method, not an axes method...

phobson · 2017-04-13T16:29:56Z

@patniharshit thanks for sticking with us! I fixed a minor pep8 thing. I'll wait for the CI to wrap up on that commit and then I'll merge.

phobson · 2017-04-13T20:12:04Z

@patniharshit thanks again -- merged!

tacaswell reviewed Feb 26, 2017

View reviewed changes

tacaswell added this to the 2.1 (next point release) milestone Feb 26, 2017

tacaswell previously requested changes Mar 10, 2017

View reviewed changes

tacaswell reviewed Mar 10, 2017

View reviewed changes

QuLogic mentioned this pull request Mar 11, 2017

create autofmt_xdate #8267

Closed

phobson approved these changes Mar 20, 2017

View reviewed changes

patniharshit force-pushed the autofmtXdate branch from ab695ed to 28d0f00 Compare March 21, 2017 16:41

phobson requested changes Mar 21, 2017

View reviewed changes

add which kwarg to autofmt_xdate

0bfb832

patniharshit force-pushed the autofmtXdate branch from 28d0f00 to 0bfb832 Compare March 21, 2017 17:59

tacaswell reviewed Apr 4, 2017

View reviewed changes

Use template in whats new

f2e4094

QuLogic reviewed Apr 11, 2017

View reviewed changes

patniharshit added 2 commits April 12, 2017 13:18

Clean up test, add deleted line in figure.py and explain the function…

c51086e

… of default value of which

Remove autofmt_xdate.rst because update_autofmt_xdate.rst exists

74cc512

QuLogic approved these changes Apr 12, 2017

View reviewed changes

phobson approved these changes Apr 13, 2017

View reviewed changes

STY: Minor PEP8 fix to autofmt_xdate test

13028f5

phobson merged commit 656edfb into matplotlib:master Apr 13, 2017

patniharshit deleted the autofmtXdate branch April 14, 2017 04:47

This was referenced Apr 15, 2017

Implemented Ticklabel selection when formatting - #8128 #8200

Closed

figure.Figure.autofmt_xdate applied to major xtick labels only #8128

Closed

		@@ -0,0 +1 @@
		The autofmt_xdate of the figure.Figure class previously formatted only major tick labels but now formats both minor and major tick labels by passing the argument "which = {None, 'minor', 'major', 'both'}".


		fig.autofmt_xdate(0.2, angle, 'right', which)

		if((which == 'both') or (which == 'major') or (which is None)):

		@@ -1838,7 +1844,6 @@ def ginput(self, n=1, timeout=30, show_clicks=True, mouse_add=1,

		Right clicking cancels last input.

		The buttons used for the various actions (adding points, removing

Uh oh!

add which kwarg to autofmt_xdate #8157

add which kwarg to autofmt_xdate #8157

Uh oh!

Conversation

patniharshit commented Feb 26, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

patniharshit Feb 26, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

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!

tacaswell commented Feb 26, 2017

Uh oh!

patniharshit commented Feb 26, 2017

Uh oh!

NelleV commented Mar 6, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

tacaswell commented Mar 10, 2017

Uh oh!

Choose a reason for hiding this comment

Uh oh!

patniharshit commented Mar 17, 2017

Uh oh!

phobson commented Mar 17, 2017

Uh oh!

patniharshit commented Mar 18, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

phobson commented Mar 20, 2017

Uh oh!

phobson left a comment

Choose a reason for hiding this comment

Uh oh!

patniharshit commented Mar 21, 2017

Uh oh!

phobson commented Mar 21, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

Choose a reason for hiding this comment

Uh oh!

patniharshit commented Mar 28, 2017 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Uh oh!

phobson commented Mar 28, 2017

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!

tacaswell commented Apr 4, 2017

Uh oh!

QuLogic 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!

patniharshit Feb 26, 2017 •

edited

Loading

patniharshit commented Mar 18, 2017 •

edited

Loading

phobson commented Mar 21, 2017 •

edited

Loading

patniharshit commented Mar 28, 2017 •

edited

Loading