Python/tests/test_find_and_fix_pep798.py at master · TheAlgorithms/Python · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
from pathlib import Path

import pytest

from scripts.find_and_fix_pep798 import (
    find_opportunities,
    fix_source,
    iter_python_files,
    main,
)


@pytest.mark.parametrize(
    ("before", "after"),
    [
        ("[y for x in xs for y in x]", "[*x for x in xs]"),
        ("{y for x in xs for y in x}", "{*x for x in xs}"),
        ("(y for x in xs for y in x)", "(*x for x in xs)"),
        ("sum(y for x in xs for y in x)", "sum(*x for x in xs)"),
        ("{k: v for d in ds for k, v in d.items()}", "{**d for d in ds}"),
        ("[y for x in xs if x for y in x]", "[*x for x in xs if x]"),
        ("[y for x in xs if x if x.a for y in x]", "[*x for x in xs if x if x.a]"),
        ("[y for x, z in xs for y in x.items]", "[*x.items for x, z in xs]"),
        ("[y for x in xs for y in x or ()]", "[*(x or ()) for x in xs]"),
        ("[y for x in (a if b else c) for y in x]", "[*x for x in (a if b else c)]"),
        ("[y for x in xs for y in (x)]", "[*x for x in xs]"),
        ("[y for x in xs for y in f(x)[0]]", "[*f(x)[0] for x in xs]"),
        ("[y for x in xs for y in x][0]", "[*x for x in xs][0]"),
        ("[é for ü in xs for é in ü]", "[*ü for ü in xs]"),
        ("{k: v for d in ds for k, v in (a or b).items()}", "{**(a or b) for d in ds}"),
    ],
)
def test_fixes(before: str, after: str) -> None:
    assert fix_source(before) == after


@pytest.mark.parametrize(
    "source",
    [
        "[y for y in ys]",
        "[y + 1 for x in xs for y in x]",
        "[z for x in xs for y in x]",
        "[y for x in xs for y in x if y]",
        "[y for x in xs for y in x for z in y]",
        "[x for x in xs for x, y in x]",
        "{k: v for d in ds for k, v in d.items() if v}",
        "{k: v for d in ds for v, k in d.items()}",
        "{k: v for d in ds for k, v in d.items(1)}",
        "{k: v for d in ds for k, v in d}",
        "{k: v for d in ds for k, k in d.items()}",
        "[x for x in xs]",
        "list(itertools.chain.from_iterable(xs))",
    ],
)
def test_no_opportunity(source: str) -> None:
    assert find_opportunities(source) == []
    assert fix_source(source) == source


def test_async_comprehensions_are_ignored() -> None:
    source = (
        "async def f():\n"
        "    return [y async for x in xs for y in x]\n"
        "async def g():\n"
        "    return [y for x in xs async for y in x]\n"
    )
    assert find_opportunities(source) == []


def test_find_reports_line_and_text() -> None:
    source = "a = 1\nb = [y for x in xs for y in x]\n"
    (finding,) = find_opportunities(source)
    assert finding.line == 2
    assert finding.old == "[y for x in xs for y in x]"
    assert finding.new == "[*x for x in xs]"
    assert source[finding.start : finding.end] == finding.old


def test_multiple_findings_in_order() -> None:
    source = (
        "a = [y for x in xs for y in x]\nb = {k: v for d in ds for k, v in d.items()}\n"
    )
    assert fix_source(source) == "a = [*x for x in xs]\nb = {**d for d in ds}\n"


def test_nested_candidates_fix_innermost_only() -> None:
    source = "[w for v in [y for x in xs for y in x] for w in v]"
    (finding,) = find_opportunities(source)
    assert finding.old == "[y for x in xs for y in x]"
    assert fix_source(source) == "[w for v in [*x for x in xs] for w in v]"


def test_multiline_comprehension() -> None:
    source = "result = [\n    y\n    for x in xs\n    for y in x\n]\n"
    assert fix_source(source) == "result = [*x for x in xs]\n"


def test_iter_python_files(tmp_path: Path) -> None:
    (tmp_path / "sub").mkdir()
    (tmp_path / ".hidden").mkdir()
    first = tmp_path / "a.py"
    second = tmp_path / "sub" / "b.py"
    other = tmp_path / "c.txt"
    hidden = tmp_path / ".hidden" / "hidden.py"
    for path in (first, second, other, hidden):
        path.write_text("")
    assert list(iter_python_files([tmp_path])) == [first, second]
    assert list(iter_python_files([other])) == []
    assert list(iter_python_files([hidden])) == []


def test_main_reports_without_fixing(
    tmp_path: Path, capsys: pytest.CaptureFixture[str]
) -> None:
    path = tmp_path / "mod.py"
    path.write_text("a = [y for x in xs for y in x]\n")
    assert main([str(path)]) == 1
    output = capsys.readouterr().out
    assert f"{path}:1:" in output
    assert "1 PEP 798 opportunity found" in output
    assert path.read_text() == "a = [y for x in xs for y in x]\n"


def test_main_fix_rewrites_file(
    tmp_path: Path, capsys: pytest.CaptureFixture[str]
) -> None:
    path = tmp_path / "mod.py"
    path.write_text("a = [y for x in xs for y in x]\nb = {y for x in xs for y in x}\n")
    assert main(["--fix", str(path)]) == 0
    assert path.read_text() == "a = [*x for x in xs]\nb = {*x for x in xs}\n"
    assert "2 PEP 798 opportunities found" in capsys.readouterr().out


def test_main_clean_file_returns_zero(
    tmp_path: Path, capsys: pytest.CaptureFixture[str]
) -> None:
    path = tmp_path / "mod.py"
    path.write_text("a = [y for y in ys]\n")
    assert main([str(path)]) == 0
    assert "0 PEP 798 opportunities found" in capsys.readouterr().out


def test_main_defaults_to_current_directory(
    tmp_path: Path, monkeypatch: pytest.MonkeyPatch, capsys: pytest.CaptureFixture[str]
) -> None:
    path = tmp_path / "mod.py"
    path.write_text("a = [y for x in xs for y in x]\n")
    monkeypatch.chdir(tmp_path)
    assert main([]) == 1
    output = capsys.readouterr().out
    assert f"{path}:1:" in output
    assert "1 PEP 798 opportunity found" in output


def test_main_skips_syntax_errors(
    tmp_path: Path, capsys: pytest.CaptureFixture[str]
) -> None:
    path = tmp_path / "bad.py"
    path.write_text("def (:\n")
    assert main([str(path)]) == 0
    assert "skipped" in capsys.readouterr().err