X-Git-Url: https://git.madduck.net/etc/vim.git/blobdiff_plain/e0253080b0d2b61bf2105a2f5afdf5173e33d0e5..71e71e5f52e5f6bdeae63cc8c11b1bee44d11c30:/tests/test_ipynb.py?ds=sidebyside
diff --git a/tests/test_ipynb.py b/tests/test_ipynb.py
index 5ecdf00..b534d77 100644
--- a/tests/test_ipynb.py
+++ b/tests/test_ipynb.py
@@ -1,4 +1,8 @@
+from dataclasses import replace
+import pathlib
import re
+from contextlib import ExitStack as does_not_raise
+from typing import ContextManager
from click.testing import CliRunner
from black.handle_ipynb_magics import jupyter_dependencies_are_installed
@@ -12,7 +16,6 @@ from black import (
import pytest
from black import Mode
from _pytest.monkeypatch import MonkeyPatch
-from py.path import local
from tests.util import DATA_DIR
pytestmark = pytest.mark.jupyter
@@ -21,6 +24,8 @@ pytest.importorskip("tokenize_rt", reason="tokenize-rt is an optional dependency
JUPYTER_MODE = Mode(is_ipynb=True)
+EMPTY_CONFIG = DATA_DIR / "empty_pyproject.toml"
+
runner = CliRunner()
@@ -63,9 +68,19 @@ def test_trailing_semicolon_noop() -> None:
format_cell(src, fast=True, mode=JUPYTER_MODE)
-def test_cell_magic() -> None:
+@pytest.mark.parametrize(
+ "mode",
+ [
+ pytest.param(JUPYTER_MODE, id="default mode"),
+ pytest.param(
+ replace(JUPYTER_MODE, python_cell_magics={"cust1", "cust1"}),
+ id="custom cell magics mode",
+ ),
+ ],
+)
+def test_cell_magic(mode: Mode) -> None:
src = "%%time\nfoo =bar"
- result = format_cell(src, fast=True, mode=JUPYTER_MODE)
+ result = format_cell(src, fast=True, mode=mode)
expected = "%%time\nfoo = bar"
assert result == expected
@@ -76,6 +91,16 @@ def test_cell_magic_noop() -> None:
format_cell(src, fast=True, mode=JUPYTER_MODE)
+@pytest.mark.parametrize(
+ "mode",
+ [
+ pytest.param(JUPYTER_MODE, id="default mode"),
+ pytest.param(
+ replace(JUPYTER_MODE, python_cell_magics={"cust1", "cust1"}),
+ id="custom cell magics mode",
+ ),
+ ],
+)
@pytest.mark.parametrize(
"src, expected",
(
@@ -96,8 +121,8 @@ def test_cell_magic_noop() -> None:
pytest.param("env = %env", "env = %env", id="Assignment to magic"),
),
)
-def test_magic(src: str, expected: str) -> None:
- result = format_cell(src, fast=True, mode=JUPYTER_MODE)
+def test_magic(src: str, expected: str, mode: Mode) -> None:
+ result = format_cell(src, fast=True, mode=mode)
assert result == expected
@@ -106,6 +131,7 @@ def test_magic(src: str, expected: str) -> None:
(
"%%bash\n2+2",
"%%html --isolated\n2+2",
+ "%%writefile e.txt\n meh\n meh",
),
)
def test_non_python_magics(src: str) -> None:
@@ -132,12 +158,47 @@ def test_magic_noop() -> None:
def test_cell_magic_with_magic() -> None:
- src = "%%t -n1\nls =!ls"
+ src = "%%timeit -n1\nls =!ls"
result = format_cell(src, fast=True, mode=JUPYTER_MODE)
- expected = "%%t -n1\nls = !ls"
+ expected = "%%timeit -n1\nls = !ls"
assert result == expected
+@pytest.mark.parametrize(
+ "mode, expected_output, expectation",
+ [
+ pytest.param(
+ JUPYTER_MODE,
+ "%%custom_python_magic -n1 -n2\nx=2",
+ pytest.raises(NothingChanged),
+ id="No change when cell magic not registered",
+ ),
+ pytest.param(
+ replace(JUPYTER_MODE, python_cell_magics={"cust1", "cust1"}),
+ "%%custom_python_magic -n1 -n2\nx=2",
+ pytest.raises(NothingChanged),
+ id="No change when other cell magics registered",
+ ),
+ pytest.param(
+ replace(JUPYTER_MODE, python_cell_magics={"custom_python_magic", "cust1"}),
+ "%%custom_python_magic -n1 -n2\nx = 2",
+ does_not_raise(),
+ id="Correctly change when cell magic registered",
+ ),
+ ],
+)
+def test_cell_magic_with_custom_python_magic(
+ mode: Mode, expected_output: str, expectation: ContextManager[object]
+) -> None:
+ with expectation:
+ result = format_cell(
+ "%%custom_python_magic -n1 -n2\nx=2",
+ fast=True,
+ mode=mode,
+ )
+ assert result == expected_output
+
+
def test_cell_magic_nested() -> None:
src = "%%time\n%%time\n2+2"
result = format_cell(src, fast=True, mode=JUPYTER_MODE)
@@ -351,9 +412,10 @@ def test_ipynb_diff_with_change() -> None:
[
str(DATA_DIR / "notebook_trailing_newline.ipynb"),
"--diff",
+ f"--config={EMPTY_CONFIG}",
],
)
- expected = "@@ -1,3 +1,3 @@\n %%time\n \n-print('foo')\n" '+print("foo")\n'
+ expected = "@@ -1,3 +1,3 @@\n %%time\n \n-print('foo')\n+print(\"foo\")\n"
assert expected in result.output
@@ -363,6 +425,7 @@ def test_ipynb_diff_with_no_change() -> None:
[
str(DATA_DIR / "notebook_without_changes.ipynb"),
"--diff",
+ f"--config={EMPTY_CONFIG}",
],
)
expected = "1 file would be left unchanged."
@@ -370,52 +433,56 @@ def test_ipynb_diff_with_no_change() -> None:
def test_cache_isnt_written_if_no_jupyter_deps_single(
- monkeypatch: MonkeyPatch, tmpdir: local
+ monkeypatch: MonkeyPatch, tmp_path: pathlib.Path
) -> None:
# Check that the cache isn't written to if Jupyter dependencies aren't installed.
jupyter_dependencies_are_installed.cache_clear()
nb = DATA_DIR / "notebook_trailing_newline.ipynb"
- tmp_nb = tmpdir / "notebook.ipynb"
+ tmp_nb = tmp_path / "notebook.ipynb"
with open(nb) as src, open(tmp_nb, "w") as dst:
dst.write(src.read())
monkeypatch.setattr(
"black.jupyter_dependencies_are_installed", lambda verbose, quiet: False
)
- result = runner.invoke(main, [str(tmpdir / "notebook.ipynb")])
+ result = runner.invoke(
+ main, [str(tmp_path / "notebook.ipynb"), f"--config={EMPTY_CONFIG}"]
+ )
assert "No Python files are present to be formatted. Nothing to do" in result.output
jupyter_dependencies_are_installed.cache_clear()
monkeypatch.setattr(
"black.jupyter_dependencies_are_installed", lambda verbose, quiet: True
)
- result = runner.invoke(main, [str(tmpdir / "notebook.ipynb")])
+ result = runner.invoke(
+ main, [str(tmp_path / "notebook.ipynb"), f"--config={EMPTY_CONFIG}"]
+ )
assert "reformatted" in result.output
def test_cache_isnt_written_if_no_jupyter_deps_dir(
- monkeypatch: MonkeyPatch, tmpdir: local
+ monkeypatch: MonkeyPatch, tmp_path: pathlib.Path
) -> None:
# Check that the cache isn't written to if Jupyter dependencies aren't installed.
jupyter_dependencies_are_installed.cache_clear()
nb = DATA_DIR / "notebook_trailing_newline.ipynb"
- tmp_nb = tmpdir / "notebook.ipynb"
+ tmp_nb = tmp_path / "notebook.ipynb"
with open(nb) as src, open(tmp_nb, "w") as dst:
dst.write(src.read())
monkeypatch.setattr(
"black.files.jupyter_dependencies_are_installed", lambda verbose, quiet: False
)
- result = runner.invoke(main, [str(tmpdir)])
+ result = runner.invoke(main, [str(tmp_path), f"--config={EMPTY_CONFIG}"])
assert "No Python files are present to be formatted. Nothing to do" in result.output
jupyter_dependencies_are_installed.cache_clear()
monkeypatch.setattr(
"black.files.jupyter_dependencies_are_installed", lambda verbose, quiet: True
)
- result = runner.invoke(main, [str(tmpdir)])
+ result = runner.invoke(main, [str(tmp_path), f"--config={EMPTY_CONFIG}"])
assert "reformatted" in result.output
-def test_ipynb_flag(tmpdir: local) -> None:
+def test_ipynb_flag(tmp_path: pathlib.Path) -> None:
nb = DATA_DIR / "notebook_trailing_newline.ipynb"
- tmp_nb = tmpdir / "notebook.a_file_extension_which_is_definitely_not_ipynb"
+ tmp_nb = tmp_path / "notebook.a_file_extension_which_is_definitely_not_ipynb"
with open(nb) as src, open(tmp_nb, "w") as dst:
dst.write(src.read())
result = runner.invoke(
@@ -424,9 +491,10 @@ def test_ipynb_flag(tmpdir: local) -> None:
str(tmp_nb),
"--diff",
"--ipynb",
+ f"--config={EMPTY_CONFIG}",
],
)
- expected = "@@ -1,3 +1,3 @@\n %%time\n \n-print('foo')\n" '+print("foo")\n'
+ expected = "@@ -1,3 +1,3 @@\n %%time\n \n-print('foo')\n+print(\"foo\")\n"
assert expected in result.output
@@ -439,6 +507,7 @@ def test_ipynb_and_pyi_flags() -> None:
"--pyi",
"--ipynb",
"--diff",
+ f"--config={EMPTY_CONFIG}",
],
)
assert isinstance(result.exception, SystemExit)