Merge pull request #1820 from anirudnits/multiple_configs

Support for Multiple configs

Author: timothycrosley

isort/api.py

@@ -323,12 +323,23 @@ def check_file(
     - **extension**: The file extension that contains imports. Defaults to filename extension or py.
     - ****config_kwargs**: Any config modifications.
     """
+    file_config: Config = config
+
+    if "config_trie" in config_kwargs:
+        config_trie = config_kwargs.pop("config_trie", None)
+        if config_trie:
+            config_info = config_trie.search(filename)
+            if config.verbose:
+                print(f"{config_info[0]} used for file {filename}")
+
+            file_config = Config(**config_info[1])
+
     with io.File.read(filename) as source_file:
         return check_stream(
             source_file.stream,
             show_diff=show_diff,
             extension=extension,
-            config=config,
+            config=file_config,
             file_path=file_path or source_file.path,
             disregard_skip=disregard_skip,
             **config_kwargs,
@@ -380,9 +391,20 @@ def sort_file(
     the original file content.
     - ****config_kwargs**: Any config modifications.
     """
+    file_config: Config = config
+
+    if "config_trie" in config_kwargs:
+        config_trie = config_kwargs.pop("config_trie", None)
+        if config_trie:
+            config_info = config_trie.search(filename)
+            if config.verbose:
+                print(f"{config_info[0]} used for file {filename}")
+
+            file_config = Config(**config_info[1])
+
     with io.File.read(filename) as source_file:
         actual_file_path = file_path or source_file.path
-        config = _config(path=actual_file_path, config=config, **config_kwargs)
+        config = _config(path=actual_file_path, config=file_config, **config_kwargs)
         changed: bool = False
         try:
             if write_to_stdout:

isort/main.py

@@ -15,7 +15,8 @@
 from .format import create_terminal_printer
 from .logo import ASCII_ART
 from .profiles import profiles
-from .settings import VALID_PY_TARGETS, Config
+from .settings import VALID_PY_TARGETS, Config, find_all_configs
+from .utils import Trie
 from .wrap_modes import WrapModes
 
 DEPRECATED_SINGLE_DASH_ARGS = {
@@ -259,6 +260,22 @@ def _build_arg_parser() -> argparse.ArgumentParser:
         help="Explicitly set the settings path or file instead of auto determining "
         "based on file location.",
     )
+    general_group.add_argument(
+        "--cr",
+        "--config-root",
+        dest="config_root",
+        help="Explicitly set the config root for resolving all configs. When used "
+        "with the --resolve-all-configs flag, isort will look at all sub-folders "
+        "in this config root to resolve config files and sort files based on the "
+        "closest available config(if any)",
+    )
+    general_group.add_argument(
+        "--resolve-all-configs",
+        dest="resolve_all_configs",
+        action="store_true",
+        help="Tells isort to resolve the configs for all sub-directories "
+        "and sort files in terms of its closest config files.",
+    )
     general_group.add_argument(
         "--profile",
         dest="profile",
@@ -1074,10 +1091,15 @@ def main(argv: Optional[Sequence[str]] = None, stdin: Optional[TextIOWrapper] =
     stream_filename = config_dict.pop("filename", None)
     ext_format = config_dict.pop("ext_format", None)
     allow_root = config_dict.pop("allow_root", None)
+    resolve_all_configs = config_dict.pop("resolve_all_configs", False)
     wrong_sorted_files = False
     all_attempt_broken = False
     no_valid_encodings = False
 
+    config_trie: Optional[Trie] = None
+    if resolve_all_configs:
+        config_trie = find_all_configs(config_dict.pop("config_root", "."))
+
     if "src_paths" in config_dict:
         config_dict["src_paths"] = {
             Path(src_path).resolve() for src_path in config_dict.get("src_paths", ())
@@ -1165,6 +1187,7 @@ def main(argv: Optional[Sequence[str]] = None, stdin: Optional[TextIOWrapper] =
                     ask_to_apply=ask_to_apply,
                     write_to_stdout=write_to_stdout,
                     extension=ext_format,
+                    config_trie=config_trie,
                 ),
                 file_names,
             )
@@ -1179,6 +1202,7 @@ def main(argv: Optional[Sequence[str]] = None, stdin: Optional[TextIOWrapper] =
                     show_diff=show_diff,
                     write_to_stdout=write_to_stdout,
                     extension=ext_format,
+                    config_trie=config_trie,
                 )
                 for file_name in file_names
             )

isort/settings.py

@@ -41,6 +41,7 @@
 from .profiles import profiles
 from .sections import DEFAULT as SECTION_DEFAULTS
 from .sections import FIRSTPARTY, FUTURE, LOCALFOLDER, STDLIB, THIRDPARTY
+from .utils import Trie
 from .wrap_modes import WrapModes
 from .wrap_modes import from_string as wrap_mode_from_string
 
@@ -785,6 +786,35 @@ def _find_config(path: str) -> Tuple[str, Dict[str, Any]]:
     return (path, {})
 
 
+@lru_cache()
+def find_all_configs(path: str) -> Trie:
+    """
+    Looks for config files in the path provided and in all of its sub-directories.
+    Parses and stores any config file encountered in a trie and returns the root of
+    the trie
+    """
+    trie_root = Trie("default", {})
+
+    for (dirpath, _, _) in os.walk(path):
+        for config_file_name in CONFIG_SOURCES:
+            potential_config_file = os.path.join(dirpath, config_file_name)
+            if os.path.isfile(potential_config_file):
+                config_data: Dict[str, Any]
+                try:
+                    config_data = _get_config_data(
+                        potential_config_file, CONFIG_SECTIONS[config_file_name]
+                    )
+                except Exception:
+                    warn(f"Failed to pull configuration information from {potential_config_file}")
+                    config_data = {}
+
+                if config_data:
+                    trie_root.insert(potential_config_file, config_data)
+                    break
+
+    return trie_root
+
+
 @lru_cache()
 def _get_config_data(file_path: str, sections: Tuple[str]) -> Dict[str, Any]:
     settings: Dict[str, Any] = {}

isort/utils.py

@@ -1,5 +1,61 @@
 import os
 import sys
+from pathlib import Path
+from typing import Any, Dict, Optional, Tuple
+
+
+class TrieNode:
+    def __init__(self, config_file: str = "", config_data: Optional[Dict[str, Any]] = None) -> None:
+        if not config_data:
+            config_data = {}
+
+        self.nodes: Dict[str, TrieNode] = {}
+        self.config_info: Tuple[str, Dict[str, Any]] = (config_file, config_data)
+
+
+class Trie:
+    """
+    A prefix tree to store the paths of all config files and to search the nearest config
+    associated with each file
+    """
+
+    def __init__(self, config_file: str = "", config_data: Optional[Dict[str, Any]] = None) -> None:
+        self.root: TrieNode = TrieNode(config_file, config_data)
+
+    def insert(self, config_file: str, config_data: Dict[str, Any]) -> None:
+        resolved_config_path_as_tuple = Path(config_file).parent.resolve().parts
+
+        temp = self.root
+
+        for path in resolved_config_path_as_tuple:
+            if path not in temp.nodes:
+                temp.nodes[path] = TrieNode()
+
+            temp = temp.nodes[path]
+
+        temp.config_info = (config_file, config_data)
+
+    def search(self, filename: str) -> Tuple[str, Dict[str, Any]]:
+        """
+        Returns the closest config relative to filename by doing a depth
+        first search on the prefix tree.
+        """
+        resolved_file_path_as_tuple = Path(filename).resolve().parts
+
+        temp = self.root
+
+        last_stored_config: Tuple[str, Dict[str, Any]] = ("", {})
+
+        for path in resolved_file_path_as_tuple:
+            if temp.config_info[0]:
+                last_stored_config = temp.config_info
+
+            if path not in temp.nodes:
+                break
+
+            temp = temp.nodes[path]
+
+        return last_stored_config
 
 
 def exists_case_sensitive(path: str) -> bool:

tests/unit/test_main.py

@@ -79,6 +79,7 @@ def test_parse_args():
     assert main.parse_args(["--dont-follow-links"]) == {"follow_links": False}
     assert main.parse_args(["--overwrite-in-place"]) == {"overwrite_in_place": True}
     assert main.parse_args(["--from-first"]) == {"from_first": True}
+    assert main.parse_args(["--resolve-all-configs"]) == {"resolve_all_configs": True}
 
 
 def test_ascii_art(capsys):
@@ -1211,3 +1212,136 @@ def main_check(args):
         out, error = main_check([str(git_project0), "--skip-gitignore", "--filter-files"])
 
         assert all(f"{str(tmpdir)}{file}" in out for file in should_check)
+
+
+def test_multiple_configs(capsys, tmpdir):
+    # Ensure that --resolve-all-configs flag resolves multiple configs correctly
+    # and sorts files corresponding to their nearest config
+
+    setup_cfg = """
+[isort]
+from_first=True
+"""
+
+    pyproject_toml = """
+[tool.isort]
+no_inline_sort = \"True\"
+"""
+
+    isort_cfg = """
+[settings]
+force_single_line=True
+"""
+
+    broken_isort_cfg = """
+[iaort_confg]
+force_single_line=True
+"""
+
+    dir1 = tmpdir / "subdir1"
+    dir2 = tmpdir / "subdir2"
+    dir3 = tmpdir / "subdir3"
+    dir4 = tmpdir / "subdir4"
+
+    dir1.mkdir()
+    dir2.mkdir()
+    dir3.mkdir()
+    dir4.mkdir()
+
+    setup_cfg_file = dir1 / "setup.cfg"
+    setup_cfg_file.write_text(setup_cfg, "utf-8")
+
+    pyproject_toml_file = dir2 / "pyproject.toml"
+    pyproject_toml_file.write_text(pyproject_toml, "utf-8")
+
+    isort_cfg_file = dir3 / ".isort.cfg"
+    isort_cfg_file.write_text(isort_cfg, "utf-8")
+
+    broken_isort_cfg_file = dir4 / ".isort.cfg"
+    broken_isort_cfg_file.write_text(broken_isort_cfg, "utf-8")
+
+    import_section = """
+from a import y, z, x
+import b
+"""
+
+    file1 = dir1 / "file1.py"
+    file1.write_text(import_section, "utf-8")
+
+    file2 = dir2 / "file2.py"
+    file2.write_text(import_section, "utf-8")
+
+    file3 = dir3 / "file3.py"
+    file3.write_text(import_section, "utf-8")
+
+    file4 = dir4 / "file4.py"
+    file4.write_text(import_section, "utf-8")
+
+    file5 = tmpdir / "file5.py"
+    file5.write_text(import_section, "utf-8")
+
+    main.main([str(tmpdir), "--resolve-all-configs", "--cr", str(tmpdir), "--verbose"])
+    out, _ = capsys.readouterr()
+
+    assert f"{str(setup_cfg_file)} used for file {str(file1)}" in out
+    assert f"{str(pyproject_toml_file)} used for file {str(file2)}" in out
+    assert f"{str(isort_cfg_file)} used for file {str(file3)}" in out
+    assert f"default used for file {str(file4)}" in out
+    assert f"default used for file {str(file5)}" in out
+
+    assert (
+        file1.read()
+        == """
+from a import x, y, z
+import b
+"""
+    )
+
+    assert (
+        file2.read()
+        == """
+import b
+from a import y, z, x
+"""
+    )
+    assert (
+        file3.read()
+        == """
+import b
+from a import x
+from a import y
+from a import z
+"""
+    )
+    assert (
+        file4.read()
+        == """
+import b
+from a import x, y, z
+"""
+    )
+
+    assert (
+        file5.read()
+        == """
+import b
+from a import x, y, z
+"""
+    )
+
+    # Ensure that --resolve-all-config flags works with --check
+
+    file6 = dir1 / "file6.py"
+    file6.write(
+        """
+import b
+from a import x, y, z
+    """
+    )
+
+    with pytest.raises(SystemExit):
+        main.main([str(tmpdir), "--resolve-all-configs", "--cr", str(tmpdir), "--check"])
+
+    _, err = capsys.readouterr()
+
+    assert f"{str(file6)} Imports are incorrectly sorted and/or formatted" in err

tests/unit/test_settings.py

@@ -238,3 +238,64 @@ def test_as_bool():
         settings._as_bool("falsey")
     with pytest.raises(ValueError):
         settings._as_bool("truthy")
+
+
+def test_find_all_configs(tmpdir):
+    setup_cfg = """
+[isort]
+profile=django
+"""
+
+    pyproject_toml = """
+[tool.isort]
+profile = "hug"
+"""
+
+    isort_cfg = """
+[settings]
+profile=black
+"""
+
+    pyproject_toml_broken = """
+[tool.isorts]
+something = nothing
+"""
+
+    dir1 = tmpdir / "subdir1"
+    dir2 = tmpdir / "subdir2"
+    dir3 = tmpdir / "subdir3"
+    dir4 = tmpdir / "subdir4"
+
+    dir1.mkdir()
+    dir2.mkdir()
+    dir3.mkdir()
+    dir4.mkdir()
+
+    setup_cfg_file = dir1 / "setup.cfg"
+    setup_cfg_file.write_text(setup_cfg, "utf-8")
+
+    pyproject_toml_file = dir2 / "pyproject.toml"
+    pyproject_toml_file.write_text(pyproject_toml, "utf-8")
+
+    isort_cfg_file = dir3 / ".isort.cfg"
+    isort_cfg_file.write_text(isort_cfg, "utf-8")
+
+    pyproject_toml_file_broken = dir4 / "pyproject.toml"
+    pyproject_toml_file_broken.write_text(pyproject_toml_broken, "utf-8")
+
+    config_trie = settings.find_all_configs(str(tmpdir))
+
+    config_info_1 = config_trie.search(str(dir1 / "test1.py"))
+    assert config_info_1[0] == str(setup_cfg_file)
+    assert config_info_1[0] == str(setup_cfg_file) and config_info_1[1]["profile"] == "django"
+
+    config_info_2 = config_trie.search(str(dir2 / "test2.py"))
+    assert config_info_2[0] == str(pyproject_toml_file)
+    assert config_info_2[0] == str(pyproject_toml_file) and config_info_2[1]["profile"] == "hug"
+
+    config_info_3 = config_trie.search(str(dir3 / "test3.py"))
+    assert config_info_3[0] == str(isort_cfg_file)
+    assert config_info_3[0] == str(isort_cfg_file) and config_info_3[1]["profile"] == "black"
+
+    config_info_4 = config_trie.search(str(tmpdir / "file4.py"))
+    assert config_info_4[0] == "default"

tests/unit/test_utils.py

@@ -0,0 +1,38 @@
+from isort.utils import Trie
+
+
+def test_trie():
+    trie_root = Trie("default", {"line_length": 70})
+
+    trie_root.insert("/temp/config1/.isort.cfg", {"line_length": 71})
+    trie_root.insert("/temp/config2/setup.cfg", {"line_length": 72})
+    trie_root.insert("/temp/config3/pyproject.toml", {"line_length": 73})
+
+    # Ensure that appropriate configs are resolved for files in different directories
+    config1 = trie_root.search("/temp/config1/subdir/file1.py")
+    assert config1[0] == "/temp/config1/.isort.cfg"
+    assert config1[1] == {"line_length": 71}
+
+    config1_2 = trie_root.search("/temp/config1/file1_2.py")
+    assert config1_2[0] == "/temp/config1/.isort.cfg"
+    assert config1_2[1] == {"line_length": 71}
+
+    config2 = trie_root.search("/temp/config2/subdir/subsubdir/file2.py")
+    assert config2[0] == "/temp/config2/setup.cfg"
+    assert config2[1] == {"line_length": 72}
+
+    config2_2 = trie_root.search("/temp/config2/subdir/file2_2.py")
+    assert config2_2[0] == "/temp/config2/setup.cfg"
+    assert config2_2[1] == {"line_length": 72}
+
+    config3 = trie_root.search("/temp/config3/subdir/subsubdir/subsubsubdir/file3.py")
+    assert config3[0] == "/temp/config3/pyproject.toml"
+    assert config3[1] == {"line_length": 73}
+
+    config3_2 = trie_root.search("/temp/config3/file3.py")
+    assert config3_2[0] == "/temp/config3/pyproject.toml"
+    assert config3_2[1] == {"line_length": 73}
+
+    config_outside = trie_root.search("/temp/file.py")
+    assert config_outside[0] == "default"
+    assert config_outside[1] == {"line_length": 70}