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
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
|
# Copyright (c) Meta Platforms, Inc. and affiliates.
#
# This source code is licensed under the MIT license found in the
# LICENSE file in the root directory of this source tree.
#
from libcst.codemod import CodemodTest
from libcst.codemod.commands.convert_format_to_fstring import ConvertFormatStringCommand
class ConvertFormatStringCommandTest(CodemodTest):
TRANSFORM = ConvertFormatStringCommand
def test_noop(self) -> None:
"""
Should do nothing, since there's nothing to do.
"""
before = """
def foo() -> str:
return "foo"
def bar(baz: str) -> str:
return baz.format(bla, baz)
"""
after = """
def foo() -> str:
return "foo"
def bar(baz: str) -> str:
return baz.format(bla, baz)
"""
self.assertCodemod(before, after)
def test_unsupported_expansion(self) -> None:
"""
Should do nothing, since we can't safely expand at compile-time.
"""
before = """
def baz() -> str:
return "{}: {}".format(*baz)
def foobar() -> str:
return "{x}: {y}".format(**baz)
"""
after = """
def baz() -> str:
return "{}: {}".format(*baz)
def foobar() -> str:
return "{x}: {y}".format(**baz)
"""
self.assertCodemod(
before,
after,
expected_warnings=[
"Unsupported field_name 0 in format() call",
"Unsupported field_name x in format() call",
],
)
def test_unsupported_expression(self) -> None:
"""
Should do nothing, since we can't safely expand these expressions.
"""
before = """
def foo() -> str:
return "{}".format(f'bla')
def bar() -> str:
return "{}".format("'bla'")
def baz() -> str:
return "{}".format(1 +\\
2)
def foobar() -> str:
return "{}".format((
1 +
# Woah, comment
2
))
def foobarbaz() -> str:
return "{}".format('\\n')
async def awaitable() -> str:
return "{}".format(await bla())
"""
after = """
def foo() -> str:
return "{}".format(f'bla')
def bar() -> str:
return "{}".format("'bla'")
def baz() -> str:
return "{}".format(1 +\\
2)
def foobar() -> str:
return "{}".format((
1 +
# Woah, comment
2
))
def foobarbaz() -> str:
return "{}".format('\\n')
async def awaitable() -> str:
return "{}".format(await bla())
"""
self.assertCodemod(
before,
after,
expected_warnings=[
"Unsupported f-string in format() call",
"Cannot embed string with same quote from format() call",
"Unsupported backslash in format expression",
"Unsupported comment in format() call",
"Unsupported backslash in format expression",
"Unsupported await in format() call",
],
# await isn't supported inside functions in 3.6
python_version="3.7",
)
def test_enable_unsupported_comments(self) -> None:
"""
Should codemod code with a comment in it, by removing the comment.
"""
before = """
def foobar() -> str:
return "{}".format((
1 +
# Woah, comment
2
))
"""
after = """
def foobar() -> str:
return f"{( 1 + 2 )}"
"""
self.assertCodemod(
before,
after,
allow_strip_comments=True,
python_version="3.7",
)
def test_enable_unsupported_await(self) -> None:
"""
Should codemod code with an await in it, by enabling 3.7+ behavior.
"""
before = """
async def awaitable() -> str:
return "{}".format(await bla())
"""
after = """
async def awaitable() -> str:
return f"{await bla()}"
"""
self.assertCodemod(
before,
after,
allow_await=True,
python_version="3.7",
)
def test_formatspec_conversion(self) -> None:
"""
Should convert a format specifier which includes format-spec mini language
of its own as well as several basic varieties.
"""
before = """
def foo() -> str:
return "{0:#0{1}x}".format(1, 4)
def bar() -> str:
return "{:#0{}x} {}".format(1, 4, 5)
def baz() -> str:
return "{x:#0{y}x}".format(x=1, y=4)
def foobar() -> str:
return "{:0>3d}".format(x)
"""
after = """
def foo() -> str:
return f"{1:#0{4}x}"
def bar() -> str:
return f"{1:#0{4}x} {5}"
def baz() -> str:
return f"{1:#0{4}x}"
def foobar() -> str:
return f"{x:0>3d}"
"""
self.assertCodemod(
before,
after,
)
def test_position_replacement(self) -> None:
"""
Should convert a format with positional-only parameters.
"""
before = """
def foo() -> str:
return "{}".format(baz)
def bar() -> str:
return "{} {} {}".format(foo(), baz, foobar)
def baz() -> str:
return "foo: {}, baz: {}, foobar: {}!".format(foo(), baz, foobar)
def foobar() -> str:
return "foo: {2}, baz: {1}, foobar: {0}!".format(foobar, baz, foo())
"""
after = """
def foo() -> str:
return f"{baz}"
def bar() -> str:
return f"{foo()} {baz} {foobar}"
def baz() -> str:
return f"foo: {foo()}, baz: {baz}, foobar: {foobar}!"
def foobar() -> str:
return f"foo: {foo()}, baz: {baz}, foobar: {foobar}!"
"""
self.assertCodemod(before, after)
def test_name_replacement(self) -> None:
"""
Should convert a format with name-only parameters.
"""
before = """
def foo() -> str:
return "{baz}".format(baz=baz)
def bar() -> str:
return "{a} {b} {c}".format(a=foo(), b=baz, c=foobar)
"""
after = """
def foo() -> str:
return f"{baz}"
def bar() -> str:
return f"{foo()} {baz} {foobar}"
"""
self.assertCodemod(before, after)
def test_replacement_with_escapes(self) -> None:
"""
Should convert a format while not dropping escape sequences
"""
before = r"""
def foo() -> str:
return '"bla": {}\n'.format(baz)
def foobar() -> str:
return "{{bla}}: {}".format(baz)
def bar() -> str:
return r"'bla': {}\n".format(baz)
def barbaz() -> str:
return r"{{bla}}: {}\n".format(baz)
def foobarbaz() -> str:
return "{{min={}, max={}}}".format(minval, maxval)
"""
after = r"""
def foo() -> str:
return f'"bla": {baz}\n'
def foobar() -> str:
return f"{{bla}}: {baz}"
def bar() -> str:
return fr"'bla': {baz}\n"
def barbaz() -> str:
return fr"{{bla}}: {baz}\n"
def foobarbaz() -> str:
return f"{{min={minval}, max={maxval}}}"
"""
self.assertCodemod(before, after)
def test_replacement_with_expression(self) -> None:
"""
Should convert a format with attr/subscript expression.
"""
before = """
def foo() -> str:
return "{baz.name}".format(baz=baz)
def bar() -> str:
return "{baz[0]}".format(baz=baz)
def foobar() -> str:
return "{0.name}".format(baz)
def baz() -> str:
return "{0[0]}".format(baz)
"""
after = """
def foo() -> str:
return f"{baz.name}"
def bar() -> str:
return f"{baz[0]}"
def foobar() -> str:
return f"{baz.name}"
def baz() -> str:
return f"{baz[0]}"
"""
self.assertCodemod(before, after)
def test_replacement_with_conversion(self) -> None:
"""
Should convert a format which uses a conversion
"""
before = r"""
def foo() -> str:
return "bla: {0!r}\n".format(baz)
"""
after = r"""
def foo() -> str:
return f"bla: {baz!r}\n"
"""
self.assertCodemod(before, after)
def test_replacement_with_newline(self) -> None:
"""
Should convert a format which uses a conversion
"""
before = r"""
def foo() -> str:
return "bla: {}\n".format(
baz +
bar
)
"""
after = r"""
def foo() -> str:
return f"bla: {baz + bar}\n"
"""
self.assertCodemod(before, after)
def test_replacement_with_string(self) -> None:
"""
Should convert a format which uses string
"""
before = r"""
def foo() -> str:
return "bla: {}".format('baz')
def bar() -> str:
return 'bla: {}'.format("baz")
def baz() -> str:
return "bla: {}".format("baz")
"""
after = r"""
def foo() -> str:
return f"bla: {'baz'}"
def bar() -> str:
return f'bla: {"baz"}'
def baz() -> str:
return f"bla: {'baz'}"
"""
self.assertCodemod(before, after)
def test_replacement_with_dict(self) -> None:
"""
Should convert a format which uses dict
"""
before = r"""
def foo() -> str:
return "bla: {}".format({'foo': 'bar'})
"""
after = r"""
def foo() -> str:
return f"bla: {({'foo': 'bar'})}"
"""
self.assertCodemod(before, after)
|
