Merge pull request #16 from Mystic-Mirage/isort_v5

Add support of isort>5

CHANGES.rst

@@ -4,6 +4,7 @@
 - Feature: Add support for black config
 - Feature: Add support for ``-l``/``--line-length`` and ``-S``/``--skip-string-normalization``
 - Feature: ``--diff`` outputs a diff for each file on standard output
+- Feature: Require ``isort`` >= 5.0.1 and be compatible with it.
 
 
 0.2.0 / 2020-03-11

pytest.ini

@@ -3,6 +3,7 @@ doctest_optionflags = NORMALIZE_WHITESPACE
 show_capture = no
 addopts =
   --black
-  --isort
+  ## Disable pytest-isort until it is fixed to work with isort 5.x
+  #  --isort
   --mypy
   --doctest-modules

setup.cfg

@@ -36,9 +36,10 @@ console_scripts =
 
 [options.extras_require]
 isort =
-    isort
+    isort>=5.0.1
 test =
     pytest
     pytest-black
-    pytest-isort
+    ## Disable pytest-isort until it is fixed to work with isort 5.x
+    #pytest-isort
     pytest-mypy

src/darker/__main__.py

@@ -15,7 +15,7 @@
     opcodes_to_edit_linenums,
 )
 from darker.git import git_diff_name_only, git_get_unmodified_content
-from darker.import_sorting import SortImports, apply_isort
+from darker.import_sorting import apply_isort, isort
 from darker.utils import get_common_root, joinlines
 from darker.verification import NotEquivalentError, verify_ast_unchanged
 from darker.version import __version__
@@ -172,7 +172,7 @@ def main(argv: List[str] = None) -> None:
     if args.version:
         print(__version__)
 
-    if args.isort and not SortImports:
+    if args.isort and not isort:
         logger.error(f"{ISORT_INSTRUCTION} to use the `--isort` option.")
         exit(1)
 

src/darker/import_sorting.py

@@ -1,29 +1,27 @@
 import logging
-from pathlib import Path
-from typing import List, cast
 
 try:
-    from isort import SortImports
+    import isort
 except ImportError:
-    SortImports = None
+    isort = None
 
 logger = logging.getLogger(__name__)
 
 
 def apply_isort(content: str) -> str:
-    logger.debug(
-        "SortImports(file_contents=..., check=True, multi_line_output=3, "
-        "include_trailing_comma=True, force_grid_wrap=0, use_parentheses=True, "
-        "line_length=88, quiet=True)"
-    )
-    result = SortImports(
-        file_contents=content,
-        check=True,
+    isort.check_code(code=content)
+    isort_config_kwargs = dict(
         multi_line_output=3,
         include_trailing_comma=True,
         force_grid_wrap=0,
         use_parentheses=True,
         line_length=88,
         quiet=True,
     )
-    return cast(str, result.output)
+    logger.debug(
+        "isort.code(code=..., {})".format(
+            ", ".join(f"{k}={v!r}" for k, v in isort_config_kwargs.items())
+        )
+    )
+    result: str = isort.code(code=content, **isort_config_kwargs)
+    return result

src/darker/tests/test_main.py

@@ -11,7 +11,7 @@
 
 def test_isort_option_without_isort(tmpdir, without_isort, caplog):
     check_call(["git", "init"], cwd=tmpdir)
-    with patch.object(darker.__main__, "SortImports", None), pytest.raises(SystemExit):
+    with patch.object(darker.__main__, "isort", None), pytest.raises(SystemExit):
 
         darker.__main__.main(["--isort", str(tmpdir)])
 
@@ -28,10 +28,10 @@ def run_isort(git_repo, monkeypatch, caplog):
     paths['test1.py'].write('changed')
     with patch.multiple(
         darker.__main__, run_black=Mock(return_value=[]), verify_ast_unchanged=Mock(),
-    ), patch("darker.import_sorting.SortImports"):
+    ), patch("darker.import_sorting.isort.code"):
         darker.__main__.main(["--isort", "./test1.py"])
         return SimpleNamespace(
-            SortImports=darker.import_sorting.SortImports, caplog=caplog
+            isort_code=darker.import_sorting.isort.code, caplog=caplog
         )
 
 
@@ -40,9 +40,8 @@ def test_isort_option_with_isort(run_isort):
 
 
 def test_isort_option_with_isort_calls_sortimports(run_isort):
-    run_isort.SortImports.assert_called_once_with(
-        file_contents="changed",
-        check=True,
+    run_isort.isort_code.assert_called_once_with(
+        code="changed",
         force_grid_wrap=0,
         include_trailing_comma=True,
         line_length=88,
@@ -111,7 +110,7 @@ def test_format_edited_parts_empty():
             True,
             {},
             False,
-            ['ERROR:  Imports are incorrectly sorted.', ''],
+            ['ERROR:  Imports are incorrectly sorted and/or formatted.', ''],
             A_PY_BLACK_ISORT,
         ),
         (
@@ -126,7 +125,8 @@ def test_format_edited_parts_empty():
             True,
             {},
             True,
-            ['ERROR:  Imports are incorrectly sorted.'] + A_PY_DIFF_BLACK_ISORT,
+            ['ERROR:  Imports are incorrectly sorted and/or formatted.']
+            + A_PY_DIFF_BLACK_ISORT,
             A_PY,
         ),
     ],