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
|
# 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 typing import Tuple
import libcst as cst
from libcst import parse_module
from libcst._batched_visitor import BatchableCSTVisitor
from libcst._visitors import CSTVisitor
from libcst.metadata import (
CodeRange,
MetadataWrapper,
PositionProvider,
WhitespaceInclusivePositionProvider,
)
from libcst.metadata.position_provider import (
PositionProvidingCodegenState,
WhitespaceInclusivePositionProvidingCodegenState,
)
from libcst.testing.utils import UnitTest
def position(
state: WhitespaceInclusivePositionProvidingCodegenState,
) -> Tuple[int, int]:
return state.line, state.column
class PositionProviderTest(UnitTest):
def test_visitor_provider(self) -> None:
"""
Sets 2 metadata entries for every node:
SimpleProvider -> 1
DependentProvider - > 2
"""
test = self
class DependentVisitor(CSTVisitor):
METADATA_DEPENDENCIES = (PositionProvider,)
def visit_Pass(self, node: cst.Pass) -> None:
test.assertEqual(
self.get_metadata(PositionProvider, node), CodeRange((1, 0), (1, 4))
)
wrapper = MetadataWrapper(parse_module("pass"))
wrapper.visit(DependentVisitor())
def test_equal_range(self) -> None:
test = self
expected_range = CodeRange((1, 4), (1, 6))
class EqualPositionVisitor(CSTVisitor):
METADATA_DEPENDENCIES = (PositionProvider,)
def visit_Equal(self, node: cst.Equal) -> None:
test.assertEqual(
self.get_metadata(PositionProvider, node), expected_range
)
def visit_NotEqual(self, node: cst.NotEqual) -> None:
test.assertEqual(
self.get_metadata(PositionProvider, node), expected_range
)
MetadataWrapper(parse_module("var == 1")).visit(EqualPositionVisitor())
MetadataWrapper(parse_module("var != 1")).visit(EqualPositionVisitor())
def test_batchable_provider(self) -> None:
test = self
class ABatchable(BatchableCSTVisitor):
METADATA_DEPENDENCIES = (PositionProvider,)
def visit_Pass(self, node: cst.Pass) -> None:
test.assertEqual(
self.get_metadata(PositionProvider, node), CodeRange((1, 0), (1, 4))
)
wrapper = MetadataWrapper(parse_module("pass"))
wrapper.visit_batched([ABatchable()])
def test_match_statement_position_metadata(self) -> None:
test = self
class MatchPositionVisitor(CSTVisitor):
METADATA_DEPENDENCIES = (PositionProvider,)
def visit_Match(self, node: cst.Match) -> None:
test.assertEqual(
self.get_metadata(PositionProvider, node),
CodeRange((2, 0), (5, 16)),
)
def visit_MatchCase(self, node: cst.MatchCase) -> None:
if (
isinstance(node.pattern, cst.MatchAs)
and node.pattern.name
and node.pattern.name.value == "b"
):
test.assertEqual(
self.get_metadata(PositionProvider, node),
CodeRange((3, 4), (3, 16)),
)
elif (
isinstance(node.pattern, cst.MatchAs)
and node.pattern.name
and node.pattern.name.value == "c"
):
test.assertEqual(
self.get_metadata(PositionProvider, node),
CodeRange((4, 4), (4, 16)),
)
elif isinstance(node.pattern, cst.MatchAs) and not node.pattern.name:
test.assertEqual(
self.get_metadata(PositionProvider, node),
CodeRange((5, 4), (5, 16)),
)
code = """
match status:
case b: pass
case c: pass
case _: pass
"""
wrapper = MetadataWrapper(parse_module(code))
wrapper.visit(MatchPositionVisitor())
class PositionProvidingCodegenStateTest(UnitTest):
def test_codegen_initial_position(self) -> None:
state = WhitespaceInclusivePositionProvidingCodegenState(
" " * 4, "\n", WhitespaceInclusivePositionProvider()
)
self.assertEqual(position(state), (1, 0))
def test_codegen_add_token(self) -> None:
state = WhitespaceInclusivePositionProvidingCodegenState(
" " * 4, "\n", WhitespaceInclusivePositionProvider()
)
state.add_token("1234")
self.assertEqual(position(state), (1, 4))
def test_codegen_add_tokens(self) -> None:
state = WhitespaceInclusivePositionProvidingCodegenState(
" " * 4, "\n", WhitespaceInclusivePositionProvider()
)
state.add_token("1234\n1234")
self.assertEqual(position(state), (2, 4))
def test_codegen_add_newline(self) -> None:
state = WhitespaceInclusivePositionProvidingCodegenState(
" " * 4, "\n", WhitespaceInclusivePositionProvider()
)
state.add_token("\n")
self.assertEqual(position(state), (2, 0))
def test_codegen_add_indent_tokens(self) -> None:
state = WhitespaceInclusivePositionProvidingCodegenState(
" " * 4, "\n", WhitespaceInclusivePositionProvider()
)
state.increase_indent(state.default_indent)
state.add_indent_tokens()
self.assertEqual(position(state), (1, 4))
def test_codegen_decrease_indent(self) -> None:
state = WhitespaceInclusivePositionProvidingCodegenState(
" " * 4, "\n", WhitespaceInclusivePositionProvider()
)
state.increase_indent(state.default_indent)
state.increase_indent(state.default_indent)
state.increase_indent(state.default_indent)
state.decrease_indent()
state.add_indent_tokens()
self.assertEqual(position(state), (1, 8))
def test_whitespace_inclusive_position(self) -> None:
# create a dummy node
node = cst.Pass()
# simulate codegen behavior for the dummy node
# generates the code " pass "
state = WhitespaceInclusivePositionProvidingCodegenState(
" " * 4, "\n", WhitespaceInclusivePositionProvider()
)
state.before_codegen(node)
state.add_token(" ")
with state.record_syntactic_position(node):
state.add_token("pass")
state.add_token(" ")
state.after_codegen(node)
# check whitespace is correctly recorded
self.assertEqual(state.provider._computed[node], CodeRange((1, 0), (1, 6)))
def test_position(self) -> None:
# create a dummy node
node = cst.Pass()
# simulate codegen behavior for the dummy node
# generates the code " pass "
state = PositionProvidingCodegenState(" " * 4, "\n", PositionProvider())
state.before_codegen(node)
state.add_token(" ")
with state.record_syntactic_position(node):
state.add_token("pass")
state.add_token(" ")
state.after_codegen(node)
# check syntactic position ignores whitespace
self.assertEqual(state.provider._computed[node], CodeRange((1, 1), (1, 5)))
|
