Merge branch 'main' of https://github.com/PyCQA/isort into multiple_configs

Author: anirudnits

docs/configuration/options.md

@@ -431,6 +431,15 @@ Sets the default section for import options: ('FUTURE', 'STDLIB', 'THIRDPARTY',
 **Python & Config File Name:** import_headings  
 **CLI Flags:** **Not Supported**
 
+## Import Footers
+
+**No Description**
+
+**Type:** Dict  
+**Default:** `{}`  
+**Python & Config File Name:** import_footers  
+**CLI Flags:** **Not Supported**
+
 ## Balanced Wrapping
 
 Balances wrapping to produce the most consistent line length possible
@@ -482,6 +491,18 @@ Ensures the output doesn't save if the resulting file contains syntax errors.
 - --ac
 - --atomic
 
+## Lines Before Imports
+
+How many lines to add before an import section
+
+**Type:** Int
+**Default:** `-1`
+**Python & Config File Name:** lines_before_imports
+**CLI Flags:**
+
+- --lbi
+- --lines-before-imports
+
 ## Lines After Imports
 
 **No Description**

isort/core.py

@@ -249,7 +249,10 @@ def process(
                     else:
                         code_sorting_section += line
                         line = ""
-                elif stripped_line in config.section_comments:
+                elif (
+                    stripped_line in config.section_comments
+                    or stripped_line in config.section_comments_end
+                ):
                     if import_section and not contains_imports:
                         output_stream.write(import_section)
                         import_section = line
@@ -460,6 +463,7 @@ def _indented_config(config: Config, indent: str) -> Config:
         wrap_length=max(config.wrap_length - len(indent), 0),
         lines_after_imports=1,
         import_headings=config.import_headings if config.indented_import_headings else {},
+        import_footers=config.import_footers if config.indented_import_headings else {},
     )
 
 

isort/main.py

@@ -491,6 +491,9 @@ def _build_arg_parser() -> argparse.ArgumentParser:
         dest="indent",
         type=str,
     )
+    output_group.add_argument(
+        "--lbi", "--lines-before-imports", dest="lines_before_imports", type=int
+    )
     output_group.add_argument(
         "--lai", "--lines-after-imports", dest="lines_after_imports", type=int
     )

isort/output.py

