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
|
# 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 unittest import TestCase
from libcst import (
Annotation,
CSTNode,
FunctionDef,
IndentedBlock,
Module,
Param,
parse_module,
Pass,
Semicolon,
SimpleStatementLine,
)
from libcst.helpers import (
get_node_fields,
is_default_node_field,
is_syntax_node_field,
is_whitespace_node_field,
)
class _NodeFieldsTest(TestCase):
"""Node fields related tests."""
module: Module
annotation: Annotation
param: Param
_pass: Pass
semicolon: Semicolon
statement: SimpleStatementLine
indent: IndentedBlock
function: FunctionDef
@classmethod
def setUpClass(cls) -> None:
"""Parse a simple CST and references interesting nodes."""
cls.module = parse_module(
"def foo(a: str) -> None:\n pass ; pass\n return\n"
)
# /!\ Direct access to nodes
# This is done for test purposes on a known CST
# -> For "real code", use visitors to do this "the correct way"
# pyre-ignore[8]: direct access for tests
cls.function = cls.module.body[0]
cls.param = cls.function.params.params[0]
# pyre-ignore[8]: direct access for tests
cls.annotation = cls.param.annotation
# pyre-ignore[8]: direct access for tests
cls.indent = cls.function.body
# pyre-ignore[8]: direct access for tests
cls.statement = cls.indent.body[0]
# pyre-ignore[8]: direct access for tests
cls._pass = cls.statement.body[0]
# pyre-ignore[8]: direct access for tests
cls.semicolon = cls.statement.body[0].semicolon
def test__cst_correctness(self) -> None:
"""Test that the CST is correctly parsed."""
self.assertIsInstance(self.module, Module)
self.assertIsInstance(self.annotation, Annotation)
self.assertIsInstance(self.param, Param)
self.assertIsInstance(self._pass, Pass)
self.assertIsInstance(self.semicolon, Semicolon)
self.assertIsInstance(self.statement, SimpleStatementLine)
self.assertIsInstance(self.indent, IndentedBlock)
self.assertIsInstance(self.function, FunctionDef)
class IsWhitespaceNodeFieldTest(_NodeFieldsTest):
"""``is_whitespace_node_field`` tests."""
def _check_fields(self, is_filtered_field: dict[str, bool], node: CSTNode) -> None:
fields = get_node_fields(node)
self.assertEqual(len(is_filtered_field), len(fields))
for field in fields:
self.assertEqual(
is_filtered_field[field.name],
is_whitespace_node_field(node, field),
f"Node ``{node.__class__.__qualname__}`` field '{field.name}' "
f"{'should have' if is_filtered_field[field.name] else 'should not have'} "
"been filtered by ``is_whitespace_node_field``",
)
def test_module(self) -> None:
"""Check if a CST Module node is correctly filtered."""
is_filtered_field = {
"body": False,
"header": True,
"footer": True,
"encoding": False,
"default_indent": False,
"default_newline": False,
"has_trailing_newline": False,
}
self._check_fields(is_filtered_field, self.module)
def test_annotation(self) -> None:
"""Check if a CST Annotation node is correctly filtered."""
is_filtered_field = {
"annotation": False,
"whitespace_before_indicator": True,
"whitespace_after_indicator": True,
}
self._check_fields(is_filtered_field, self.annotation)
def test_param(self) -> None:
"""Check if a CST Param node is correctly filtered."""
is_filtered_field = {
"name": False,
"annotation": False,
"equal": False,
"default": False,
"comma": False,
"star": False,
"whitespace_after_star": True,
"whitespace_after_param": True,
}
self._check_fields(is_filtered_field, self.param)
def test_semicolon(self) -> None:
"""Check if a CST Semicolon node is correctly filtered."""
is_filtered_field = {
"whitespace_before": True,
"whitespace_after": True,
}
self._check_fields(is_filtered_field, self.semicolon)
def test_statement(self) -> None:
"""Check if a CST SimpleStatementLine node is correctly filtered."""
is_filtered_field = {
"body": False,
"leading_lines": True,
"trailing_whitespace": True,
}
self._check_fields(is_filtered_field, self.statement)
def test_indent(self) -> None:
"""Check if a CST IndentedBlock node is correctly filtered."""
is_filtered_field = {
"body": False,
"header": True,
"indent": True,
"footer": True,
}
self._check_fields(is_filtered_field, self.indent)
def test_function(self) -> None:
"""Check if a CST FunctionDef node is correctly filtered."""
is_filtered_field = {
"name": False,
"params": False,
"body": False,
"decorators": False,
"returns": False,
"asynchronous": False,
"leading_lines": True,
"lines_after_decorators": True,
"whitespace_after_def": True,
"whitespace_after_name": True,
"whitespace_before_params": True,
"whitespace_before_colon": True,
"type_parameters": False,
"whitespace_after_type_parameters": True,
}
self._check_fields(is_filtered_field, self.function)
class IsSyntaxNodeFieldTest(_NodeFieldsTest):
"""``is_syntax_node_field`` tests."""
def _check_fields(self, is_filtered_field: dict[str, bool], node: CSTNode) -> None:
fields = get_node_fields(node)
self.assertEqual(len(is_filtered_field), len(fields))
for field in fields:
self.assertEqual(
is_filtered_field[field.name],
is_syntax_node_field(node, field),
f"Node ``{node.__class__.__qualname__}`` field '{field.name}' "
f"{'should have' if is_filtered_field[field.name] else 'should not have'} "
"been filtered by ``is_syntax_node_field``",
)
def test_module(self) -> None:
"""Check if a CST Module node is correctly filtered."""
is_filtered_field = {
"body": False,
"header": False,
"footer": False,
"encoding": True,
"default_indent": True,
"default_newline": True,
"has_trailing_newline": True,
}
self._check_fields(is_filtered_field, self.module)
def test_param(self) -> None:
"""Check if a CST Param node is correctly filtered."""
is_filtered_field = {
"name": False,
"annotation": False,
"equal": True,
"default": False,
"comma": True,
"star": False,
"whitespace_after_star": False,
"whitespace_after_param": False,
}
self._check_fields(is_filtered_field, self.param)
def test_pass(self) -> None:
"""Check if a CST Pass node is correctly filtered."""
is_filtered_field = {
"semicolon": True,
}
self._check_fields(is_filtered_field, self._pass)
class IsDefaultNodeFieldTest(_NodeFieldsTest):
"""``is_default_node_field`` tests."""
def _check_fields(self, is_filtered_field: dict[str, bool], node: CSTNode) -> None:
fields = get_node_fields(node)
self.assertEqual(len(is_filtered_field), len(fields))
for field in fields:
self.assertEqual(
is_filtered_field[field.name],
is_default_node_field(node, field),
f"Node ``{node.__class__.__qualname__}`` field '{field.name}' "
f"{'should have' if is_filtered_field[field.name] else 'should not have'} "
"been filtered by ``is_default_node_field``",
)
def test_module(self) -> None:
"""Check if a CST Module node is correctly filtered."""
is_filtered_field = {
"body": False,
"header": True,
"footer": True,
"encoding": True,
"default_indent": True,
"default_newline": True,
"has_trailing_newline": True,
}
self._check_fields(is_filtered_field, self.module)
def test_annotation(self) -> None:
"""Check if a CST Annotation node is correctly filtered."""
is_filtered_field = {
"annotation": False,
"whitespace_before_indicator": False,
"whitespace_after_indicator": True,
}
self._check_fields(is_filtered_field, self.annotation)
def test_param(self) -> None:
"""Check if a CST Param node is correctly filtered."""
is_filtered_field = {
"name": False,
"annotation": False,
"equal": True,
"default": True,
"comma": True,
"star": False,
"whitespace_after_star": True,
"whitespace_after_param": True,
}
self._check_fields(is_filtered_field, self.param)
def test_statement(self) -> None:
"""Check if a CST SimpleStatementLine node is correctly filtered."""
is_filtered_field = {
"body": False,
"leading_lines": True,
"trailing_whitespace": True,
}
self._check_fields(is_filtered_field, self.statement)
def test_indent(self) -> None:
"""Check if a CST IndentedBlock node is correctly filtered."""
is_filtered_field = {
"body": False,
"header": True,
"indent": True,
"footer": True,
}
self._check_fields(is_filtered_field, self.indent)
def test_function(self) -> None:
"""Check if a CST FunctionDef node is correctly filtered."""
is_filtered_field = {
"name": False,
"params": False,
"body": False,
"decorators": True,
"returns": False,
"asynchronous": True,
"leading_lines": True,
"lines_after_decorators": True,
"whitespace_after_def": True,
"whitespace_after_name": True,
"whitespace_before_params": True,
"whitespace_before_colon": True,
"type_parameters": True,
"whitespace_after_type_parameters": True,
}
self._check_fields(is_filtered_field, self.function)
|
