Add configuration to ensure a newline before each comment #1000

FuegoFro · 2019-08-18T17:49:24Z

This adds a ensure_newline_before_comments configuration that matches the format that black imposes (for better or worse) and allows isort to be used with black without any thrashing/conflicts with regards to blank lines before comments.

Should help address psf/black#251

This adds a `ensure_newline_before_comments` configuration that matches the format that `black` imposes (for better or worse) and allows `isort` to be used with `black` without any thrashing/conflicts with regards to blank lines before comments. Should help address psf/black#251

codecov-io · 2019-08-18T17:54:17Z

Codecov Report

Merging #1000 into develop will decrease coverage by 0.02%.
The diff coverage is 84.61%.

@@             Coverage Diff             @@
##           develop    #1000      +/-   ##
===========================================
- Coverage    89.77%   89.75%   -0.03%     
===========================================
  Files           12       12              
  Lines         2680     2693      +13     
  Branches       457      461       +4     
===========================================
+ Hits          2406     2417      +11     
- Misses         186      187       +1     
- Partials        88       89       +1

…ion logic.

xmnlab · 2019-09-10T20:48:35Z

this implementation would be very helpful.
is there any any estimate to move that forward?

Remove blank lines per black

Fix method redefinition due to bad merge

timothycrosley · 2019-09-12T04:02:38Z

@FuegoFro This is great! Thanks for working on this!

FuegoFro · 2019-09-12T17:54:46Z

Thank you for the merge! 😀

waiting for PyCQA/isort#1000 Author: Ivan Ogasawara <[email protected]> Closes #1963 from xmnlab/black-files-formatting and squashes the following commits: 9d1defb [Ivan Ogasawara] Re-formatting all files using pre-commit hook

hugovk · 2019-09-25T19:31:11Z

Confirmed current master fixes the problem.

Is there a schedule for the next release? It would help unblock formatting pip with Black+isort.

Thanks!

timothycrosley · 2019-09-26T10:04:44Z

@hugovk I can get it scheduled comfortably for 2 weeks for now. if it is really urgent I can try to get the release in good shape within a week. I hate to block the work on pip!

Let me know,

Thanks!

~Timothy

hugovk · 2019-09-26T10:25:37Z

Thanks! I don't know how long it'll take for the PR to be reviewed (it's big!) so let's ask over there: pypa/pip#7084.

pradyunsg · 2019-09-26T11:46:06Z

I hate to block the work on pip!

Hi hi.

Don't worry about that -- We can easily wait for the next release of isort for doing this, so please feel free to make the release at a time that's comfortable for you. No pressure from our end. :)

AFAIK, we're in no hurry to adopt black (we already use isort!) even though I don't think anyone is opposed to it at this point. 🙃

Thanks for all of your (and other contributors') work on isort!

waiting for PyCQA/isort#1000 Author: Ivan Ogasawara <[email protected]> Closes ibis-project#1963 from xmnlab/black-files-formatting and squashes the following commits: 9d1defb [Ivan Ogasawara] Re-formatting all files using pre-commit hook

FuegoFro · 2019-10-14T17:19:29Z

Hey! Just wondering if there was any news on a release that has this change in it. No rush! Just curious 🙂

timothycrosley · 2019-10-15T04:54:02Z

Hi @FuegoFro,

I've finished the other project that I wanted to finish up before the release: https://timothycrosley.com/project-7-streamdeck_ui and switched to spending all my OpenSource time working on preparing the isort 5.0.0 release. I hope to have it wrapped up soon.

Thanks!

~Timothy

- Ref. PyCQA/isort#1000

- Ref: PyCQA/isort#1000

FuegoFro · 2019-11-27T19:58:22Z

Hey there! Just checking in again to see if any progress has been made on a new release 🙂

Since PyCQA#1000 was merged to address black compatibility, best include it in the profile.

pradyunsg · 2020-01-24T13:51:54Z

@timothycrosley Gentle nudge on 5.0.0. :)

Are there any release blocker issues that we could help you with?

ssbarnea · 2020-01-24T19:00:12Z

Yes, please make a new release as we cannot use unreleased code in production.

julien-c · 2020-03-24T21:02:33Z

Any news on this? Thanks!

thomwolf · 2020-03-26T13:17:12Z

Can we help with the release somehow?

Needs a new release for PyCQA/isort#1000 to be available.

jonathanunderwood · 2020-06-17T08:06:40Z

@timothycrosley would it be possible to push a 4.3.x release with this feature added ahead of the move to 5.0.0? This is currently blocking projects from using isort where we would love to be able to make use of isort and black together.

Comments in import blocks cause disagreement between Black and isort. This will soon be fixed by specifying 'ensure_newline_before_comments=true' in the isort config, though this won't be honoured until the next isort release. See psf/black#251 and PyCQA/isort#1000

johnthagen · 2020-07-03T11:36:57Z