@@ -138,6 +138,17 @@ def sorted_imports(
                 if section_comment not in parsed.lines_without_imports[0:1]:  # pragma: no branch
                     section_output.insert(0, section_comment)
 
+            section_footer = config.import_footers.get(section_name.lower(), "")
+            if section_footer and section_footer not in seen_headings:
+                if config.dedup_headings:
+                    seen_headings.add(section_footer)
+                section_comment_end = f"# {section_footer}"
+                if (
+                    section_comment_end not in parsed.lines_without_imports[-1:]
+                ):  # pragma: no branch
+                    section_output.append("")  # Empty line for black compatibility
+                    section_output.append(section_comment_end)
+
             if pending_lines_before or not no_lines_before:
                 output += [""] * config.lines_between_sections
 
@@ -206,6 +217,9 @@ def sorted_imports(
             else:
                 formatted_output[imports_tail:0] = [""]
 
+            if config.lines_before_imports != -1:
+                formatted_output[:0] = ["" for line in range(config.lines_before_imports)]
+
     if parsed.place_imports:
         new_out_lines = []
         for index, line in enumerate(formatted_output):

isort/parse.py

@@ -187,7 +187,9 @@ def file_contents(contents: str, config: Config = DEFAULT_CONFIG) -> ParsedConte
             line, in_quote=in_quote, index=index, section_comments=config.section_comments
         )
 
-        if line in config.section_comments and not skipping_line:
+        if (
+            line in config.section_comments or line in config.section_comments_end
+        ) and not skipping_line:
             if import_index == -1:  # pragma: no branch
                 import_index = index - 1
             continue

isort/settings.py

@@ -102,6 +102,7 @@
 FALLBACK_CONFIG_SECTIONS: Tuple[str, ...] = ("isort", "tool:isort", "tool.isort")
 
 IMPORT_HEADING_PREFIX = "import_heading_"
+IMPORT_FOOTER_PREFIX = "import_footer_"
 KNOWN_PREFIX = "known_"
 KNOWN_SECTION_MAPPING: Dict[str, str] = {
     STDLIB: "STANDARD_LIBRARY",
@@ -173,10 +174,12 @@ class _Config:
     single_line_exclusions: Tuple[str, ...] = ()
     default_section: str = THIRDPARTY
     import_headings: Dict[str, str] = field(default_factory=dict)
+    import_footers: Dict[str, str] = field(default_factory=dict)
     balanced_wrapping: bool = False
     use_parentheses: bool = False
     order_by_type: bool = True
     atomic: bool = False
+    lines_before_imports: int = -1
     lines_after_imports: int = -1
     lines_between_sections: int = 1
     lines_between_types: int = 0
@@ -297,6 +300,7 @@ def __init__(
     ):
         self._known_patterns: Optional[List[Tuple[Pattern[str], str]]] = None
         self._section_comments: Optional[Tuple[str, ...]] = None
+        self._section_comments_end: Optional[Tuple[str, ...]] = None
         self._skips: Optional[FrozenSet[str]] = None
         self._skip_globs: Optional[FrozenSet[str]] = None
         self._sorting_function: Optional[Callable[..., List[str]]] = None
@@ -307,6 +311,7 @@ def __init__(
             config_vars["py_version"] = config_vars["py_version"].replace("py", "")
             config_vars.pop("_known_patterns")
             config_vars.pop("_section_comments")
+            config_vars.pop("_section_comments_end")
             config_vars.pop("_skips")
             config_vars.pop("_skip_globs")
             config_vars.pop("_sorting_function")
@@ -381,6 +386,7 @@ def __init__(
 
         known_other = {}
         import_headings = {}
+        import_footers = {}
         for key, value in tuple(combined_config.items()):
             # Collect all known sections beyond those that have direct entries
             if key.startswith(KNOWN_PREFIX) and key not in (
@@ -417,6 +423,8 @@ def __init__(
                         )
             if key.startswith(IMPORT_HEADING_PREFIX):
                 import_headings[key[len(IMPORT_HEADING_PREFIX) :].lower()] = str(value)
+            if key.startswith(IMPORT_FOOTER_PREFIX):
+                import_footers[key[len(IMPORT_FOOTER_PREFIX) :].lower()] = str(value)
 
             # Coerce all provided config values into their correct type
             default_value = _DEFAULT_SETTINGS.get(key, None)
@@ -495,6 +503,10 @@ def __init__(
             for import_heading_key in import_headings:
                 combined_config.pop(f"{IMPORT_HEADING_PREFIX}{import_heading_key}")
             combined_config["import_headings"] = import_headings
+        if import_footers:
+            for import_footer_key in import_footers:
+                combined_config.pop(f"{IMPORT_FOOTER_PREFIX}{import_footer_key}")
+            combined_config["import_footers"] = import_footers
 
         unsupported_config_errors = {}
         for option in set(combined_config.keys()).difference(
@@ -653,6 +665,14 @@ def section_comments(self) -> Tuple[str, ...]:
         self._section_comments = tuple(f"# {heading}" for heading in self.import_headings.values())
         return self._section_comments
 
+    @property
+    def section_comments_end(self) -> Tuple[str, ...]:
+        if self._section_comments_end is not None:
+            return self._section_comments_end
+
+        self._section_comments_end = tuple(f"# {footer}" for footer in self.import_footers.values())
+        return self._section_comments_end
+
     @property
     def skips(self) -> FrozenSet[str]:
         if self._skips is not None:

tests/integration/test_hypothesmith.py

@@ -40,6 +40,7 @@ def configs(**force_strategies: st.SearchStrategy) -> st.SearchStrategy[isort.Co
         "sections",
         "known_future_library",
         "forced_separate",
+        "lines_before_imports",
         "lines_after_imports",
         "lines_between_sections",
         "lines_between_types",

tests/integration/test_setting_combinations.py

@@ -29,6 +29,7 @@ def configs() -> st.SearchStrategy[isort.Config]:
         "known_local_folder",
         "extra_standard_library",
         "forced_separate",
+        "lines_before_imports",
         "lines_after_imports",
         "add_imports",
         "lines_between_sections",
@@ -553,10 +554,12 @@ def _raise(*a):
         ),
         default_section="THIRDPARTY",
         import_headings={},
+        import_footers={},
         balanced_wrapping=False,
         use_parentheses=True,
         order_by_type=True,
         atomic=False,
+        lines_before_imports=-1,
         lines_after_imports=-1,
         lines_between_sections=1,
         lines_between_types=0,
@@ -859,10 +862,12 @@ def _raise(*a):
                 "single_line_exclusions": (),
                 "default_section": "THIRDPARTY",
                 "import_headings": {},
+                "import_footers": {},
                 "balanced_wrapping": False,
                 "use_parentheses": False,
                 "order_by_type": True,
                 "atomic": False,
+                "lines_before_imports": -1,
                 "lines_after_imports": -1,
                 "lines_between_sections": 1,
                 "lines_between_types": 0,
@@ -1414,10 +1419,12 @@ def test_isort_is_idempotent(config: isort.Config, disregard_skip: bool) -> None
         ),
         default_section="THIRDPARTY",
         import_headings={},
+        import_footers={},
         balanced_wrapping=False,
         use_parentheses=True,
         order_by_type=True,
         atomic=False,
+        lines_before_imports=-1,
         lines_after_imports=-1,
         lines_between_sections=1,
         lines_between_types=0,
@@ -1720,10 +1727,12 @@ def test_isort_is_idempotent(config: isort.Config, disregard_skip: bool) -> None
                 "single_line_exclusions": (),
                 "default_section": "THIRDPARTY",
                 "import_headings": {},
+                "import_footers": {},
                 "balanced_wrapping": False,
                 "use_parentheses": False,
                 "order_by_type": True,
                 "atomic": False,
+                "lines_before_imports": -1,
                 "lines_after_imports": -1,
                 "lines_between_sections": 1,
                 "lines_between_types": 0,

tests/unit/test_isort.py

@@ -1356,6 +1356,163 @@ def test_titled_imports() -> None:
     )
 
 
+def test_footered_imports() -> None:
+    """Tests setting both custom titles and footers to import sections."""
+    test_input = (
+        "import sys\n"
+        "import unicodedata\n"
+        "import statistics\n"
+        "import os\n"
+        "import myproject.test\n"
+        "import django.settings"
+    )
+    test_output = isort.code(
+        code=test_input,
+        known_first_party=["myproject"],
+        import_footer_stdlib="Standard Library End",
+        import_footer_firstparty="My Stuff End",
+    )
+    assert test_output == (
+        "import os\n"
+        "import statistics\n"
+        "import sys\n"
+        "import unicodedata\n"
+        "\n"
+        "# Standard Library End\n"
+        "\n"
+        "import django.settings\n"
+        "\n"
+        "import myproject.test\n"
+        "\n"
+        "# My Stuff End\n"
+    )
+    test_second_run = isort.code(
+        code=test_output,
+        known_first_party=["myproject"],
+        import_footer_stdlib="Standard Library End",
+        import_footer_firstparty="My Stuff End",
+    )
+    assert test_second_run == test_output
+
+    test_input_lines_down = (
+        "# comment 1\n"
+        "import django.settings\n"
+        "\n"
+        "import sys\n"
+        "import unicodedata\n"
+        "import statistics\n"
+        "import os\n"
+        "import myproject.test\n"
+        "\n"
+        "# Standard Library End\n"
+    )
+    test_output_lines_down = isort.code(
+        code=test_input_lines_down,
+        known_first_party=["myproject"],
+        import_footer_stdlib="Standard Library End",
+        import_footer_firstparty="My Stuff End",
+    )
+    assert test_output_lines_down == (
+        "# comment 1\n"
+        "import os\n"
+        "import statistics\n"
+        "import sys\n"
+        "import unicodedata\n"
+        "\n"
+        "# Standard Library End\n"
+        "\n"
+        "import django.settings\n"
+        "\n"
+        "import myproject.test\n"
+        "\n"
+        "# My Stuff End\n"
+    )
+
+
+def test_titled_and_footered_imports() -> None:
+    """Tests setting custom footers to import sections."""
+    test_input = (
+        "import sys\n"
+        "import unicodedata\n"
+        "import statistics\n"
+        "import os\n"
+        "import myproject.test\n"
+        "import django.settings"
+    )
+    test_output = isort.code(
+        code=test_input,
+        known_first_party=["myproject"],
+        import_heading_stdlib="Standard Library",
+        import_heading_firstparty="My Stuff",
+        import_footer_stdlib="Standard Library End",
+        import_footer_firstparty="My Stuff End",
+    )
+    assert test_output == (
+        "# Standard Library\n"
+        "import os\n"
+        "import statistics\n"
+        "import sys\n"
+        "import unicodedata\n"
+        "\n"
+        "# Standard Library End\n"
+        "\n"
+        "import django.settings\n"
+        "\n"
+        "# My Stuff\n"
+        "import myproject.test\n"
+        "\n"
+        "# My Stuff End\n"
+    )
+    test_second_run = isort.code(
+        code=test_output,
+        known_first_party=["myproject"],
+        import_heading_stdlib="Standard Library",
+        import_heading_firstparty="My Stuff",
+        import_footer_stdlib="Standard Library End",
+        import_footer_firstparty="My Stuff End",
+    )
+    assert test_second_run == test_output
+
+    test_input_lines_down = (
+        "# comment 1\n"
+        "import django.settings\n"
+        "\n"
+        "# Standard Library\n"
+        "import sys\n"
+        "import unicodedata\n"
+        "import statistics\n"
+        "import os\n"
+        "import myproject.test\n"
+        "\n"
+        "# Standard Library End\n"
+    )
+    test_output_lines_down = isort.code(
+        code=test_input_lines_down,
+        known_first_party=["myproject"],
+        import_heading_stdlib="Standard Library",
+        import_heading_firstparty="My Stuff",
+        import_footer_stdlib="Standard Library End",
+        import_footer_firstparty="My Stuff End",
+    )
+    assert test_output_lines_down == (
+        "# comment 1\n"
+        "# Standard Library\n"
+        "import os\n"
+        "import statistics\n"
+        "import sys\n"
+        "import unicodedata\n"
+        "\n"
+        "# Standard Library End\n"
+        "\n"
+        "import django.settings\n"
+        "\n"
+        "# My Stuff\n"
+        "import myproject.test\n"
+        "\n"
+        "# My Stuff End\n"
+    )
+
+
 def test_balanced_wrapping() -> None:
     """Tests balanced wrapping mode, where the length of individual lines maintain width."""
     test_input = (
@@ -1473,6 +1630,19 @@ def test_order_by_type() -> None:
     )
 
 
+def test_custom_lines_before_import_section() -> None:
+    """Test the case where the number of lines to output after imports has been explicitly set."""
+    test_input = "from a import b\nfrom c import d\nfoo = 'bar'\n"
+
+    # default case is no line added before the import
+    assert isort.code(test_input) == ("from a import b\nfrom c import d\n\nfoo = 'bar'\n")
+
+    # test again with a custom number of lines before the import section
+    assert isort.code(test_input, lines_before_imports=2) == (
+        "\n\nfrom a import b\nfrom c import d\n\nfoo = 'bar'\n"
+    )
+
+
 def test_custom_lines_after_import_section() -> None:
     """Test the case where the number of lines to output after imports has been explicitly set."""
     test_input = "from a import b\nfoo = 'bar'\n"