review changes 1

- Added comments and Changelog
- reverted additional changes
- reverted micro optims

Author: rsb-23

CHANGES.md

@@ -120,6 +120,7 @@
   splicing the unchanged blocks into each parent's child list in a single pass rather
   than removing and re-inserting each one, which rescanned and shifted the whole child
   list on every conversion (#5213)
+- Reduce memory requirement for Node and Leaf class (#5222)
 
 ### Output
 

src/black/brackets.py

@@ -156,7 +156,7 @@ def delimiter_count_with_priority(self, priority: Priority = 0) -> int:
             return 0
 
         priority = priority or self.max_delimiter_priority()
-        return sum(p == priority for p in self.delimiters.values())
+        return sum(1 for p in self.delimiters.values() if p == priority)
 
     def maybe_increment_for_loop_variable(self, leaf: Leaf) -> bool:
         """In a for loop, or comprehension, the variables are often unpacks.

src/black/comments.py

@@ -2,7 +2,7 @@
 from collections.abc import Collection, Iterator
 from dataclasses import dataclass
 from functools import lru_cache
-from typing import Final
+from typing import Final, Union
 
 from black.mode import Mode
 from black.nodes import (
@@ -22,7 +22,7 @@
 from blib2to3.pytree import Leaf, Node
 
 # types
-LN = Leaf | Node
+LN = Union[Leaf, Node]
 
 FMT_OFF: Final = {"# fmt: off", "# fmt:off", "# yapf: disable"}
 FMT_SKIP: Final = {"# fmt: skip", "# fmt:skip"}

src/black/handle_ipynb_magics.py

@@ -460,7 +460,9 @@ def visit_Assign(self, node: ast.Assign) -> None:
             if node.value.func.attr == "getoutput":
                 src = f"!{args[0]}"
             elif node.value.func.attr == "run_line_magic":
-                src = "%" + " ".join(filter(None, args))
+                src = f"%{args[0]}"
+                if args[1]:
+                    src += f" {args[1]}"
             else:
                 raise AssertionError(
                     f"Unexpected IPython magic {node.value.func.attr!r} found. "
@@ -498,7 +500,9 @@ def visit_Expr(self, node: ast.Expr) -> None:
                 elif args[0] == "pinfo2":
                     src = f"??{args[1]}"
                 else:
-                    src = "%" + " ".join(filter(None, args))
+                    src = f"%{args[0]}"
+                    if args[1]:
+                        src += f" {args[1]}"
             elif node.value.func.attr == "system":
                 src = f"!{args[0]}"
             elif node.value.func.attr == "getoutput":

src/black/lines.py

@@ -197,9 +197,7 @@ def _is_triple_quoted_string(self) -> bool:
         if not self or self.leaves[0].type != token.STRING:
             return False
         value = self.leaves[0].value
-        if value.startswith(('"""', "'''")):
-            return True
-        return value.startswith(("r'''", 'r"""', "R'''", 'R"""'))
+        return value.startswith(('"""', "'''", "r'''", 'r"""', "R'''", 'R"""'))
 
     @property
     def is_docstring(self) -> bool:
@@ -481,9 +479,9 @@ def __str__(self) -> str:
             return "\n"
 
         indent = "    " * self.depth
-        first, *rest = self.leaves
+        first = self.leaves[0]
 
-        rest_str = "".join(map(str, rest))
+        rest_str = "".join(map(str, self.leaves[1:]))
         comments_str = "".join(
             str(comment) for group in self.comments.values() for comment in group
         )
@@ -1607,6 +1605,7 @@ def can_omit_invisible_parens(
         # a leading opening bracket and a trailing closing bracket.  If the
         # opening bracket doesn't match our rule, maybe the closing will.
 
+    penultimate = line.leaves[-2]
     last = line.leaves[-1]
 
     if (
@@ -1620,7 +1619,6 @@ def can_omit_invisible_parens(
             and last.parent.type != syms.trailer
         )
     ):
-        penultimate = line.leaves[-2]
         if penultimate.type in OPENING_BRACKETS:
             # Empty brackets don't help.
             return False

src/black/output.py

@@ -112,7 +112,9 @@ def color_diff(contents: str) -> str:
 
 
 def style_output(message: str, **styles: Any) -> str:
-    return style(message, **styles) if _color_enabled() else message
+    if not _color_enabled():
+        return message
+    return style(message, **styles)
 
 
 def _color_enabled() -> bool:

src/black/trans.py

@@ -360,7 +360,7 @@ def _get_key(string: str) -> CustomSplitMapKey:
             A unique identifier that is used internally to map @string to a
             group of custom splits.
         """
-        return id(string), string
+        return (id(string), string)
 
     def add_custom_splits(
         self, string: str, custom_splits: Iterable[CustomSplit]
@@ -1018,11 +1018,13 @@ def do_transform(
             string_parser = StringParser()
             rpar_idx = string_parser.parse(LL, string_idx)
 
-            # Should not strip parentheses which have comments attached
-            # to them.
-            should_transform = not any(
-                line.comments_after(leaf) for leaf in (LL[string_idx - 1], LL[rpar_idx])
-            )
+            should_transform = True
+            for leaf in (LL[string_idx - 1], LL[rpar_idx]):
+                if line.comments_after(leaf):
+                    # Should not strip parentheses which have comments attached
+                    # to them.
+                    should_transform = False
+                    break
             if should_transform:
                 string_and_rpar_indices.extend((string_idx, rpar_idx))
 
@@ -1358,7 +1360,7 @@ def iter_fexpr_spans(s: str) -> Iterator[tuple[int, int]]:
             j = stack.pop()
             # we've made it back out of the expression! yield the span
             if not stack:
-                yield j, i + 1
+                yield (j, i + 1)
             i += 1
             continue
 

src/blib2to3/pgen2/conv.py

@@ -168,7 +168,7 @@ def parse_graminit_c(self, filename):
         mo = re.match(r"static dfa dfas\[(\d+)\] = {$", line)
         assert mo, (lineno, line)
         ndfas = int(mo.group(1))
-        for _ in range(ndfas):
+        for i in range(ndfas):
             lineno, line = lineno + 1, next(f)
             mo = re.match(r'\s+{(\d+), "(\w+)", (\d+), (\d+), states_(\d+),$', line)
             assert mo, (lineno, line)

src/blib2to3/pgen2/pgen.py

@@ -2,13 +2,13 @@
 # Licensed to PSF under a Contributor Agreement.
 
 import os
-from collections.abc import Iterator
-from typing import IO, Any, NoReturn
+from collections.abc import Iterator, Sequence
+from typing import IO, Any, NoReturn, Union
 
 from blib2to3.pgen2 import grammar, token, tokenize
 from blib2to3.pgen2.tokenize import TokenInfo
 
-Path = str | os.PathLike[str]
+Path = Union[str, "os.PathLike[str]"]
 
 
 class PgenGrammar(grammar.Grammar):
@@ -144,7 +144,7 @@ def calcfirst(self, name: str) -> None:
                     self.calcfirst(label)
                     fset = self.first[label]
                     assert fset is not None
-                totalset |= fset
+                totalset.update(fset)
                 overlapcheck[label] = fset
             else:
                 totalset[label] = 1
@@ -374,7 +374,10 @@ def __eq__(self, other: Any) -> bool:
         # would invoke this method recursively, with cycles...
         if len(self.arcs) != len(other.arcs):
             return False
-        return all(next_ is other.arcs.get(label) for label, next_ in self.arcs.items())
+        for label, next in self.arcs.items():
+            if next is not other.arcs.get(label):
+                return False
+        return True
 
     __hash__: Any = None  # For Py3 compatibility.
 

src/blib2to3/pytree.py

@@ -65,9 +65,9 @@ class Base(ABC):
     __slots__ = ("type", "parent", "children", "was_changed")
 
     def __init__(self, type_id: int, children: Optional[list[NL]] = None):
-        self.type = type_id
-        self.children = children or []
-        self.parent: Optional["Node"] = None
+        self.type = type_id  # int: token number (< 256) or symbol number (>= 256)
+        self.children = children or []  # List of subnodes
+        self.parent: Optional["Node"] = None  # Parent node pointer, or None
         self.was_changed: bool = False
 
     def __eq__(self, other: Any) -> bool:
@@ -618,7 +618,7 @@ def match(self, node: NL, results: _Results | None = None) -> bool:
                 return False
             if r:
                 assert results is not None
-                results |= r
+                results.update(r)
         if results is not None and self.name:
             results[self.name] = node
         return True
@@ -749,7 +749,7 @@ def _submatch(self, node, results=None) -> bool:
             for c, r in generate_matches(self.content, node.children):
                 if c == len(node.children):
                     if results is not None:
-                        results |= r
+                        results.update(r)
                     return True
             return False
         if len(self.content) != len(node.children):
@@ -856,7 +856,7 @@ def match_seq(self, nodes, results=None) -> bool:
         for c, r in self.generate_matches(nodes):
             if c == len(nodes):
                 if results is not None:
-                    results |= r
+                    results.update(r)
                     if self.name:
                         results[self.name] = list(nodes)
                 return True