File: test_template_strings.py

package info (click to toggle)
python-libcst 1.8.6-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid
  • size: 6,240 kB
  • sloc: python: 78,096; makefile: 15; sh: 2
file content (183 lines) | stat: -rw-r--r-- 6,302 bytes parent folder | download
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
# 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 Callable, Optional

import libcst as cst
from libcst import parse_expression
from libcst._nodes.tests.base import CSTNodeTest
from libcst.metadata import CodeRange
from libcst.testing.utils import data_provider


class TemplatedStringTest(CSTNodeTest):
    @data_provider(
        (
            # Simple t-string with only text
            (
                cst.TemplatedString(
                    parts=(cst.TemplatedStringText("hello world"),),
                ),
                't"hello world"',
                True,
            ),
            # t-string with one expression
            (
                cst.TemplatedString(
                    parts=(
                        cst.TemplatedStringText("hello "),
                        cst.TemplatedStringExpression(
                            expression=cst.Name("name"),
                        ),
                    ),
                ),
                't"hello {name}"',
                True,
            ),
            # t-string with multiple expressions
            (
                cst.TemplatedString(
                    parts=(
                        cst.TemplatedStringText("a="),
                        cst.TemplatedStringExpression(expression=cst.Name("a")),
                        cst.TemplatedStringText(", b="),
                        cst.TemplatedStringExpression(expression=cst.Name("b")),
                    ),
                ),
                't"a={a}, b={b}"',
                True,
                CodeRange((1, 0), (1, 15)),
            ),
            # t-string with nested expression
            (
                cst.TemplatedString(
                    parts=(
                        cst.TemplatedStringText("sum="),
                        cst.TemplatedStringExpression(
                            expression=cst.BinaryOperation(
                                left=cst.Name("a"),
                                operator=cst.Add(),
                                right=cst.Name("b"),
                            )
                        ),
                    ),
                ),
                't"sum={a + b}"',
                True,
            ),
            # t-string with spacing in expression
            (
                cst.TemplatedString(
                    parts=(
                        cst.TemplatedStringText("x = "),
                        cst.TemplatedStringExpression(
                            whitespace_before_expression=cst.SimpleWhitespace(" "),
                            expression=cst.Name("x"),
                            whitespace_after_expression=cst.SimpleWhitespace(" "),
                        ),
                    ),
                ),
                't"x = { x }"',
                True,
            ),
            # t-string with escaped braces
            (
                cst.TemplatedString(
                    parts=(cst.TemplatedStringText("{{foo}}"),),
                ),
                't"{{foo}}"',
                True,
            ),
            # t-string with only an expression
            (
                cst.TemplatedString(
                    parts=(
                        cst.TemplatedStringExpression(expression=cst.Name("value")),
                    ),
                ),
                't"{value}"',
                True,
            ),
            # t-string with whitespace and newlines
            (
                cst.TemplatedString(
                    parts=(
                        cst.TemplatedStringText("line1\\n"),
                        cst.TemplatedStringExpression(expression=cst.Name("x")),
                        cst.TemplatedStringText("\\nline2"),
                    ),
                ),
                't"line1\\n{x}\\nline2"',
                True,
            ),
            # t-string with parenthesis (not typical, but test node construction)
            (
                cst.TemplatedString(
                    lpar=(cst.LeftParen(),),
                    parts=(cst.TemplatedStringText("foo"),),
                    rpar=(cst.RightParen(),),
                ),
                '(t"foo")',
                True,
            ),
            # t-string with whitespace in delimiters
            (
                cst.TemplatedString(
                    lpar=(cst.LeftParen(whitespace_after=cst.SimpleWhitespace(" ")),),
                    parts=(cst.TemplatedStringText("foo"),),
                    rpar=(cst.RightParen(whitespace_before=cst.SimpleWhitespace(" ")),),
                ),
                '( t"foo" )',
                True,
            ),
            # Test TemplatedStringText and TemplatedStringExpression individually
            (
                cst.TemplatedStringText("abc"),
                "abc",
                False,
                CodeRange((1, 0), (1, 3)),
            ),
            (
                cst.TemplatedStringExpression(expression=cst.Name("foo")),
                "{foo}",
                False,
                CodeRange((1, 0), (1, 5)),
            ),
        )
    )
    def test_valid(
        self,
        node: cst.CSTNode,
        code: str,
        check_parsing: bool,
        position: Optional[CodeRange] = None,
    ) -> None:
        if check_parsing:
            self.validate_node(node, code, parse_expression, expected_position=position)
        else:
            self.validate_node(node, code, expected_position=position)

    @data_provider(
        (
            (
                lambda: cst.TemplatedString(
                    parts=(cst.TemplatedStringText("foo"),),
                    lpar=(cst.LeftParen(),),
                ),
                "left paren without right paren",
            ),
            (
                lambda: cst.TemplatedString(
                    parts=(cst.TemplatedStringText("foo"),),
                    rpar=(cst.RightParen(),),
                ),
                "right paren without left paren",
            ),
        )
    )
    def test_invalid(
        self, get_node: Callable[[], cst.CSTNode], expected_re: str
    ) -> None:
        self.assert_invalid(get_node, expected_re)