-
Notifications
You must be signed in to change notification settings - Fork 24
/
replace_config.py
297 lines (261 loc) · 10.3 KB
/
replace_config.py
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
from typing import List
import libcst as cst
from libcst import matchers as m
from libcst.codemod import CodemodContext, VisitorBasedCodemodCommand
from libcst.codemod.visitors import AddImportsVisitor, RemoveImportsVisitor
from libcst.metadata import ClassScope, ScopeProvider
PREFIX_COMMENT = "# TODO[pydantic]: "
REFACTOR_COMMENT = f"{PREFIX_COMMENT}We couldn't refactor this class, please create the `model_config` manually."
REMOVED_KEYS_COMMENT = f"{PREFIX_COMMENT}The following keys were removed: {{keys}}."
INHERIT_CONFIG_COMMENT = (
f"{PREFIX_COMMENT}The `Config` class inherits from another class, please create the `model_config` manually."
)
CHECK_LINK_COMMENT = "# Check https://docs.pydantic.dev/dev-v2/migration/#changes-to-config for more information."
REMOVED_KEYS = [
"allow_mutation",
"error_msg_templates",
"fields",
"getter_dict",
"smart_union",
"underscore_attrs_are_private",
"json_loads",
"json_dumps",
"json_encoders",
"copy_on_model_validation",
"post_init_call",
]
RENAMED_KEYS = {
"allow_population_by_field_name": "populate_by_name",
"anystr_lower": "str_to_lower",
"anystr_strip_whitespace": "str_strip_whitespace",
"anystr_upper": "str_to_upper",
"keep_untouched": "ignored_types",
"max_anystr_length": "str_max_length",
"min_anystr_length": "str_min_length",
"orm_mode": "from_attributes",
"schema_extra": "json_schema_extra",
"validate_all": "validate_default",
}
EXTRA_ATTRIBUTE = m.Attribute(
value=m.Name("Extra"),
attr=m.Name(value=m.MatchIfTrue(lambda v: v in ("allow", "forbid", "ignore"))),
)
BASE_MODEL_WITH_CONFIG = m.ClassDef(
bases=[
m.ZeroOrMore(),
m.Arg(),
m.ZeroOrMore(),
],
body=m.IndentedBlock(
body=[
m.ZeroOrMore(),
m.ClassDef(name=m.Name(value="Config"), bases=[]),
m.ZeroOrMore(),
]
),
)
BASE_MODEL_WITH_INHERITED_CONFIG = m.ClassDef(
bases=[
m.ZeroOrMore(),
m.Arg(),
m.ZeroOrMore(),
],
body=m.IndentedBlock(
body=[
m.ZeroOrMore(),
m.ClassDef(name=m.Name(value="Config"), bases=[m.AtLeastN(n=1)]),
m.ZeroOrMore(),
]
),
)
BASE_MODEL_WITH_INVALID_CONFIG = m.ClassDef(
bases=[
m.ZeroOrMore(),
m.Arg(),
m.ZeroOrMore(),
],
body=m.IndentedBlock(
body=[
m.ZeroOrMore(),
m.ClassDef(
name=m.Name(value="Config"),
bases=[],
body=m.IndentedBlock(
body=[
m.ZeroOrMore(),
m.AtLeastN(n=1, matcher=~m.SimpleStatementLine()),
m.ZeroOrMore(),
]
),
),
m.ZeroOrMore(),
]
),
)
"""
This matches a `Config` class with at least one NON `m.SimpleStatementLine`:
Example:
```
class Config:
allow_mutation = True
def potato():
...
```
"""
class ReplaceConfigCodemod(VisitorBasedCodemodCommand):
"""Replace `Config` class by `ConfigDict` call."""
METADATA_DEPENDENCIES = (ScopeProvider,)
def __init__(self, context: CodemodContext) -> None:
super().__init__(context)
self.inside_config_class = False
self.is_base_settings = False
self.invalid_config_class = False
self.inherited_config_class = False
self.config_args: List[cst.Arg] = []
@m.visit(m.ClassDef(bases=[m.ZeroOrMore(), m.Arg(value=m.Name("BaseSettings")), m.ZeroOrMore()]))
def visit_settings_with_config(self, node: cst.ClassDef) -> None:
self.is_base_settings = True
@m.visit(m.ClassDef(name=m.Name(value="Config")))
def visit_config_class(self, node: cst.ClassDef) -> None:
scope = self.get_metadata(ScopeProvider, node)
if isinstance(scope, ClassScope):
self.inside_config_class = True
@m.leave(m.ClassDef(name=m.Name(value="Config")))
def leave_config_class(self, original_node: cst.ClassDef, updated_node: cst.ClassDef) -> cst.ClassDef:
self.inside_config_class = False
if self.invalid_config_class or self.inherited_config_class:
for line in updated_node.leading_lines:
if m.matches(line, m.EmptyLine(comment=m.Comment(value=CHECK_LINK_COMMENT))):
return updated_node
if self.invalid_config_class:
return updated_node.with_changes(
leading_lines=[
*updated_node.leading_lines,
cst.EmptyLine(comment=cst.Comment(value=(REFACTOR_COMMENT))),
cst.EmptyLine(comment=cst.Comment(value=(CHECK_LINK_COMMENT))),
]
)
elif self.inherited_config_class:
return updated_node.with_changes(
leading_lines=[
*updated_node.leading_lines,
cst.EmptyLine(comment=cst.Comment(value=(INHERIT_CONFIG_COMMENT))),
cst.EmptyLine(comment=cst.Comment(value=(CHECK_LINK_COMMENT))),
]
)
return updated_node
def visit_Assign(self, node: cst.Assign) -> None:
self.assign_value = node.value
def visit_AssignTarget(self, node: cst.AssignTarget) -> None:
if self.inside_config_class:
keyword = RENAMED_KEYS.get(node.target.value, node.target.value) # type: ignore[attr-defined]
if m.matches(self.assign_value, EXTRA_ATTRIBUTE):
value = cst.SimpleString(value=f'"{self.assign_value.attr.value}"') # type: ignore[attr-defined]
RemoveImportsVisitor.remove_unused_import(self.context, "pydantic", "Extra")
else:
value = self.assign_value # type: ignore[assignment]
self.config_args.append(
cst.Arg(
keyword=node.target.with_changes(value=keyword), # type: ignore[arg-type]
value=value,
equal=cst.AssignEqual(
whitespace_before=cst.SimpleWhitespace(""),
whitespace_after=cst.SimpleWhitespace(""),
),
)
)
def leave_Module(self, original_node: cst.Module, updated_node: cst.Module) -> cst.Module:
return updated_node
@m.visit(BASE_MODEL_WITH_INHERITED_CONFIG)
def visit_inherited_config_class(self, node: cst.ClassDef) -> None:
self.inherited_config_class = True
@m.leave(BASE_MODEL_WITH_INHERITED_CONFIG)
def leave_inherited_config_class(self, original_node: cst.ClassDef, updated_node: cst.ClassDef) -> cst.ClassDef:
self.inherited_config_class = False
return updated_node
@m.visit(BASE_MODEL_WITH_INVALID_CONFIG)
def visit_config_class_with_more_than_assignments(self, node: cst.ClassDef) -> None:
self.invalid_config_class = True
@m.leave(BASE_MODEL_WITH_CONFIG)
def leave_config_class_childless(self, original_node: cst.ClassDef, updated_node: cst.ClassDef) -> cst.ClassDef:
"""Replace the `Config` class with a `model_config` attribute.
Any class that contains a `Config` class will have that class replaced
with a `model_config` attribute. The `model_config` attribute will be
assigned a `ConfigDict` object with the same arguments as the attributes
from `Config` class.
"""
if self.invalid_config_class:
self.invalid_config_class = False
return updated_node
if self.is_base_settings:
needed_import = {"module": "pydantic_settings", "obj": "SettingsConfigDict"}
else:
needed_import = {"module": "pydantic", "obj": "ConfigDict"}
AddImportsVisitor.add_needed_import(context=self.context, **needed_import) # type: ignore[arg-type]
block = cst.ensure_type(updated_node.body, cst.IndentedBlock)
body = [
cst.SimpleStatementLine(
body=[
cst.Assign(
targets=[cst.AssignTarget(target=cst.Name("model_config"))],
value=cst.Call(
func=cst.Name("SettingsConfigDict" if self.is_base_settings else "ConfigDict"),
args=self.config_args,
),
)
],
leading_lines=self._leading_lines_from_removed_keys(self.config_args),
)
if m.matches(statement, m.ClassDef(name=m.Name(value="Config")))
else statement
for statement in block.body
]
self.is_base_settings = False
self.config_args = []
return updated_node.with_changes(body=updated_node.body.with_changes(body=body))
@staticmethod
def _leading_lines_from_removed_keys(args: List[cst.Arg]) -> List[cst.EmptyLine]:
removed_keys = [arg.keyword.value for arg in args if arg.keyword.value in REMOVED_KEYS] # type: ignore
if not removed_keys:
return []
formatted_keys = ", ".join(f"`{key}`" for key in removed_keys)
return [
cst.EmptyLine(comment=cst.Comment(value=REMOVED_KEYS_COMMENT.format(keys=formatted_keys))),
cst.EmptyLine(comment=cst.Comment(value=CHECK_LINK_COMMENT)),
]
if __name__ == "__main__":
import textwrap
from rich.console import Console
console = Console()
source = textwrap.dedent(
"""
from pydantic import BaseModel
class A(BaseSettings):
a: str
# My comment
b: int
# potato
class Config:
allow_arbitrary_types = True
schema_extra = {
"example": {
"foo": "bar",
}
}
@staticmethod
def indexes() -> Iterable[Index]:
yield Index(DiscoverTopic.org_id, DiscoverTopic.taxonomy_id)
"""
)
console.print(source)
console.print("=" * 80)
mod = cst.parse_module(source)
context = CodemodContext(filename="main.py")
wrapper = cst.MetadataWrapper(mod)
command = ReplaceConfigCodemod(context=context)
console.print(mod)
mod = wrapper.visit(command)
wrapper = cst.MetadataWrapper(mod)
command = AddImportsVisitor(context=context) # type: ignore[assignment]
mod = wrapper.visit(command)
console.print(mod.code)