implement and test module level dunders

Author: clavedeluna

isort/core.py

@@ -196,7 +196,7 @@ def process(
                 first_comment_index_end = index - 1
 
             was_in_quote = bool(in_quote)
-            if (not stripped_line.startswith("#") or in_quote) and '"' in line or "'" in line:
+            if not is_module_dunder(stripped_line) and (not stripped_line.startswith("#") or in_quote) and ('"' in line or "'" in line):
                 char_index = 0
                 if first_comment_index_start == -1 and (
                     line.startswith('"') or line.startswith("'")
@@ -290,14 +290,24 @@ def process(
                 ):
                     import_section += line
                 elif is_module_dunder(stripped_line):
-                    import_section += line
+                    # Handle module-level dunders.
+                    dunder_statement = line
+                    if stripped_line.endswith(("\\", "[", '= """', "= '''")):
+                        # Handle multiline module dunder assignments.
+                        while stripped_line and not stripped_line.endswith("]") and stripped_line != '"""' and stripped_line != "'''":
+                            line = input_stream.readline()
+                            stripped_line = line.strip()
+                            dunder_statement += line
+                    import_section += dunder_statement
+
                 elif stripped_line.startswith(IMPORT_START_IDENTIFIERS):
                     new_indent = line[: -len(line.lstrip())]
                     import_statement = line
                     stripped_line = line.strip().split("#")[0]
                     while stripped_line.endswith("\\") or (
                         "(" in stripped_line and ")" not in stripped_line
                     ):
+                        # Handle multiline import statements.
                         if stripped_line.endswith("\\"):
                             while stripped_line and stripped_line.endswith("\\"):
                                 line = input_stream.readline()

isort/output.py

@@ -34,9 +34,12 @@ def sorted_imports(
         parsed.imports["no_sections"] = {"straight": {}, "from": {}}
         base_sections: Tuple[str, ...] = ()
         for section in sections:
+            if section == "DUNDER":
+                continue
             if section == "FUTURE":
                 base_sections = ("FUTURE",)
                 continue
+
             parsed.imports["no_sections"]["straight"].update(
                 parsed.imports[section].get("straight", {})
             )
@@ -49,8 +52,9 @@ def sorted_imports(
 
     for section in sections:
         if section == "DUNDER":
-            output += [""] * config.lines_between_sections
-            output.extend(parsed.module_dunders)
+            if parsed.module_dunders:
+                output += [""] * config.lines_between_sections
+                output.extend(parsed.module_dunders)
             continue
 
         straight_modules = parsed.imports[section]["straight"]

isort/parse.py

@@ -191,6 +191,17 @@ def file_contents(contents: str, config: Config = DEFAULT_CONFIG) -> ParsedConte
     while index < line_count:
         line = in_lines[index]
         index += 1
+
+        if is_module_dunder(line):
+            dunder_statement = line
+            if line.endswith(("\\", "[", '= """', "= '''")):
+                while index < line_count and line and not line.endswith("]") and line != '"""' and line != "'''":
+                    line = in_lines[index]
+                    index += 1
+                    dunder_statement += "\n" + line
+            module_dunders.append(dunder_statement)
+            continue
+
         statement_index = index
         (skipping_line, in_quote) = skip_line(
             line, in_quote=in_quote, index=index, section_comments=config.section_comments
@@ -272,11 +283,6 @@ def file_contents(contents: str, config: Config = DEFAULT_CONFIG) -> ParsedConte
         for statement in statements:
             line, raw_line = _normalize_line(statement)
             raw_lines = [raw_line]
-
-            if is_module_dunder(statement):
-                module_dunders.append(statement)
-                continue
-
             type_of_import = import_type(line, config) or ""
 
             if not type_of_import:

tests/unit/profiles/test_attrs.py

@@ -9,6 +9,8 @@ def test_attrs_code_snippet_one():
     attrs_isort_test(
         """from __future__ import absolute_import, division, print_function
 
+__version__ = "20.2.0.dev0"
+
 import sys
 
 from functools import partial
@@ -28,9 +30,6 @@ def test_attrs_code_snippet_one():
     validate,
 )
 from ._version_info import VersionInfo
-
-
-__version__ = "20.2.0.dev0"
 """
     )
 
@@ -81,12 +80,6 @@ def test_attrs_code_snippet_three():
 
 from __future__ import absolute_import, division, print_function
 
-import re
-
-from ._make import _AndValidator, and_, attrib, attrs
-from .exceptions import NotCallableError
-
-
 __all__ = [
     "and_",
     "deep_iterable",
@@ -98,5 +91,10 @@ def test_attrs_code_snippet_three():
     "optional",
     "provides",
 ]
+
+import re
+
+from ._make import _AndValidator, and_, attrib, attrs
+from .exceptions import NotCallableError
 '''
     )

tests/unit/profiles/test_open_stack.py

@@ -100,6 +100,19 @@ def test_open_stack_code_snippet_three():
 #    License for the specific language governing permissions and limitations
 #    under the License.
 
+__all__ = [
+    'init',
+    'cleanup',
+    'set_defaults',
+    'add_extra_exmods',
+    'clear_extra_exmods',
+    'get_allowed_exmods',
+    'RequestContextSerializer',
+    'get_client',
+    'get_server',
+    'get_notifier',
+]
+
 import functools
 
 from oslo_log import log as logging
@@ -115,19 +128,6 @@ def test_open_stack_code_snippet_three():
 import nova.exception
 from nova.i18n import _
 
-__all__ = [
-    'init',
-    'cleanup',
-    'set_defaults',
-    'add_extra_exmods',
-    'clear_extra_exmods',
-    'get_allowed_exmods',
-    'RequestContextSerializer',
-    'get_client',
-    'get_server',
-    'get_notifier',
-]
-
 profiler = importutils.try_import("osprofiler.profiler")
 """,
         known_first_party=["nova"],

tests/unit/test_isort.py

@@ -5593,7 +5593,7 @@ def test_infinite_loop_in_unmatched_parenthesis() -> None:
     assert isort.code(test_input) == "from os import path, walk\n"
 
 
-def test_dunder_imports() -> None:
+def test_dunders() -> None:
     """Test to ensure dunder imports are in the correct location."""
     test_input = """from __future__ import division
 
@@ -5616,3 +5616,37 @@ def test_dunder_imports() -> None:
 """
     assert isort.code(test_input) == expected_output
 
+def test_multiline_dunders() -> None:
+    """Test to ensure isort correctly handles multiline dunders"""
+    test_input = """from __future__ import division
+
+import os
+import sys
+
+__all__ = [
+    "one",
+    "two",
+]
+__version__ = '0.1'
+__author__ = '''
+	first name
+	last name
+'''
+"""
+
+    expected_output = """from __future__ import division
+
+__all__ = [
+    "one",
+    "two",
+]
+__version__ = '0.1'
+__author__ = '''
+	first name
+	last name
+'''
+
+import os
+import sys
+"""
+    assert isort.code(test_input) == expected_output

tests/unit/test_parse.py

@@ -33,6 +33,7 @@ def test_file_contents():
         _,
         _,
         _,
+        _,
         change_count,
         original_line_count,
         _,