Black Isort incompatibility with comments in import blocks

[r-richmond]

This is an individual case that relates to #694

note: I found this earlier this week before 5.0 release but just confirmed it on 5.0.2 (p.s. congrats on the new release)

Black version: ❯ black --version black, version 19.10b0
Isort Version: ❯ pip list | grep isort
isort 5.0.2
(version displayed this way due to #1255 )

default settings for both tools

Isort's Desired Format

import os
import random

import certifi
# don't import fantasticFlake until they release it
# import fantasticFlake
import flake8
import isort

Black's Desired Format

import os
import random

import certifi

# don't import fantasticFlake until they release it
# import fantasticFlake
import flake8
import isort

Personally I think Isort's format is better/more correct but that decision I leave to the authors of these awesome tools.

[r-richmond]

Oh it looks like this was brought up in psf/black#251

and the fix is to set ensure_newline_before_comments which makes isort behave like black. Closing this out.

or just use the new feature profiles with the black option https://timothycrosley.github.io/isort/docs/configuration/profiles/