src/black/parsing.py

   1 """
   2 Parse Python code and perform AST validation.
   3 """
   4 import ast
   5 import platform
   6 import sys
   7 from typing import Any, Iterable, Iterator, List, Set, Tuple, Type, Union
   8
   9 if sys.version_info < (3, 8):
  10     from typing_extensions import Final
  11 else:
  12     from typing import Final
  13
  14 # lib2to3 fork
  15 from blib2to3.pytree import Node, Leaf
  16 from blib2to3 import pygram
  17 from blib2to3.pgen2 import driver
  18 from blib2to3.pgen2.grammar import Grammar
  19 from blib2to3.pgen2.parse import ParseError
  20 from blib2to3.pgen2.tokenize import TokenError
  21
  22 from black.mode import TargetVersion, Feature, supports_feature
  23 from black.nodes import syms
  24
  25 ast3: Any
  26 ast27: Any
  27
  28 _IS_PYPY = platform.python_implementation() == "PyPy"
  29
  30 try:
  31     from typed_ast import ast3, ast27
  32 except ImportError:
  33     # Either our python version is too low, or we're on pypy
  34     if sys.version_info < (3, 7) or (sys.version_info < (3, 8) and not _IS_PYPY):
  35         print(
  36             "The typed_ast package is required but not installed.\n"
  37             "You can upgrade to Python 3.8+ or install typed_ast with\n"
  38             "`python3 -m pip install typed-ast`.",
  39             file=sys.stderr,
  40         )
  41         sys.exit(1)
  42     else:
  43         ast3 = ast27 = ast
  44
  45
  46 PY310_HINT: Final[
  47     str
  48 ] = "Consider using --target-version py310 to parse Python 3.10 code."
  49
  50
  51 class InvalidInput(ValueError):
  52     """Raised when input source code fails all parse attempts."""
  53
  54
  55 def get_grammars(target_versions: Set[TargetVersion]) -> List[Grammar]:
  56     if not target_versions:
  57         # No target_version specified, so try all grammars.
  58         return [
  59             # Python 3.7+
  60             pygram.python_grammar_no_print_statement_no_exec_statement_async_keywords,
  61             # Python 3.0-3.6
  62             pygram.python_grammar_no_print_statement_no_exec_statement,
  63             # Python 2.7 with future print_function import
  64             pygram.python_grammar_no_print_statement,
  65             # Python 2.7
  66             pygram.python_grammar,
  67         ]
  68
  69     if all(version.is_python2() for version in target_versions):
  70         # Python 2-only code, so try Python 2 grammars.
  71         return [
  72             # Python 2.7 with future print_function import
  73             pygram.python_grammar_no_print_statement,
  74             # Python 2.7
  75             pygram.python_grammar,
  76         ]
  77
  78     # Python 3-compatible code, so only try Python 3 grammar.
  79     grammars = []
  80     if supports_feature(target_versions, Feature.PATTERN_MATCHING):
  81         # Python 3.10+
  82         grammars.append(pygram.python_grammar_soft_keywords)
  83     # If we have to parse both, try to parse async as a keyword first
  84     if not supports_feature(
  85         target_versions, Feature.ASYNC_IDENTIFIERS
  86     ) and not supports_feature(target_versions, Feature.PATTERN_MATCHING):
  87         # Python 3.7-3.9
  88         grammars.append(
  89             pygram.python_grammar_no_print_statement_no_exec_statement_async_keywords
  90         )
  91     if not supports_feature(target_versions, Feature.ASYNC_KEYWORDS):
  92         # Python 3.0-3.6
  93         grammars.append(pygram.python_grammar_no_print_statement_no_exec_statement)
  94     # At least one of the above branches must have been taken, because every Python
  95     # version has exactly one of the two 'ASYNC_*' flags
  96     return grammars
  97
  98
  99 def lib2to3_parse(src_txt: str, target_versions: Iterable[TargetVersion] = ()) -> Node:
 100     """Given a string with source, return the lib2to3 Node."""
 101     if not src_txt.endswith("\n"):
 102         src_txt += "\n"
 103
 104     grammars = get_grammars(set(target_versions))
 105     for grammar in grammars:
 106         drv = driver.Driver(grammar)
 107         try:
 108             result = drv.parse_string(src_txt, True)
 109             break
 110
 111         except ParseError as pe:
 112             lineno, column = pe.context[1]
 113             lines = src_txt.splitlines()
 114             try:
 115                 faulty_line = lines[lineno - 1]
 116             except IndexError:
 117                 faulty_line = "<line number missing in source>"
 118             exc = InvalidInput(f"Cannot parse: {lineno}:{column}: {faulty_line}")
 119
 120         except TokenError as te:
 121             # In edge cases these are raised; and typically don't have a "faulty_line".
 122             lineno, column = te.args[1]
 123             exc = InvalidInput(f"Cannot parse: {lineno}:{column}: {te.args[0]}")
 124
 125     else:
 126         if pygram.python_grammar_soft_keywords not in grammars and matches_grammar(
 127             src_txt, pygram.python_grammar_soft_keywords
 128         ):
 129             original_msg = exc.args[0]
 130             msg = f"{original_msg}\n{PY310_HINT}"
 131             raise InvalidInput(msg) from None
 132         raise exc from None
 133
 134     if isinstance(result, Leaf):
 135         result = Node(syms.file_input, [result])
 136     return result
 137
 138
 139 def matches_grammar(src_txt: str, grammar: Grammar) -> bool:
 140     drv = driver.Driver(grammar)
 141     try:
 142         drv.parse_string(src_txt, True)
 143     except (ParseError, TokenError, IndentationError):
 144         return False
 145     else:
 146         return True
 147
 148
 149 def lib2to3_unparse(node: Node) -> str:
 150     """Given a lib2to3 node, return its string representation."""
 151     code = str(node)
 152     return code
 153
 154
 155 def parse_single_version(
 156     src: str, version: Tuple[int, int]
 157 ) -> Union[ast.AST, ast3.AST, ast27.AST]:
 158     filename = "<unknown>"
 159     # typed_ast is needed because of feature version limitations in the builtin ast
 160     if sys.version_info >= (3, 8) and version >= (3,):
 161         return ast.parse(src, filename, feature_version=version)
 162     elif version >= (3,):
 163         if _IS_PYPY:
 164             return ast3.parse(src, filename)
 165         else:
 166             return ast3.parse(src, filename, feature_version=version[1])
 167     elif version == (2, 7):
 168         return ast27.parse(src)
 169     raise AssertionError("INTERNAL ERROR: Tried parsing unsupported Python version!")
 170
 171
 172 def parse_ast(src: str) -> Union[ast.AST, ast3.AST, ast27.AST]:
 173     # TODO: support Python 4+ ;)
 174     versions = [(3, minor) for minor in range(3, sys.version_info[1] + 1)]
 175
 176     if ast27.__name__ != "ast":
 177         versions.append((2, 7))
 178
 179     first_error = ""
 180     for version in sorted(versions, reverse=True):
 181         try:
 182             return parse_single_version(src, version)
 183         except SyntaxError as e:
 184             if not first_error:
 185                 first_error = str(e)
 186
 187     raise SyntaxError(first_error)
 188
 189
 190 ast3_AST: Final[Type[ast3.AST]] = ast3.AST
 191 ast27_AST: Final[Type[ast27.AST]] = ast27.AST
 192
 193
 194 def stringify_ast(
 195     node: Union[ast.AST, ast3.AST, ast27.AST], depth: int = 0
 196 ) -> Iterator[str]:
 197     """Simple visitor generating strings to compare ASTs by content."""
 198
 199     node = fixup_ast_constants(node)
 200
 201     yield f"{'  ' * depth}{node.__class__.__name__}("
 202
 203     type_ignore_classes: Tuple[Type[Any], ...]
 204     for field in sorted(node._fields):  # noqa: F402
 205         # TypeIgnore will not be present using pypy < 3.8, so need for this
 206         if not (_IS_PYPY and sys.version_info < (3, 8)):
 207             # TypeIgnore has only one field 'lineno' which breaks this comparison
 208             type_ignore_classes = (ast3.TypeIgnore, ast27.TypeIgnore)
 209             if sys.version_info >= (3, 8):
 210                 type_ignore_classes += (ast.TypeIgnore,)
 211             if isinstance(node, type_ignore_classes):
 212                 break
 213
 214         try:
 215             value = getattr(node, field)
 216         except AttributeError:
 217             continue
 218
 219         yield f"{'  ' * (depth+1)}{field}="
 220
 221         if isinstance(value, list):
 222             for item in value:
 223                 # Ignore nested tuples within del statements, because we may insert
 224                 # parentheses and they change the AST.
 225                 if (
 226                     field == "targets"
 227                     and isinstance(node, (ast.Delete, ast3.Delete, ast27.Delete))
 228                     and isinstance(item, (ast.Tuple, ast3.Tuple, ast27.Tuple))
 229                 ):
 230                     for item in item.elts:
 231                         yield from stringify_ast(item, depth + 2)
 232
 233                 elif isinstance(item, (ast.AST, ast3.AST, ast27.AST)):
 234                     yield from stringify_ast(item, depth + 2)
 235
 236         # Note that we are referencing the typed-ast ASTs via global variables and not
 237         # direct module attribute accesses because that breaks mypyc. It's probably
 238         # something to do with the ast3 / ast27 variables being marked as Any leading
 239         # mypy to think this branch is always taken, leaving the rest of the code
 240         # unanalyzed. Tighting up the types for the typed-ast AST types avoids the
 241         # mypyc crash.
 242         elif isinstance(value, (ast.AST, ast3_AST, ast27_AST)):
 243             yield from stringify_ast(value, depth + 2)
 244
 245         else:
 246             # Constant strings may be indented across newlines, if they are
 247             # docstrings; fold spaces after newlines when comparing. Similarly,
 248             # trailing and leading space may be removed.
 249             # Note that when formatting Python 2 code, at least with Windows
 250             # line-endings, docstrings can end up here as bytes instead of
 251             # str so make sure that we handle both cases.
 252             if (
 253                 isinstance(node, ast.Constant)
 254                 and field == "value"
 255                 and isinstance(value, (str, bytes))
 256             ):
 257                 lineend = "\n" if isinstance(value, str) else b"\n"
 258                 # To normalize, we strip any leading and trailing space from
 259                 # each line...
 260                 stripped = [line.strip() for line in value.splitlines()]
 261                 normalized = lineend.join(stripped)  # type: ignore[attr-defined]
 262                 # ...and remove any blank lines at the beginning and end of
 263                 # the whole string
 264                 normalized = normalized.strip()
 265             else:
 266                 normalized = value
 267             yield f"{'  ' * (depth+2)}{normalized!r},  # {value.__class__.__name__}"
 268
 269     yield f"{'  ' * depth})  # /{node.__class__.__name__}"
 270
 271
 272 def fixup_ast_constants(
 273     node: Union[ast.AST, ast3.AST, ast27.AST]
 274 ) -> Union[ast.AST, ast3.AST, ast27.AST]:
 275     """Map ast nodes deprecated in 3.8 to Constant."""
 276     if isinstance(node, (ast.Str, ast3.Str, ast27.Str, ast.Bytes, ast3.Bytes)):
 277         return ast.Constant(value=node.s)
 278
 279     if isinstance(node, (ast.Num, ast3.Num, ast27.Num)):
 280         return ast.Constant(value=node.n)
 281
 282     if isinstance(node, (ast.NameConstant, ast3.NameConstant)):
 283         return ast.Constant(value=node.value)
 284
 285     return node