📦 dhruvmanila / remove-print-statements

📄 test_remove_print_statements.py · 265 lines
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
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265import sys
from typing import Mapping

import click
import pytest
from libcst.codemod import CodemodTest

from remove_print_statements import RemovePrintStatements, format_verbose_output

FILENAME = "filename"


@pytest.mark.parametrize(
    ("print_statements", "expected"),
    (
        ({}, ""),
        (
            {
                1: "print()",
            },
            "\n".join(
                [
                    FILENAME,
                    "  1 print()",
                ]
            ),
        ),
        (
            {
                1: "print(1)",
                12: "print(12)",
            },
            "\n".join(
                [
                    FILENAME,
                    "  1 print(1)",
                    "  12 print(12)",
                ]
            ),
        ),
    ),
)
def test_format_verbose_output(
    print_statements: Mapping[int, str], expected: str
) -> None:
    assert click.unstyle(format_verbose_output(FILENAME, print_statements)) == expected


class TestRemovePrintStatement(CodemodTest):
    TRANSFORM = RemovePrintStatements

    def test_noop(self) -> None:
        before = """
        """
        after = """
        """
        self.assertCodemod(before, after)

    def test_no_print_statements(self) -> None:
        before = """
            a = 5
        """
        after = """
            a = 5
        """
        self.assertCodemod(before, after)

    def test_module_level(self) -> None:
        before = """
            a = 5
            print("module scope")
            b = a + 2
        """
        after = """
            a = 5
            b = a + 2
        """
        self.assertCodemod(before, after)

    def test_main_block(self) -> None:
        before = """
        if __name__ == "__main__":
            print("in main block")
            a = 5
        """
        after = """
        if __name__ == "__main__":
            a = 5
        """
        self.assertCodemod(before, after)

    def test_in_function(self) -> None:
        before = """
        def foo():
            print("function")
            return None
        """
        after = """
        def foo():
            return None
        """
        self.assertCodemod(before, after)

    def test_in_method(self) -> None:
        before = """
        class Foo:
            def bar(self):
                print("method")
                return None
        """
        after = """
        class Foo:
            def bar(self):
                return None
        """
        self.assertCodemod(before, after)

    def test_in_property(self) -> None:
        before = """
        class Foo:
            @property
            def bar(self):
                print("property")
                return 1
        """
        after = """
        class Foo:
            @property
            def bar(self):
                return 1
        """
        self.assertCodemod(before, after)

    def test_in_for_loop(self) -> None:
        before = """
        a = 0
        for i in range(4):
            print("for loop")
            a += i
        """
        after = """
        a = 0
        for i in range(4):
            a += i
        """
        self.assertCodemod(before, after)

    def test_in_while_loop(self) -> None:
        before = """
        a = 5
        while a > 5:
            print(a)
            a -= 1
        """
        after = """
        a = 5
        while a > 5:
            a -= 1
        """
        self.assertCodemod(before, after)

    def test_in_if_statement(self) -> None:
        before = """
        x = 5
        if x == 1:
            print("if")
            a = 1
        elif x > 1:
            print("elif")
            a = 5
        else:
            print("else")
            a = 10
        """
        after = """
        x = 5
        if x == 1:
            a = 1
        elif x > 1:
            a = 5
        else:
            a = 10
        """
        self.assertCodemod(before, after)

    def test_single_statement(self) -> None:
        before = """
            def foo():
                print()


            for _ in range(5):
                print()

            if __name__ == "__main__":
                print()
            """
        after = """
            def foo():
                pass


            for _ in range(5):
                pass

            if __name__ == "__main__":
                pass
            """
        self.assertCodemod(before, after)

    # https://github.com/dhruvmanila/remove-print-statements/issues/6
    @pytest.mark.skipif(
        sys.version_info <= (3, 10),
        reason="Match statement requires Python 3.10 or higher",
    )
    def test_python_310_match_statement(self) -> None:
        before = """
            x = 2
            match x:
                case 1:
                    x -= 1
                    print("x is 1")
                case 2:
                    x -= 2
                    print("x is 2")
        """
        after = """
            x = 2
            match x:
                case 1:
                    x -= 1
                case 2:
                    x -= 2
        """
        self.assertCodemod(before, after)

    def test_dry_run(self) -> None:
        before = """
            x = 5
            print("do not remove")
            y = x + 1
        """
        after = """
            x = 5
            print("do not remove")
            y = x + 1
        """
        self.assertCodemod(before, after, dry_run=True)

    def test_utf8_characters_handled(self) -> None:
        before = """
        def foo():
            x = "“Fancy Quote”"
            print(x)
            print("“Other Fancy Quote”")
            print('"Normal Quote"')
            return x
        """
        after = """
        def foo():
            x = "“Fancy Quote”"
            return x
        """
        self.assertCodemod(before, after)