Fix typo in config docs for --extend-exclude (#3170)

[etc/vim.git] / src / black / lines.py

diff --git a/src/black/lines.py b/src/black/lines.py
index 63225c0e6d31288bd7c68004e751eb05ca537382..8b591c324a5da6a27fc7fb7613f2900df2da9b7b 100644 (file)
--- a/src/black/lines.py
+++ b/src/black/lines.py
@@ -3,7 +3,6 @@ import itertools
 import sys
 from typing import (
     Callable,
 import sys
 from typing import (
     Callable,

-    Collection,

     Dict,
     Iterator,
     List,
     Dict,
     Iterator,
     List,


@@ -18,12 +17,12 @@ from blib2to3.pytree import Node, Leaf
 from blib2to3.pgen2 import token
 
 from black.brackets import BracketTracker, DOT_PRIORITY
 from blib2to3.pgen2 import token
 
 from black.brackets import BracketTracker, DOT_PRIORITY

-from black.mode import Mode
+from black.mode import Mode, Preview

 from black.nodes import STANDALONE_COMMENT, TEST_DESCENDANTS
 from black.nodes import BRACKETS, OPENING_BRACKETS, CLOSING_BRACKETS
 from black.nodes import syms, whitespace, replace_child, child_towards
 from black.nodes import STANDALONE_COMMENT, TEST_DESCENDANTS
 from black.nodes import BRACKETS, OPENING_BRACKETS, CLOSING_BRACKETS
 from black.nodes import syms, whitespace, replace_child, child_towards

-from black.nodes import is_multiline_string, is_import, is_type_comment, last_two_except
-from black.nodes import is_one_tuple_between
+from black.nodes import is_multiline_string, is_import, is_type_comment
+from black.nodes import is_one_sequence_between

 
 # types
 T = TypeVar("T")
 
 # types
 T = TypeVar("T")


@@ -169,6 +168,13 @@ class Line:
             and self.leaves[0].value.startswith(('"""', "'''"))
         )
 
             and self.leaves[0].value.startswith(('"""', "'''"))
         )
 

+    @property
+    def opens_block(self) -> bool:
+        """Does this line open a new level of indentation."""
+        if len(self.leaves) == 0:
+            return False
+        return self.leaves[-1].type == token.COLON
+

     def contains_standalone_comments(self, depth_limit: int = sys.maxsize) -> bool:
         """If so, needs to be split before emitting."""
         for leaf in self.leaves:
     def contains_standalone_comments(self, depth_limit: int = sys.maxsize) -> bool:
         """If so, needs to be split before emitting."""
         for leaf in self.leaves:


@@ -255,6 +261,7 @@ class Line:
         """Return True if we have a magic trailing comma, that is when:
         - there's a trailing comma here
         - it's not a one-tuple
         """Return True if we have a magic trailing comma, that is when:
         - there's a trailing comma here
         - it's not a one-tuple

+        - it's not a single-element subscript

         Additionally, if ensure_removable:
         - it's not from square bracket indexing
         """
         Additionally, if ensure_removable:
         - it's not from square bracket indexing
         """


@@ -269,6 +276,20 @@ class Line:
             return True
 
         if closing.type == token.RSQB:
             return True
 
         if closing.type == token.RSQB:

+            if (
+                Preview.one_element_subscript in self.mode
+                and closing.parent
+                and closing.parent.type == syms.trailer
+                and closing.opening_bracket
+                and is_one_sequence_between(
+                    closing.opening_bracket,
+                    closing,
+                    self.leaves,
+                    brackets=(token.LSQB, token.RSQB),
+                )
+            ):
+                return False
+

             if not ensure_removable:
                 return True
             comma = self.leaves[-1]
             if not ensure_removable:
                 return True
             comma = self.leaves[-1]


@@ -277,7 +298,9 @@ class Line:
         if self.is_import:
             return True
 
         if self.is_import:
             return True
 

-        if not is_one_tuple_between(closing.opening_bracket, closing, self.leaves):
+        if closing.opening_bracket is not None and not is_one_sequence_between(
+            closing.opening_bracket, closing, self.leaves
+        ):

             return True
 
         return False
             return True
 
         return False


@@ -447,11 +470,38 @@ class EmptyLineTracker:
             before = 0
         depth = current_line.depth
         while self.previous_defs and self.previous_defs[-1] >= depth:
             before = 0
         depth = current_line.depth
         while self.previous_defs and self.previous_defs[-1] >= depth:

-            self.previous_defs.pop()

             if self.is_pyi:
             if self.is_pyi:

-                before = 0 if depth else 1
+                assert self.previous_line is not None
+                if depth and not current_line.is_def and self.previous_line.is_def:
+                    # Empty lines between attributes and methods should be preserved.
+                    before = min(1, before)
+                elif depth:
+                    before = 0
+                else:
+                    before = 1

             else:
             else:

-                before = 1 if depth else 2
+                if depth:
+                    before = 1
+                elif (
+                    not depth
+                    and self.previous_defs[-1]
+                    and current_line.leaves[-1].type == token.COLON
+                    and (
+                        current_line.leaves[0].value
+                        not in ("with", "try", "for", "while", "if", "match")
+                    )
+                ):
+                    # We shouldn't add two newlines between an indented function and
+                    # a dependent non-indented clause. This is to avoid issues with
+                    # conditional function definitions that are technically top-level
+                    # and therefore get two trailing newlines, but look weird and
+                    # inconsistent when they're followed by elif, else, etc. This is
+                    # worse because these functions only get *one* preceding newline
+                    # already.
+                    before = 1
+                else:
+                    before = 2
+            self.previous_defs.pop()

         if current_line.is_decorator or current_line.is_def or current_line.is_class:
             return self._maybe_empty_lines_for_class_or_def(current_line, before)
 
         if current_line.is_decorator or current_line.is_def or current_line.is_class:
             return self._maybe_empty_lines_for_class_or_def(current_line, before)
 


@@ -470,6 +520,12 @@ class EmptyLineTracker:
         ):
             return before, 1
 
         ):
             return before, 1
 

