[Numpy-discussion] PEP8

[Cera, Tim]

I made a PR request about supplying a git hooks framework at
https://github.com/numpy/numpy/pull/200.  I asked for it to be closed
because I couldn't easily figure our how to handle x-platform issues.
If you have an answer, what I was working on might be a start.  But
your script is an example of the x-platform challenges since it will
only run on Windows that has a Linux environment installed (Mingw or
the like).

What I have started to use in my projects is 'tox', 'coverage', and
'flake8'.  Really nice stuff.  There is an issue though with the
'flake8' report.  There are only very localized places in a few files
that I want to ignore some portion or other of PEP8, so I don' t
insist that 'flake8' pass, I just ignore the output where I need to
ignore it.  Usually what I want to ignore is the spaces around
brackets and commas in order to line up array values as mentioned in
an earlier post within this thread.  Here is an example of my project
setup based in part on 'cookiecutter' -
https://bitbucket.org/timcera/astronomia/src.  Yes, I use bitbucket -
so sue me.  Magic happens inside the 'tox.ini' file.

I suspect that for numpy, making something like 'flake8' part of the
tests would work better than 'autopep8'.  'autopep8' can be configured
to just report with the --list-fixes option, which would give people a
little more confidence to use it rather that it's primary mission as
an editor.  Another plug for 'flake8'; it can be configured on a file
by file basis to ignore particular errors or warnings, and exits with
an error status if the file doesn't pass.

I do think the idea has merit, but this entire process would be a lot
of work and I am not stepping forward to do it.  At this point I
simply have to say that I am a 'balcony muppet'.  Much thanks to Josef
for the reminder about where I learned my curmudgeony ways.  Those
guys made the show!

Kindest regards,
Tim

On Mon, Sep 9, 2013 at 12:08 PM, Blake Griffith
<blake.a.griffith at gmail.com> wrote:
> I think a good solution would to use add a git_hooks directory with a
> pre-commit git hook along with an git hook installation script. And a note
> should be added to DEV_README.txt suggesting installing the git hooks for
> pep8 compatibility. I personally use this as a pre-commit
>
> #!/bin/sh
>
> FILES=$(git diff --cached --name-status | grep -v ^D | awk '$1 $2 { print
> $2}' | grep -e .py$)
> if [ -n "$FILES" ]; then
> pep8 -r $FILES
> fi
>
> which is from here: https://gist.github.com/lentil/810399#comment-303703
>
>
> On Mon, Sep 9, 2013 at 10:54 AM, Nathaniel Smith <njs at pobox.com> wrote:
>>
>> On Mon, Sep 9, 2013 at 3:29 PM, Charles R Harris
>> <charlesr.harris at gmail.com> wrote:
>> >
>> >
>> >
>> > On Mon, Sep 9, 2013 at 8:12 AM, Richard Hattersley
>> > <rhattersley at gmail.com>
>> > wrote:
>> >>
>> >> > Something we have done in matplotlib is that we have made PEP8 a part
>> >> > of
>> >> > the tests.
>> >>
>> >> In Iris and Cartopy we've also done this and it works well. While we
>> >> transition we have an exclusion list (which is gradually getting
>> >> shorter).
>> >> We've had mixed experiences with automatic reformatting, so prefer to
>> >> keep
>> >> the human in the loop.
>> >>
>> >
>> > I agree with keeping a human in the loop, the script would be intended
>> > to
>> > get things into the right neighborhood, the submitter would have to
>> > review
>> > the changes after. If the script isn't too strict there will be than one
>> > way
>> > to do some things and those bits would rely on the good taste of the
>> > coder.
>>
>> So if I understand right, the goal is to have some script that
>> developers can run before (or after) submitting a PR, like
>>   tools/autopep8-my-changes numpy/
>> that will fix up their changes, but leave the rest of numpy alone?
>>
>> And the proposed mechanism is to come up with a combination of changes
>> to the numpy source and an autopep8 configuration such that
>>   autopep8 --our-config numpy/
>> becomes a no-op, and then we can use this as an implementation of
>> tools/autopep8-my-changes?
>>
>> If that's right then my feeling is that the goal seems worthwhile but
>> the approach seems difficult and unlikely to survive for long. As soon
>> as someone overrides autopep8 once, we either have to disable the rule
>> for the whole project or keep overriding it manually forever. You're
>> already suggesting taking out the spaces-around-arithmetic rule, which
>> strikes me as one of the most useful -- sure, it gets things wrongs
>> sometimes, but I feel like we're constantly reviewing PRs where
>> all*the*(arithmetic+is)-written**like*this.
>>
>> Maybe a better approach would be to spend that time hacking up some
>> script that uses git and autopep8 together to run autopep8 over all
>> and only those lines which the current branch has actually touched?
>> It's pretty easy to parse 'git diff' output to get a list of all line
>> numbers which have been modified, and then we could run autopep8 over
>> the modified files and pull out only those changes which touch those
>> lines.
>>
>> -n
>>
>> P.S.: definitely [:, :, 2]
>> _______________________________________________
>> NumPy-Discussion mailing list
>> NumPy-Discussion at scipy.org
>> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>
>
>
> _______________________________________________
> NumPy-Discussion mailing list
> NumPy-Discussion at scipy.org
> http://mail.scipy.org/mailman/listinfo/numpy-discussion
>