Fix CI for Click typing issue (#3770)

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

diff --git a/src/black/handle_ipynb_magics.py b/src/black/handle_ipynb_magics.py
index 2fe6739209dd626597a43011b8bc576ae203cc9a..4324819beaf6e584f791950a666b176355f28145 100644 (file)
--- a/src/black/handle_ipynb_magics.py
+++ b/src/black/handle_ipynb_magics.py
@@ -1,22 +1,20 @@
 """Functions to process IPython magics with."""
 
 """Functions to process IPython magics with."""
 

-from functools import lru_cache
-import dataclasses

 import ast
 import ast

-from typing import Dict, List, Tuple, Optional
-
+import collections
+import dataclasses

 import secrets
 import sys
 import secrets
 import sys

-import collections
+from functools import lru_cache
+from typing import Dict, List, Optional, Tuple

 
 if sys.version_info >= (3, 10):
     from typing import TypeGuard
 else:
     from typing_extensions import TypeGuard
 
 
 if sys.version_info >= (3, 10):
     from typing import TypeGuard
 else:
     from typing_extensions import TypeGuard
 

-from black.report import NothingChanged

 from black.output import out
 from black.output import out

-
+from black.report import NothingChanged

 
 TRANSFORMED_MAGICS = frozenset(
     (
 
 TRANSFORMED_MAGICS = frozenset(
     (


@@ -37,20 +35,15 @@ TOKENS_TO_IGNORE = frozenset(
         "ESCAPED_NL",
     )
 )
         "ESCAPED_NL",
     )
 )

-NON_PYTHON_CELL_MAGICS = frozenset(
+PYTHON_CELL_MAGICS = frozenset(

     (
     (

-        "bash",
-        "html",
-        "javascript",
-        "js",
-        "latex",
-        "markdown",
-        "perl",
-        "ruby",
-        "script",
-        "sh",
-        "svg",
-        "writefile",
+        "capture",
+        "prun",
+        "pypy",
+        "python",
+        "python3",
+        "time",
+        "timeit",

     )
 )
 TOKEN_HEX = secrets.token_hex
     )
 )
 TOKEN_HEX = secrets.token_hex


@@ -65,13 +58,18 @@ class Replacement:
 @lru_cache()
 def jupyter_dependencies_are_installed(*, verbose: bool, quiet: bool) -> bool:
     try:
 @lru_cache()
 def jupyter_dependencies_are_installed(*, verbose: bool, quiet: bool) -> bool:
     try:

-        import IPython  # noqa:F401
+        # isort: off
+        # tokenize_rt is less commonly installed than IPython
+        # and IPython is expensive to import

         import tokenize_rt  # noqa:F401
         import tokenize_rt  # noqa:F401

+        import IPython  # noqa:F401
+
+        # isort: on

     except ModuleNotFoundError:
         if verbose or not quiet:
             msg = (
                 "Skipping .ipynb files as Jupyter dependencies are not installed.\n"
     except ModuleNotFoundError:
         if verbose or not quiet:
             msg = (
                 "Skipping .ipynb files as Jupyter dependencies are not installed.\n"

-                "You can fix this by running ``pip install black[jupyter]``"
+                'You can fix this by running ``pip install "black[jupyter]"``'

             )
             out(msg)
         return False
             )
             out(msg)
         return False


@@ -95,11 +93,7 @@ def remove_trailing_semicolon(src: str) -> Tuple[str, bool]:
     Mirrors the logic in `quiet` from `IPython.core.displayhook`, but uses
     ``tokenize_rt`` so that round-tripping works fine.
     """
     Mirrors the logic in `quiet` from `IPython.core.displayhook`, but uses
     ``tokenize_rt`` so that round-tripping works fine.
     """

-    from tokenize_rt import (
-        src_to_tokens,
-        tokens_to_src,
-        reversed_enumerate,
-    )
+    from tokenize_rt import reversed_enumerate, src_to_tokens, tokens_to_src

 
     tokens = src_to_tokens(src)
     trailing_semicolon = False
 
     tokens = src_to_tokens(src)
     trailing_semicolon = False


@@ -123,7 +117,7 @@ def put_trailing_semicolon_back(src: str, has_trailing_semicolon: bool) -> str:
     """
     if not has_trailing_semicolon:
         return src
     """
     if not has_trailing_semicolon:
         return src

-    from tokenize_rt import src_to_tokens, tokens_to_src, reversed_enumerate
+    from tokenize_rt import reversed_enumerate, src_to_tokens, tokens_to_src

 
     tokens = src_to_tokens(src)
     for idx, token in reversed_enumerate(tokens):
 
     tokens = src_to_tokens(src)
     for idx, token in reversed_enumerate(tokens):


@@ -230,8 +224,6 @@ def replace_cell_magics(src: str) -> Tuple[str, List[Replacement]]:
     cell_magic_finder.visit(tree)
     if cell_magic_finder.cell_magic is None:
         return src, replacements
     cell_magic_finder.visit(tree)
     if cell_magic_finder.cell_magic is None:
         return src, replacements

-    if cell_magic_finder.cell_magic.name in NON_PYTHON_CELL_MAGICS:
-        raise NothingChanged

     header = cell_magic_finder.cell_magic.header
     mask = get_token(src, header)
     replacements.append(Replacement(mask=mask, src=header))
     header = cell_magic_finder.cell_magic.header
     mask = get_token(src, header)
     replacements.append(Replacement(mask=mask, src=header))


@@ -343,7 +335,8 @@ class CellMagicFinder(ast.NodeVisitor):
 
     For example,
 
 
     For example,
 

-        %%time\nfoo()
+        %%time\n
+        foo()

 
     would have been transformed to
 
 
     would have been transformed to
 


@@ -403,20 +396,28 @@ class MagicFinder(ast.NodeVisitor):
         For example,
 
             black_version = !black --version
         For example,
 
             black_version = !black --version

+            env = %env var

 
 

-        would have been transformed to
+        would have been (respectively) transformed to

 
             black_version = get_ipython().getoutput('black --version')
 
             black_version = get_ipython().getoutput('black --version')

+            env = get_ipython().run_line_magic('env', 'var')

 
 

-        and we look for instances of the latter.
+        and we look for instances of any of the latter.

         """
         """

-        if (
-            isinstance(node.value, ast.Call)
-            and _is_ipython_magic(node.value.func)
-            and node.value.func.attr == "getoutput"
-        ):
-            (arg,) = _get_str_args(node.value.args)
-            src = f"!{arg}"
+        if isinstance(node.value, ast.Call) and _is_ipython_magic(node.value.func):
+            args = _get_str_args(node.value.args)
+            if node.value.func.attr == "getoutput":
+                src = f"!{args[0]}"
+            elif node.value.func.attr == "run_line_magic":
+                src = f"%{args[0]}"
+                if args[1]:
+                    src += f" {args[1]}"
+            else:
+                raise AssertionError(
+                    f"Unexpected IPython magic {node.value.func.attr!r} found. "
+                    "Please report a bug on https://github.com/psf/black/issues."
+                ) from None

             self.magics[node.value.lineno].append(
                 OffsetAndMagic(node.value.col_offset, src)
             )
             self.magics[node.value.lineno].append(
                 OffsetAndMagic(node.value.col_offset, src)
             )


@@ -451,7 +452,6 @@ class MagicFinder(ast.NodeVisitor):
                 else:
                     src = f"%{args[0]}"
                     if args[1]:
                 else:
                     src = f"%{args[0]}"
                     if args[1]:

-                        assert src is not None

                         src += f" {args[1]}"
             elif node.value.func.attr == "system":
                 src = f"!{args[0]}"
                         src += f" {args[1]}"
             elif node.value.func.attr == "system":
                 src = f"!{args[0]}"