+        if (
+            Preview.remove_block_trailing_newline in current_line.mode
+            and self.previous_line
+            and self.previous_line.opens_block
+        ):
+            return 0, 0

         return before, 0
 
     def _maybe_empty_lines_for_class_or_def(
         return before, 0
 
     def _maybe_empty_lines_for_class_or_def(


@@ -501,10 +557,12 @@ class EmptyLineTracker:
             return 0, 0
 
         if self.is_pyi:
             return 0, 0
 
         if self.is_pyi:

-            if self.previous_line.depth > current_line.depth:
-                newlines = 1
-            elif current_line.is_class or self.previous_line.is_class:
-                if current_line.is_stub_class and self.previous_line.is_stub_class:
+            if current_line.is_class or self.previous_line.is_class:
+                if self.previous_line.depth < current_line.depth:
+                    newlines = 0
+                elif self.previous_line.depth > current_line.depth:
+                    newlines = 1
+                elif current_line.is_stub_class and self.previous_line.is_stub_class:

                     # No blank line between classes with an empty body
                     newlines = 0
                 else:
                     # No blank line between classes with an empty body
                     newlines = 0
                 else:


@@ -512,15 +570,20 @@ class EmptyLineTracker:
             elif (
                 current_line.is_def or current_line.is_decorator
             ) and not self.previous_line.is_def:
             elif (
                 current_line.is_def or current_line.is_decorator
             ) and not self.previous_line.is_def:

-                # Blank line between a block of functions (maybe with preceding
-                # decorators) and a block of non-functions
+                if current_line.depth:
+                    # In classes empty lines between attributes and methods should
+                    # be preserved.
+                    newlines = min(1, before)
+                else:
+                    # Blank line between a block of functions (maybe with preceding
+                    # decorators) and a block of non-functions
+                    newlines = 1
+            elif self.previous_line.depth > current_line.depth:

                 newlines = 1
             else:
                 newlines = 0
         else:
                 newlines = 1
             else:
                 newlines = 0
         else:

-            newlines = 2
-        if current_line.depth and newlines:
-            newlines -= 1
+            newlines = 1 if current_line.depth else 2

         return newlines, 0
 
 
         return newlines, 0
 
 


@@ -609,7 +672,6 @@ def can_be_split(line: Line) -> bool:
 def can_omit_invisible_parens(
     line: Line,
     line_length: int,
 def can_omit_invisible_parens(
     line: Line,
     line_length: int,

-    omit_on_explode: Collection[LeafID] = (),

 ) -> bool:
     """Does `line` have a shape safe to reformat without optional parens around it?
 
 ) -> bool:
     """Does `line` have a shape safe to reformat without optional parens around it?
 


@@ -647,12 +709,6 @@ def can_omit_invisible_parens(
 
     penultimate = line.leaves[-2]
     last = line.leaves[-1]
 
     penultimate = line.leaves[-2]
     last = line.leaves[-1]

-    if line.magic_trailing_comma:
-        try:
-            penultimate, last = last_two_except(line.leaves, omit=omit_on_explode)
-        except LookupError:
-            # Turns out we'd omit everything.  We cannot skip the optional parentheses.
-            return False

 
     if (
         last.type == token.RPAR
 
     if (
         last.type == token.RPAR


@@ -674,10 +730,6 @@ def can_omit_invisible_parens(
             # unnecessary.
             return True
 
             # unnecessary.
             return True
 

-        if line.magic_trailing_comma and penultimate.type == token.COMMA:
-            # The rightmost non-omitted bracket pair is the one we want to explode on.
-            return True
-

         if _can_omit_closing_paren(line, last=last, line_length=line_length):
             return True
 
         if _can_omit_closing_paren(line, last=last, line_length=line_length):
             return True