Skip to content

Commit

Permalink
Update to accomodate isort 5 release changes. (#1559)
Browse files Browse the repository at this point in the history
Isort 5 introduced profiles and ensure_newline_before_comments options. Either needs to be added to work correctly with black.

Co-authored-by: Richard Si <63936253+ichard26@users.noreply.github.com>
  • Loading branch information
mcsitter and ichard26 committed Jul 22, 2020
1 parent 2c5041c commit 537ea8d
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 7 deletions.
15 changes: 14 additions & 1 deletion docs/compatible_configs.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,7 @@ multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand Down Expand Up @@ -62,7 +63,15 @@ The option `force_grid_wrap = 0` is just to tell isort to only wrap imports that
the `line_length` limit.

Finally, isort should be told to wrap imports when they surpass _Black_'s default limit
of 88 characters via `line_length = 88`.
of 88 characters via `line_length = 88` as well as
`ensure_newline_before_comments = True` to ensure spacing import sections with comments
works the same as with _Black_.

**Please note** `ensure_newline_before_comments = True` only works since isort >= 5 but
does not break older versions so you can keep it if you are running previous versions.
If only isort >= 5 is used you can add `profile = black` instead of all the options
since [profiles](https://timothycrosley.github.io/isort/docs/configuration/profiles/)
are available and do the configuring for you.

### Formats

Expand All @@ -75,6 +84,7 @@ multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand All @@ -89,6 +99,7 @@ multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand All @@ -103,6 +114,7 @@ multi_line_output = 3
include_trailing_comma = true
force_grid_wrap = 0
use_parentheses = true
ensure_newline_before_comments = true
line_length = 88
```

Expand All @@ -117,6 +129,7 @@ multi_line_output = 3
include_trailing_comma = True
force_grid_wrap = 0
use_parentheses = True
ensure_newline_before_comments = True
line_length = 88
```

Expand Down
13 changes: 7 additions & 6 deletions docs/the_black_code_style.md
Original file line number Diff line number Diff line change
Expand Up @@ -153,13 +153,14 @@ the following configuration.
<details>
<summary>A compatible `.isort.cfg`</summary>

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

The equivalent command line is:
Expand Down

0 comments on commit 537ea8d

Please sign in to comment.