Looks like 5.0.0 is releasing tomorrow: 2ea917e

FuegoFro added 3 commits August 18, 2019 11:21

Add some more test cases to increase coverage.

a7a606e

Expand test more to test both beginning-of-section and middle-of-sect…

ba5d611

…ion logic.

Fix black formatting.

29e3571

xmnlab mentioned this pull request Sep 10, 2019

Re-formatting all files using pre-commit hook ibis-project/ibis#1963

Merged

timothycrosley added 3 commits September 11, 2019 20:43

Merge branch 'develop' into black_newline_before_comment

2340a46

Update test_isort.py

b6f6d51

Remove blank lines per black

Update test_isort.py

1e78a9a

Fix method redefinition due to bad merge

timothycrosley merged commit e63ae06 into PyCQA:develop Sep 12, 2019

FuegoFro deleted the black_newline_before_comment branch September 12, 2019 17:54

This was referenced Sep 25, 2019

isort removes newlines before standalone comments if the following line is an import of the same group psf/black#251

Closed

Format code with Black pypa/pip#7084

Closed

henrikhorluck added a commit to dotkom/onlineweb4 that referenced this pull request Oct 16, 2019

Remove comments, so that isort and Black agrees

166fee3

- Ref. PyCQA/isort#1000

henrikhorluck added a commit to dotkom/onlineweb4 that referenced this pull request Oct 23, 2019

Remove comments, so that isort and Black agree

73cb616

- Ref: PyCQA/isort#1000

StephenBrown2 added a commit to StephenBrown2/isort that referenced this pull request Jan 3, 2020

Add ensure_newline_before_comments to black profile

e0ba8f5

Since PyCQA#1000 was merged to address black compatibility, best include it in the profile.

StephenBrown2 mentioned this pull request Jan 3, 2020

Add ensure_newline_before_comments to black profile #1077

Merged

StephenBrown2 mentioned this pull request Jan 15, 2020

Add --ensure-newline-before-comments argument #1101

Merged

This comment has been minimized.

Sign in to view

ap-- added a commit to ap--/python-seabreeze that referenced this pull request May 22, 2020

[psb] formatting bugs due to isort/black conflict

011714b

Needs a new release for PyCQA/isort#1000 to be available.

ap-- added a commit to ap--/python-seabreeze that referenced this pull request May 22, 2020

[psb] formatting bugs due to isort/black conflict

28cc68d

Needs a new release for PyCQA/isort#1000 to be available.

rmol mentioned this pull request Jun 4, 2020

Add black and isort freedomofpress/securedrop-sdk#124

Merged

MarcoGorelli mentioned this pull request Aug 24, 2020

BUILD upgrade to isort v5 huggingface/transformers#6681

Closed

This pull request was closed.

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Add configuration to ensure a newline before each comment #1000

Add configuration to ensure a newline before each comment #1000

FuegoFro commented Aug 18, 2019

codecov-io commented Aug 18, 2019 •

edited

Loading

xmnlab commented Sep 10, 2019

timothycrosley commented Sep 12, 2019

FuegoFro commented Sep 12, 2019

hugovk commented Sep 25, 2019

timothycrosley commented Sep 26, 2019 •

edited

Loading

hugovk commented Sep 26, 2019

pradyunsg commented Sep 26, 2019

FuegoFro commented Oct 14, 2019

timothycrosley commented Oct 15, 2019

FuegoFro commented Nov 27, 2019

pradyunsg commented Jan 24, 2020

ssbarnea commented Jan 24, 2020

julien-c commented Mar 24, 2020

thomwolf commented Mar 26, 2020

This comment has been minimized.

jonathanunderwood commented Jun 17, 2020

johnthagen commented Jul 3, 2020

Add configuration to ensure a newline before each comment #1000

Add configuration to ensure a newline before each comment #1000

Conversation

FuegoFro commented Aug 18, 2019

codecov-io commented Aug 18, 2019 • edited Loading

Codecov Report

xmnlab commented Sep 10, 2019

timothycrosley commented Sep 12, 2019

FuegoFro commented Sep 12, 2019

hugovk commented Sep 25, 2019

timothycrosley commented Sep 26, 2019 • edited Loading

hugovk commented Sep 26, 2019

pradyunsg commented Sep 26, 2019

FuegoFro commented Oct 14, 2019

timothycrosley commented Oct 15, 2019

FuegoFro commented Nov 27, 2019

pradyunsg commented Jan 24, 2020

ssbarnea commented Jan 24, 2020

julien-c commented Mar 24, 2020

thomwolf commented Mar 26, 2020

This comment has been minimized.

jonathanunderwood commented Jun 17, 2020

johnthagen commented Jul 3, 2020

codecov-io commented Aug 18, 2019 •

edited

Loading

timothycrosley commented Sep 26, 2019 •

edited

Loading