Update documentation regarding isort compatibility (#3567)

[etc/vim.git] / src / blib2to3 / pytree.py

diff --git a/src/blib2to3/pytree.py b/src/blib2to3/pytree.py
index 001652df09fb85d623ede558f75a2ea102549e4e..ea60c894e20490fd37f028f6e38e08be767ce761 100644 (file)
--- a/src/blib2to3/pytree.py
+++ b/src/blib2to3/pytree.py
@@ -10,11 +10,10 @@ even the comments and whitespace between tokens.
 There's also a pattern matching implementation here.
 """
 
 There's also a pattern matching implementation here.
 """
 

-# mypy: allow-untyped-defs
+# mypy: allow-untyped-defs, allow-incomplete-defs

 
 from typing import (
     Any,
 
 from typing import (
     Any,

-    Callable,

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


@@ -92,8 +91,6 @@ class Base(object):
             return NotImplemented
         return self._eq(other)
 
             return NotImplemented
         return self._eq(other)
 

-    __hash__ = None  # type: Any  # For Py3 compatibility.
-

     @property
     def prefix(self) -> Text:
         raise NotImplementedError
     @property
     def prefix(self) -> Text:
         raise NotImplementedError


@@ -294,7 +291,7 @@ class Node(Base):
         """
         return "".join(map(str, self.children))
 
         """
         return "".join(map(str, self.children))
 

-    def _eq(self, other) -> bool:
+    def _eq(self, other: Base) -> bool:

         """Compare two nodes for equality."""
         return (self.type, self.children) == (other.type, other.children)
 
         """Compare two nodes for equality."""
         return (self.type, self.children) == (other.type, other.children)
 


@@ -329,7 +326,7 @@ class Node(Base):
         return self.children[0].prefix
 
     @prefix.setter
         return self.children[0].prefix
 
     @prefix.setter

-    def prefix(self, prefix) -> None:
+    def prefix(self, prefix: Text) -> None:

         if self.children:
             self.children[0].prefix = prefix
 
         if self.children:
             self.children[0].prefix = prefix
 


@@ -389,11 +386,16 @@ class Leaf(Base):
     value: Text
     fixers_applied: List[Any]
     bracket_depth: int
     value: Text
     fixers_applied: List[Any]
     bracket_depth: int

-    opening_bracket: "Leaf"
+    # Changed later in brackets.py
+    opening_bracket: Optional["Leaf"] = None

     used_names: Optional[Set[Text]]
     _prefix = ""  # Whitespace and comments preceding this token in the input
     lineno: int = 0  # Line where this token starts in the input
     column: int = 0  # Column where this token starts in the input
     used_names: Optional[Set[Text]]
     _prefix = ""  # Whitespace and comments preceding this token in the input
     lineno: int = 0  # Line where this token starts in the input
     column: int = 0  # Column where this token starts in the input

+    # If not None, this Leaf is created by converting a block of fmt off/skip
+    # code, and `fmt_pass_converted_first_leaf` points to the first Leaf in the
+    # converted code.
+    fmt_pass_converted_first_leaf: Optional["Leaf"] = None

 
     def __init__(
         self,
 
     def __init__(
         self,


@@ -402,6 +404,8 @@ class Leaf(Base):
         context: Optional[Context] = None,
         prefix: Optional[Text] = None,
         fixers_applied: List[Any] = [],
         context: Optional[Context] = None,
         prefix: Optional[Text] = None,
         fixers_applied: List[Any] = [],

+        opening_bracket: Optional["Leaf"] = None,
+        fmt_pass_converted_first_leaf: Optional["Leaf"] = None,

     ) -> None:
         """
         Initializer.
     ) -> None:
         """
         Initializer.


@@ -419,6 +423,8 @@ class Leaf(Base):
             self._prefix = prefix
         self.fixers_applied: Optional[List[Any]] = fixers_applied[:]
         self.children = []
             self._prefix = prefix
         self.fixers_applied: Optional[List[Any]] = fixers_applied[:]
         self.children = []

+        self.opening_bracket = opening_bracket
+        self.fmt_pass_converted_first_leaf = fmt_pass_converted_first_leaf

 
     def __repr__(self) -> str:
         """Return a canonical string representation."""
 
     def __repr__(self) -> str:
         """Return a canonical string representation."""


@@ -437,9 +443,9 @@ class Leaf(Base):
 
         This reproduces the input source exactly.
         """
 
         This reproduces the input source exactly.
         """

-        return self.prefix + str(self.value)
+        return self._prefix + str(self.value)

 
 

-    def _eq(self, other) -> bool:
+    def _eq(self, other: "Leaf") -> bool:

         """Compare two nodes for equality."""
         return (self.type, self.value) == (other.type, other.value)
 
         """Compare two nodes for equality."""
         return (self.type, self.value) == (other.type, other.value)
 


@@ -472,7 +478,7 @@ class Leaf(Base):
         return self._prefix
 
     @prefix.setter
         return self._prefix
 
     @prefix.setter

-    def prefix(self, prefix) -> None:
+    def prefix(self, prefix: Text) -> None:

         self.changed()
         self._prefix = prefix
 
         self.changed()
         self._prefix = prefix
 


@@ -618,7 +624,7 @@ class LeafPattern(BasePattern):
         self.content = content
         self.name = name
 
         self.content = content
         self.name = name
 

-    def match(self, node: NL, results=None):
+    def match(self, node: NL, results=None) -> bool:

         """Override match() to insist on a leaf node."""
         if not isinstance(node, Leaf):
             return False
         """Override match() to insist on a leaf node."""
         if not isinstance(node, Leaf):
             return False


@@ -672,10 +678,13 @@ class NodePattern(BasePattern):
             newcontent = list(content)
             for i, item in enumerate(newcontent):
                 assert isinstance(item, BasePattern), (i, item)
             newcontent = list(content)
             for i, item in enumerate(newcontent):
                 assert isinstance(item, BasePattern), (i, item)

-                if isinstance(item, WildcardPattern):
-                    self.wildcards = True
+                # I don't even think this code is used anywhere, but it does cause
+                # unreachable errors from mypy. This function's signature does look
+                # odd though *shrug*.
+                if isinstance(item, WildcardPattern):  # type: ignore[unreachable]
+                    self.wildcards = True  # type: ignore[unreachable]

         self.type = type
         self.type = type

-        self.content = newcontent
+        self.content = newcontent  # TODO: this is unbound when content is None

         self.name = name
 
     def _submatch(self, node, results=None) -> bool:
         self.name = name
 
     def _submatch(self, node, results=None) -> bool:


@@ -917,7 +926,7 @@ class WildcardPattern(BasePattern):
 
 
 class NegatedPattern(BasePattern):
 
 
 class NegatedPattern(BasePattern):

-    def __init__(self, content: Optional[Any] = None) -> None:
+    def __init__(self, content: Optional[BasePattern] = None) -> None:

         """
         Initializer.
 
         """
         Initializer.
 


@@ -938,7 +947,7 @@ class NegatedPattern(BasePattern):
         # We only match an empty sequence of nodes in its entirety
         return len(nodes) == 0
 
         # We only match an empty sequence of nodes in its entirety
         return len(nodes) == 0
 

-    def generate_matches(self, nodes) -> Iterator[Tuple[int, _Results]]:
+    def generate_matches(self, nodes: List[NL]) -> Iterator[Tuple[int, _Results]]:

         if self.content is None:
             # Return a match if there is an empty sequence
             if len(nodes) == 0:
         if self.content is None:
             # Return a match if there is an empty sequence
             if len(nodes) == 0:


@@ -978,6 +987,3 @@ def generate_matches(
                     r.update(r0)
                     r.update(r1)
                     yield c0 + c1, r
                     r.update(r0)
                     r.update(r1)
                     yield c0 + c1, r

-
-
-_Convert = Callable[[Grammar, RawNode], Any]