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
|
# 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_namedtuple_to_dataclass import (
ConvertNamedTupleToDataclassCommand,
)
class ConvertNamedTupleToDataclassCommandTest(CodemodTest):
TRANSFORM = ConvertNamedTupleToDataclassCommand
def test_no_change(self) -> None:
"""
Should result in no change as there are no children of NamedTuple.
"""
before = """
@dataclass(frozen=True)
class Foo:
pass
"""
after = """
@dataclass(frozen=True)
class Foo:
pass
"""
self.assertCodemod(before, after)
def test_change(self) -> None:
"""
Should remove the NamedTuple import along with its use as a base class for Foo.
Should import dataclasses.dataclass and annotate Foo.
"""
before = """
from typing import NamedTuple
class Foo(NamedTuple):
pass
"""
after = """
from dataclasses import dataclass
@dataclass(frozen=True)
class Foo:
pass
"""
self.assertCodemod(before, after)
def test_with_decorator_already(self) -> None:
"""
Should retain existing decorator.
"""
before = """
from typing import NamedTuple
@other_decorator
class Foo(NamedTuple):
pass
"""
after = """
from dataclasses import dataclass
@other_decorator
@dataclass(frozen=True)
class Foo:
pass
"""
self.assertCodemod(before, after)
def test_multiple_bases(self) -> None:
"""
Should retain all existing bases other than NamedTuple.
"""
before = """
from typing import NamedTuple
class Foo(NamedTuple, OtherBase, YetAnotherBase):
pass
"""
after = """
from dataclasses import dataclass
@dataclass(frozen=True)
class Foo(OtherBase, YetAnotherBase):
pass
"""
self.assertCodemod(before, after)
def test_nested_classes(self) -> None:
"""
Should perform expected changes on inner classes.
"""
before = """
from typing import NamedTuple
class OuterClass:
class InnerClass(NamedTuple):
pass
"""
after = """
from dataclasses import dataclass
class OuterClass:
@dataclass(frozen=True)
class InnerClass:
pass
"""
self.assertCodemod(before, after)
def test_aliased_object_import(self) -> None:
"""
Should detect aliased NamedTuple object import and base.
"""
before = """
from typing import NamedTuple as nt
class Foo(nt):
pass
"""
after = """
from dataclasses import dataclass
@dataclass(frozen=True)
class Foo:
pass
"""
self.assertCodemod(before, after)
def test_aliased_module_import(self) -> None:
"""
Should detect aliased `typing` module import and base.
"""
before = """
import typing as typ
class Foo(typ.NamedTuple):
pass
"""
after = """
from dataclasses import dataclass
@dataclass(frozen=True)
class Foo:
pass
"""
self.assertCodemod(before, after)
def test_other_unused_imports_not_removed(self) -> None:
"""
Should not remove any imports other than NamedTuple, even if they are also unused.
"""
before = """
from typing import NamedTuple
import SomeUnusedImport
class Foo(NamedTuple):
pass
"""
after = """
import SomeUnusedImport
from dataclasses import dataclass
@dataclass(frozen=True)
class Foo:
pass
"""
self.assertCodemod(before, after)
|
