Merge pull request #751 from akaihola/isort-skip-glob

Respect isort's `skip_glob` setting

Author: akaihola

.gitignore

@@ -7,4 +7,5 @@ __pycache__/
 /.vscode/
 /build
 /venv
+/.venv
 uv.lock

CHANGES.rst

@@ -20,6 +20,7 @@ Added
   Black support.
 - pyupgrade_ is now supported as a formatter plugin. Note that changes from pyupgrade
   are applied on a per-file basis, not only for modified lines as with Black_ and Ruff_.
+- Respect the ``skip_glob`` setting of isort_.
 
 Removed
 -------
@@ -28,6 +29,7 @@ Removed
 - In the Darker configuration file under ``[tool.darker]``, the Black configuration
   options ``skip_string_normalization`` and ``skip_magic_trailing_comma`` are no longer
   valid. Use ``[tool.black]`` instead.
+- Drop support for isort_ 5.1.x.
 
 Fixed
 -----

pyproject.toml

@@ -39,7 +39,7 @@ flynt = [
     "flynt>=0.76",
 ]
 isort = [
-    "isort>=5.1.0",
+    "isort>=5.2.0",
 ]
 ruff = [
     "ruff>=0.0.292",
@@ -55,7 +55,7 @@ dev = [
     "defusedxml>=0.7.1",
     "flake8>=3.8.0",
     "flynt>=0.76",
-    "isort>=5.1.0",
+    "isort>=5.2.0",
     "mypy>=1.15",
     "packaging>=14",
     "pydocstyle>=2.0.0",

setup.cfg

@@ -1,6 +1,10 @@
 [flake8]
 # Line length according to Black rules
 max-line-length = 88
+# Skip some directories
+exclude =
+    .*
+    build
 # Ignore rules which conflict with Black
 ignore =
     # C408 Unnecessary dict call - rewrite as a literal.

src/darker/__main__.py

@@ -145,6 +145,7 @@ def _modify_and_reformat_single_file(  # noqa: PLR0913
     rev2_isorted = apply_isort(
         rev2_content,
         relative_path_in_rev2,
+        root,
         exclude.isort,
         edited_linenums_differ,
         formatter.get_config_path(),

src/darker/import_sorting.py

@@ -1,6 +1,7 @@
 """Helpers for invoking ``isort`` and acting on its output"""
 
 import logging
+from contextlib import suppress
 from pathlib import Path
 from typing import Any, Collection, List, Optional, TypedDict
 
@@ -51,9 +52,10 @@ class IsortArgs(TypedDict, total=False):
     settings_path: str
 
 
-def apply_isort(  # pylint: disable=too-many-arguments
+def apply_isort(  # pylint: disable=too-many-arguments  # noqa: PLR0913
     content: TextDocument,
-    src: Path,
+    relative_path: Path,
+    root: Path,
     exclude: Collection[str],
     edited_linenums_differ: EditedLinenumsDiffer,
     config: Optional[str] = None,
@@ -62,27 +64,28 @@ def apply_isort(  # pylint: disable=too-many-arguments
     """Run isort on the given Python source file content
 
     :param content: The contents of the Python source code file to sort imports in
-    :param src: The relative path to the file. This must be the actual path in the
-                repository, which may differ from the path given on the command line in
-                case of VSCode temporary files.
+    :param relative_path: The path to the file relative to ``root``. Note that this may
+                          differ from the path given on the command line in case of
+                          VSCode temporary files.
+    :param root: The root directory based on which ``src`` is resolved.
     :param exclude: The file path patterns to exclude from import sorting
     :param edited_linenums_differ: Helper for finding out which lines were edited
     :param config: Path to configuration file
     :param line_length: Maximum line length to use
     :return: Original Python source file contents with imports sorted
 
     """
-    if glob_any(src, exclude):
+    if glob_any(relative_path, exclude):
         return content
     edited_linenums = edited_linenums_differ.revision_vs_lines(
-        src,
+        relative_path,
         content,
         context_lines=0,
     )  # pylint: disable=duplicate-code
     if not edited_linenums:
         return content
-    isort_args = _build_isort_args(src, config, line_length)
-    rev2_isorted = _call_isort_code(content, isort_args)
+    isort_args = _build_isort_args(root / relative_path, config, line_length)
+    rev2_isorted = _call_isort_code(content, root / relative_path, isort_args)
     # Get the chunks in the diff between the edited and import-sorted file
     isort_chunks = diff_chunks(content, rev2_isorted)
     if not isort_chunks:
@@ -98,15 +101,16 @@ def apply_isort(  # pylint: disable=too-many-arguments
 
 
 def _build_isort_args(
-    src: Path,
+    path_from_cwd: Path,
     config: Optional[str] = None,
     line_length: Optional[int] = None,
 ) -> IsortArgs:
     """Build ``isort.code()`` keyword arguments
 
-    :param src: The relative path to the file. This must be the actual path in the
-                repository, which may differ from the path given on the command line in
-                case of VSCode temporary files.
+    :param path_from_cwd: The path to the file. This must be either an absolute path or
+                          a relative path from the current working directory. Note that
+                          this may differ from the path given on the command line in
+                          case of VSCode temporary files.
     :param config: Path to configuration file
     :param line_length: Maximum line length to use
 
@@ -115,16 +119,20 @@ def _build_isort_args(
     if config:
         isort_args["settings_file"] = config
     else:
-        isort_args["settings_path"] = str(find_project_root((str(src),)))
+        isort_args["settings_path"] = str(find_project_root((str(path_from_cwd),)))
     if line_length:
         isort_args["line_length"] = line_length
     return isort_args
 
 
-def _call_isort_code(content: TextDocument, isort_args: IsortArgs) -> TextDocument:
+def _call_isort_code(
+    content: TextDocument, path_from_cwd: Path, isort_args: IsortArgs
+) -> TextDocument:
     """Call ``isort.code()`` and return the result as a `TextDocument` object
 
     :param content: The contents of the Python source code file to sort imports in
+    :param path_from_cwd: The path to the file with the given content, either relative
+                          to the current working directory or an absolute path.
     :param isort_args: Keyword arguments for ``isort.code()``
 
     """
@@ -133,10 +141,8 @@ def _call_isort_code(content: TextDocument, isort_args: IsortArgs) -> TextDocume
         "isort.code(code=..., %s)",
         ", ".join(f"{k}={v!r}" for k, v in isort_args.items()),
     )
-    try:
-        code = isort_code(code=code, **isort_args)
-    except isort.exceptions.FileSkipComment:
-        pass
+    with suppress(isort.exceptions.FileSkipped):
+        code = isort_code(code=code, file_path=path_from_cwd, **isort_args)
     return TextDocument.from_str(
         code,
         encoding=content.encoding,

src/darker/tests/test_import_sorting.py

@@ -64,14 +64,19 @@ def apply_isort_repo_root(request, tmp_path_factory):
 )
 def test_apply_isort(apply_isort_repo_root, encoding, newline, content, expect):
     """Imports are sorted if edits overlap them, with encoding and newline intact"""
+    repo_root = apply_isort_repo_root[newline]
     edited_linenums_differ = EditedLinenumsDiffer(
-        apply_isort_repo_root[newline], RevisionRange("HEAD", ":WORKTREE:")
+        repo_root, RevisionRange("HEAD", ":WORKTREE:")
     )
     src = Path("test1.py")
     content_ = TextDocument.from_lines(content, encoding=encoding, newline=newline)
 
     result = darker.import_sorting.apply_isort(
-        content_, src, exclude=[], edited_linenums_differ=edited_linenums_differ
+        content_,
+        src,
+        repo_root,
+        exclude=[],
+        edited_linenums_differ=edited_linenums_differ,
     )
 
     assert result.lines == expect
@@ -99,14 +104,19 @@ def test_apply_isort_exclude(
     apply_isort_repo_root, encoding, newline, content, exclude, expect
 ):
     """Import sorting is skipped if file path matches exclusion patterns"""
+    repo_root = apply_isort_repo_root[newline]
     edited_linenums_differ = EditedLinenumsDiffer(
-        apply_isort_repo_root[newline], RevisionRange("HEAD", ":WORKTREE:")
+        repo_root, RevisionRange("HEAD", ":WORKTREE:")
     )
     src = Path("test1.py")
     content_ = TextDocument.from_lines(content, encoding=encoding, newline=newline)
 
     result = darker.import_sorting.apply_isort(
-        content_, src, exclude=exclude, edited_linenums_differ=edited_linenums_differ
+        content_,
+        src,
+        repo_root,
+        exclude=exclude,
+        edited_linenums_differ=edited_linenums_differ,
     )
 
     assert result.lines == expect
@@ -148,10 +158,10 @@ def test_apply_isort_exclude(
         ),
     ),
 )
-def test_isort_config(monkeypatch, tmpdir, line_length, settings_file, expect):
+def test_isort_config(monkeypatch, tmp_path, line_length, settings_file, expect):
     """``apply_isort()`` parses ``pyproject.toml``correctly"""
-    monkeypatch.chdir(tmpdir)
-    (tmpdir / "pyproject.toml").write(
+    monkeypatch.chdir(tmp_path)
+    (tmp_path / "pyproject.toml").write_text(
         dedent(
             f"""\
             [tool.isort]
@@ -161,11 +171,14 @@ def test_isort_config(monkeypatch, tmpdir, line_length, settings_file, expect):
     )
 
     content = "from module import ab, cd, ef, gh, ij, kl, mn, op, qr, st, uv, wx, yz"
-    config = str(tmpdir / settings_file) if settings_file else None
+    # isort doesn't read the file but skips formatting if the file doesn't exist:
+    (tmp_path / "test1.py").write_text(content)
+    config = str(tmp_path / settings_file) if settings_file else None
 
     actual = darker.import_sorting.apply_isort(
         TextDocument.from_str(content),
         Path("test1.py"),
+        tmp_path,
         set(),
         EditedLinenumsDiffer(Path("."), RevisionRange("master", "HEAD")),
         config,
@@ -206,6 +219,7 @@ def test_isort_file_skip_comment():
     actual = darker.import_sorting.apply_isort(
         TextDocument.from_str(content),
         Path("test1.py"),
+        Path(),
         set(),
         EditedLinenumsDiffer(Path("."), RevisionRange("master", "HEAD")),
     )

src/darker/tests/test_main_isort.py

@@ -2,6 +2,7 @@
 
 # pylint: disable=no-member,redefined-outer-name,unused-argument,use-dict-literal
 
+from textwrap import dedent
 from types import SimpleNamespace
 from unittest.mock import patch
 
@@ -90,6 +91,30 @@ def test_isort_option_with_isort_calls_sortimports(run_isort, isort_args):
     """Relevant config options are passed from command line to ``isort``."""
     run_isort.isort_code.assert_called_once_with(
         code="changed",
+        file_path=run_isort.root / "test1.py",
         settings_path=str(run_isort.root),
         **isort_args,
     )
+
+
+def test_isort_respects_skip_glob(tmp_path):
+    """Test that Darker respects isort's skip_glob setting."""
+    # Create a pyproject.toml file with isort skip_glob configuration
+    configuration = dedent(
+        """
+        [tool.isort]
+        skip_glob = ['*/conf/settings/*']
+        filter_files = true
+        """
+    )
+    (tmp_path / "pyproject.toml").write_text(configuration)
+    # Create a file that should be skipped
+    settings_dir = tmp_path / "conf" / "settings"
+    settings_dir.mkdir(parents=True)
+    backoffice_py = settings_dir / "backoffice.py"
+    backoffice_py.write_text("import sys\nimport os\n")
+
+    # Run darker with --isort
+    darker.__main__.main(["--isort", str(settings_dir / "backoffice.py")])
+
+    assert backoffice_py.read_text() == "import sys\nimport os\n"