isort as part of the CI pipeline

[jay-tyler]

Opening a dummy PR to get a little feedback re isort. The last 3x commits have been little experiment runs against isort and black.

When I run isort -c hug/*py on the latest commit I get the following.

ERROR: /Users/jason/python/hug/hug/__init__.py Imports are incorrectly sorted.
ERROR: /Users/jason/python/hug/hug/interface.py Imports are incorrectly sorted.

It seems black is also in a bit of a tug-of-war with isort, but I haven't looked closely enough to really understand it (yet).

[timothycrosley]

isort needs to be set to use a black compatible configuration:

https://github.com/python/black#how-black-wraps-lines (described at the bottom of this section)

$ isort --multi-line=3 --trailing-comma --force-grid-wrap=0 --use-parentheses --line-width=88 [ file.py ]

From command line, or:

[settings]
multi_line_output=3
include_trailing_comma=True
force_grid_wrap=0
use_parentheses=True
line_length=88

in .isort.cfg

[jay-tyler]

Ok, gave that I shot, but still coming back with a set of reformats. Running isort -c hug/*py on the latest commit (with isort.cfg) generates the following

ERROR: /Users/jason/python/hug/hug/__init__.py Imports are incorrectly sorted.
ERROR: /Users/jason/python/hug/hug/api.py Imports are incorrectly sorted.
ERROR: /Users/jason/python/hug/hug/development_runner.py Imports are incorrectly sorted.
ERROR: /Users/jason/python/hug/hug/input_format.py Imports are incorrectly sorted.
ERROR: /Users/jason/python/hug/hug/interface.py Imports are incorrectly sorted.
ERROR: /Users/jason/python/hug/hug/output_format.py Imports are incorrectly sorted.
ERROR: /Users/jason/python/hug/hug/route.py Imports are incorrectly sorted.
ERROR: /Users/jason/python/hug/hug/test.py Imports are incorrectly sorted.

[jay-tyler]

Also is globbing stable? Or am I supposed to direct isort to a single file at a time?

There's a series of 3x commits in this PR where I was getting different results simply by running isort hug/*py over and over. A directive may have been ignored in the last of those commits.

(Also the commit msg for 3d05979 is wrong; I ran isort 2x times without the -c flag)

[timothycrosley]

I believe, the best way to do this in isort is isort -c --recursive hug or even nicer isort -c --diff --recursive hug so that it shows you exactly what it thinks is incorrectly sorted. Glob should work, though it's shell, and even shell setting dependent.

I made a small commit to develop, that removes the other cause of issues - I believe, which is the old usage of .editorconfig to specify some isort settings (b2f82aa)

[jay-tyler]

Ok, I think we can merge this branch actually (even though that wasn't the original intent). Or if you want to get rid of the comment noise, happy to open another PR on a branch with a better name.

[timothycrosley]

No need, I'm fine keeping the comment history. This is awesome! Thank you!