Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Assignment to env var in Jupyter Notebook doesn't round-trip #2642

Merged
merged 3 commits into from Nov 26, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
1 change: 1 addition & 0 deletions CHANGES.md
Expand Up @@ -6,6 +6,7 @@

- Fixed Python 3.10 support on platforms without ProcessPoolExecutor (#2631)
- Fixed `match` statements with open sequence subjects, like `match a, b:` (#2639)
- Fixed assignment to environment variables in Jupyter Notebooks (#2642)

## 21.11b1

Expand Down
27 changes: 17 additions & 10 deletions src/black/handle_ipynb_magics.py
Expand Up @@ -403,20 +403,28 @@ def visit_Assign(self, node: ast.Assign) -> None:
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')
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(
"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)
)
Expand Down Expand Up @@ -451,7 +459,6 @@ def visit_Expr(self, node: ast.Expr) -> None:
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]}"
Expand Down
4 changes: 4 additions & 0 deletions tests/test_ipynb.py
Expand Up @@ -90,6 +90,10 @@ def test_cell_magic_noop() -> None:
id="Line magic with argument",
),
pytest.param("%time\n'foo'", '%time\n"foo"', id="Line magic without argument"),
pytest.param(
"env = %env var", "env = %env var", id="Assignment to environment variable"
),
pytest.param("env = %env", "env = %env", id="Assignment to magic"),
),
)
def test_magic(src: str, expected: str) -> None:
Expand Down