Programmatic python source formatter

Question

I have a large body of python code that needs to have a pep8-compliant style/format imposed on it. There are variants of pep8 that various rules (like this one by a coworker), but the hardest thing is to deal with splitting too long lines and formatting the modified code.

I've looked up the questions on this:

python-formatter-tool
python-source-formatter-pretty-printer

They are from 2009 and 2010. I am hoping that better tools have been developed since then.

I know about PythonTidy which is pretty good but makes lots of code worse, IMHO. Pylint detects formatting errors but does not correct them. Web services are not really relevant to my requirements because I want a tool that can be part of a build.

Does anyone have a recommendation that has not already been covered? Thanks.

As for the vote-to-close, it would be helpful to know why the two previous questions on python formatting tools have no close votes but this attempt does. — hughdbrown, Feb 11 '12 at 18:30

score 7 · Answer 1 · answered Feb 14 '12 at 09:10

7

Another one that looks pretty decent: autopep8

But note that blindly following all the conventions in PEP8 isn't really in the spirit of PEP8. From PEP8 itself:

But most importantly: know when to be inconsistent -- sometimes the style guide just doesn't apply.

answered Feb 14 '12 at 09:10

Mu Mind

10,935
4
38
69

I should have commented earlier that I have something that deals with some pep8 errors but nothing that intelligently handles lines that are too long, leading me to believe that a more general solution, a code formatter, is required. – hughdbrown Feb 14 '12 at 12:37

score 3 · Answer 2 · answered Aug 24 '18 at 20:20

black is another contender. It's selling point is that is is barely configurable, so your team wastes less time quibbling about details.

There's an online demo here: black.now.sh

Side-note: black, yapf, and autopep8 have python language server plugins, so they integrate nicely with text editors including atom and vscode.

score 2 · Answer 3 · answered Jul 24 '14 at 04:30

PyCharm has this functionality built in and now has a free, open source community edition. Open your file up in it and hit CtrlAltL.

Unifortunately, it will not also automatically refactor function names and variable names to PEP8 convention... those will have to be done one by one with PyCharm's rename functionality.

score 2 · Accepted Answer · answered Feb 15 '18 at 17:11

2

Google's yapf works very well.

There's an online demo here: yapf.now.sh

You can integrate it into your workflow and run it when you save files in your editor or as a git precommit hook or something like that.

answered Feb 15 '18 at 17:11

Håken Lid

22,318
9
52
67

4

Stop the clock. We have a winner. This is the closest thing to what I want. And it took only six years to get the answer! – hughdbrown Feb 17 '18 at 00:00

score 1 · Answer 5 · answered Mar 20 '13 at 20:00

1

PythonTidy seems to be splitting lines quite well http://www.lacusveris.com/PythonTidy/

answered Mar 20 '13 at 20:00

zzart

11,207
5
52
47

Programmatic python source formatter

5 Answers5

Linked

Related