Black formatter PR #282

AhmetCanSolak · 2019-05-21T17:46:14Z

Description

This PR is to see how black formatter would change some of our code.
Please check the details and let each other know about your comments.

Type of change

New feature (non-breaking change which adds functionality)
This change requires a documentation update

References

https://github.com/python/black

How has this been tested?

Will be tested on review manually.

Final checklist:

My PR is the minimum possible work for the desired functionality

pep8speaks · 2019-05-21T17:46:21Z

Hello @AhmetCanSolak! Thanks for updating this PR. We checked the lines you've touched for PEP 8 issues, and found:

In the file napari/components/_viewer/model.py:

Line 249:80: E501 line too long (84 > 79 characters)

In the file napari/util/misc.py:

Line 12:80: E501 line too long (84 > 79 characters)

Comment last updated at 2019-05-23 20:16:00 UTC

sofroniewn · 2019-05-21T20:34:30Z

napari/components/_viewer/model.py

@@ -31,16 +31,19 @@ class Viewer:
        These key bindings are executed instead of any layer specific key
        bindings.
    """
-    def __init__(self, title='napari'):
+
+    def __init__(self, title="napari"):


Is the any way to configure black to use ' instead of "?

No as far as i know. This is something black has a strong preference. To me also it makes sense, as double " is used for strings as a widely popular convention. On top of that, it is consistent with C/OpenCL and so. IMO we are very likely to depend such languages/tools in the long run.

yeah - i just found a super long hacker news post on this one! Let's just say some very strong opinions on either side

Everybody(including me) has an opinion on everything(especially in python world) :D that's why maybe better to decide according to priorities instead of opinions.

btw, good news it is possible to stop black on this with: --skip-string-normalization

yes - very interesting, I just read this thread here psf/black#118, and the main developer very reasonably added that skip, which can be achieved with the short-cut black . -S

sofroniewn

I'm pretty happy with how black has done the new line spacing, and I love how it has inserted white space between operators, I think that will cut down the review time on my PRs quite a bit!

One thing I'd be curious to see though is the output of running with the -S (--skip-string-normalization) command. I prefer the ability to mix ' and ", using ' for things like dictionary names as I find them easier to read. If we like the results then I'd vote for black -S

jni · 2019-05-21T23:35:10Z

Yeah I gotta say I'm pretty happy with the result! Thanks for running this experiment, @AhmetCanSolak!

For sure I want -S on in our project. I'm firmly on one side of the debate here. =D
I often prefer for operators to be spaced but "intelligently" grouped by priority, e.g. length/2 - max_length/2 vs length / 2 - max_length / 2...
but on the whole I think it's done a good job and if it clears up mental space for never thinking about formatting again, then that's a significant win.
also, I'm surprised by the low number of changes it's proposed, which speaks to our generally good consistency in code style till now. Go team! =P

It'd be awesome if black could also format numpy-style docstrings, but that's a bit much to ask. =)

I'm moving my position from 👎 to neutral. =)

CC @stefanv (as we have considered black for skimage also)

AhmetCanSolak · 2019-05-22T00:11:18Z

Thank you @sofroniewn and @jni !

Glad you guys like it and yes having -S will be okay too.

AhmetCanSolak · 2019-05-23T17:11:14Z

all pre-commit and black integration business available now in this PR. Would you guys prefer to have a separate PR for all formatted version of codebase or prefer it also within this PR? @kne42 @sofroniewn @jni ?

sofroniewn · 2019-05-23T17:15:05Z

I'm fine with one PR that does all the reformatting too and add the pre-commit. It looks like the build is failing now as it is not finding the right version of pre-commit

AhmetCanSolak · 2019-05-23T17:16:47Z

eerh pypi and conda versions are different :( fixing it

kne42

I'd prefer to see the pre-commit stuff as a separate PR split into three commits:

actual pre-commit code/setup
documentation (README banner/CONTRIBUTING section)
the results of pre-commit run --all-files

We could also make this PR just the results of black -S and the pre-commit code as a separate PR.

.pre-commit-config.yaml

CONTRIBUTING.md

requirements/default.txt

Co-Authored-By: Kira Evans <[email protected]>

…code as discussion ended

…into blackpr

AhmetCanSolak · 2019-06-03T21:41:46Z

Updated this PR. Will be happy if you guys @jni @sofroniewn @kne42 can review so i can continue with formatting the entire repo with black.

CONTRIBUTING.md

sofroniewn

I'm approving as it looks close, though I did request some more detail in the contributing guidelines. Maybe @kne42 and @jni have further thoughts though

jni

@AhmetCanSolak I think @sofroniewn's comment is worth addressing in this PR, as well as line length. I think both should be quick work!

pyproject.toml

sofroniewn · 2019-06-05T03:21:10Z

CONTRIBUTING.md

+
+With help of pre-commit, your future commits will be reformatted with our black configuration
+which includes settings like `skip-string-normalization = true` and `max-line-length = 79`.
+If you like to learn more please check [black](https://github.com/python/black).


Can you change it to "If you would like to learn more", slightly better grammatically. Otherwise looks ready to merge

jni · 2019-06-05T08:29:31Z

Boom! =)

AhmetCanSolak added 9 commits March 5, 2019 11:21

rtd theme, globaltoc added on side bar, warnings are only for docstrings

1467995

Merge remote-tracking branch 'upstream/master'

82571cc

contributing guideline update on dev-docs

98e1289

Merge remote-tracking branch 'upstream/master'

cbbb131

fix sphinx-apidoc command on CONTRIBUTING.MD

45155c1

merge conflict resolution

a56d600

Merge remote-tracking branch 'upstream/master'

71a3799

Merge remote-tracking branch 'upstream/master'

ab5e45a

initial black pr commit

da13958

AhmetCanSolak self-assigned this May 21, 2019

AhmetCanSolak mentioned this pull request May 21, 2019

Using a formatter #270

Closed

AhmetCanSolak added this to the 0.1.0 milestone May 21, 2019

AhmetCanSolak added the feature New feature or request label May 21, 2019

AhmetCanSolak requested review from sofroniewn and freeman-lab May 21, 2019 17:49

kne42 mentioned this pull request May 21, 2019

demo yapf with default settings #283

Closed

sofroniewn reviewed May 21, 2019

View reviewed changes

sofroniewn requested changes May 21, 2019

View reviewed changes

black integration and corresponding documentation

c00c8b8

pre-commit requirements version fix

b633ab1

AhmetCanSolak requested a review from sofroniewn May 23, 2019 17:18

kne42 reviewed May 23, 2019

View reviewed changes

.pre-commit-config.yaml Show resolved Hide resolved

CONTRIBUTING.md Outdated Show resolved Hide resolved

requirements/default.txt Outdated Show resolved Hide resolved

Update CONTRIBUTING.md

10714bf

Co-Authored-By: Kira Evans <[email protected]>

AhmetCanSolak added 2 commits June 3, 2019 14:36

fix on black integration and its documentation, removal of formatted …

f86e37f

…code as discussion ended

Merge branch 'blackpr' of https://github.com/AhmetCanSolak/napari-gui …

e369388

…into blackpr

black version fix

85fa653

sofroniewn reviewed Jun 4, 2019

View reviewed changes

CONTRIBUTING.md Show resolved Hide resolved

sofroniewn approved these changes Jun 4, 2019

View reviewed changes

jni requested changes Jun 4, 2019

View reviewed changes

pyproject.toml Show resolved Hide resolved

AhmetCanSolak added 2 commits June 4, 2019 10:05

max line length added to pyproject.toml

5a5e3ef

contributing guideline update upon review

e077447

sofroniewn reviewed Jun 5, 2019

View reviewed changes

Update black info on CONTRIBUTING

93db838

jni approved these changes Jun 5, 2019

View reviewed changes

jni merged commit 01b8ff0 into napari:master Jun 5, 2019

AhmetCanSolak deleted the blackpr branch June 5, 2019 16:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Black formatter PR #282

Black formatter PR #282

AhmetCanSolak commented May 21, 2019

pep8speaks commented May 21, 2019 •

edited

Loading

sofroniewn May 21, 2019

AhmetCanSolak May 21, 2019 •

edited

Loading

sofroniewn May 21, 2019 •

edited

Loading

AhmetCanSolak May 21, 2019

AhmetCanSolak May 21, 2019

sofroniewn May 21, 2019

sofroniewn left a comment

jni commented May 21, 2019

AhmetCanSolak commented May 22, 2019

AhmetCanSolak commented May 23, 2019

sofroniewn commented May 23, 2019

AhmetCanSolak commented May 23, 2019

kne42 left a comment •

edited

Loading

AhmetCanSolak commented Jun 3, 2019

sofroniewn left a comment

jni left a comment

sofroniewn Jun 5, 2019

jni commented Jun 5, 2019

Black formatter PR #282

Black formatter PR #282

Conversation

AhmetCanSolak commented May 21, 2019

Description

Type of change

References

How has this been tested?

Final checklist:

pep8speaks commented May 21, 2019 • edited Loading

Comment last updated at 2019-05-23 20:16:00 UTC

sofroniewn May 21, 2019

Choose a reason for hiding this comment

AhmetCanSolak May 21, 2019 • edited Loading

Choose a reason for hiding this comment

sofroniewn May 21, 2019 • edited Loading

Choose a reason for hiding this comment

AhmetCanSolak May 21, 2019

Choose a reason for hiding this comment

AhmetCanSolak May 21, 2019

Choose a reason for hiding this comment

sofroniewn May 21, 2019

Choose a reason for hiding this comment

sofroniewn left a comment

Choose a reason for hiding this comment

jni commented May 21, 2019

AhmetCanSolak commented May 22, 2019

AhmetCanSolak commented May 23, 2019

sofroniewn commented May 23, 2019

AhmetCanSolak commented May 23, 2019

kne42 left a comment • edited Loading

Choose a reason for hiding this comment

AhmetCanSolak commented Jun 3, 2019

sofroniewn left a comment

Choose a reason for hiding this comment

jni left a comment

Choose a reason for hiding this comment

sofroniewn Jun 5, 2019

Choose a reason for hiding this comment

jni commented Jun 5, 2019

pep8speaks commented May 21, 2019 •

edited

Loading

AhmetCanSolak May 21, 2019 •

edited

Loading

sofroniewn May 21, 2019 •

edited

Loading

kne42 left a comment •

edited

Loading