Coverage Report

Created: 2025-09-04 06:25

/src/cpython/Parser/string_parser.c
Line
Count
Source (jump to first uncovered line)
1
#include <Python.h>
2
#include "pycore_bytesobject.h"   // _PyBytes_DecodeEscape()
3
#include "pycore_unicodeobject.h" // _PyUnicode_DecodeUnicodeEscapeInternal()
4
5
#include "lexer/state.h"
6
#include "pegen.h"
7
#include "string_parser.h"
8
9
#include <stdbool.h>
10
11
//// STRING HANDLING FUNCTIONS ////
12
13
static int
14
warn_invalid_escape_sequence(Parser *p, const char* buffer, const char *first_invalid_escape, Token *t)
15
5.42k
{
16
5.42k
    if (p->call_invalid_rules) {
17
        // Do not report warnings if we are in the second pass of the parser
18
        // to avoid showing the warning twice.
19
2.29k
        return 0;
20
2.29k
    }
21
3.12k
    unsigned char c = (unsigned char)*first_invalid_escape;
22
3.12k
    if ((t->type == FSTRING_MIDDLE || t->type == FSTRING_END || t->type == TSTRING_MIDDLE || t->type == TSTRING_END)
23
3.12k
            && (c == '{' || c == '}')) {
24
        // in this case the tokenizer has already emitted a warning,
25
        // see Parser/tokenizer/helpers.c:warn_invalid_escape_sequence
26
490
        return 0;
27
490
    }
28
29
2.63k
    int octal = ('4' <= c && c <= '7');
30
2.63k
    PyObject *msg =
31
2.63k
        octal
32
2.63k
        ? PyUnicode_FromFormat(
33
568
              "\"\\%.3s\" is an invalid octal escape sequence. "
34
568
              "Such sequences will not work in the future. "
35
568
              "Did you mean \"\\\\%.3s\"? A raw string is also an option.",
36
568
              first_invalid_escape, first_invalid_escape)
37
2.63k
        : PyUnicode_FromFormat(
38
2.06k
              "\"\\%c\" is an invalid escape sequence. "
39
2.06k
              "Such sequences will not work in the future. "
40
2.06k
              "Did you mean \"\\\\%c\"? A raw string is also an option.",
41
2.06k
              c, c);
42
2.63k
    if (msg == NULL) {
43
0
        return -1;
44
0
    }
45
2.63k
    PyObject *category;
46
2.63k
    if (p->feature_version >= 12) {
47
2.63k
        category = PyExc_SyntaxWarning;
48
2.63k
    }
49
0
    else {
50
0
        category = PyExc_DeprecationWarning;
51
0
    }
52
53
    // Calculate the lineno and the col_offset of the invalid escape sequence
54
2.63k
    const char *start = buffer;
55
2.63k
    const char *end = first_invalid_escape;
56
2.63k
    int lineno = t->lineno;
57
2.63k
    int col_offset = t->col_offset;
58
31.1k
    while (start < end) {
59
28.5k
        if (*start == '\n') {
60
857
            lineno++;
61
857
            col_offset = 0;
62
857
        }
63
27.6k
        else {
64
27.6k
            col_offset++;
65
27.6k
        }
66
28.5k
        start++;
67
28.5k
    }
68
69
    // Count the number of quotes in the token
70
2.63k
    char first_quote = 0;
71
2.63k
    if (lineno == t->lineno) {
72
2.40k
        int quote_count = 0;
73
2.40k
        char* tok = PyBytes_AsString(t->bytes);
74
4.58k
        for (int i = 0; i < PyBytes_Size(t->bytes); i++) {
75
3.80k
            if (tok[i] == '\'' || tok[i] == '\"') {
76
2.17k
                if (quote_count == 0) {
77
1.73k
                    first_quote = tok[i];
78
1.73k
                }
79
2.17k
                if (tok[i] == first_quote) {
80
1.93k
                    quote_count++;
81
1.93k
                }
82
2.17k
            } else {
83
1.62k
                break;
84
1.62k
            }
85
3.80k
        }
86
87
2.40k
        col_offset += quote_count;
88
2.40k
    }
89
90
2.63k
    if (PyErr_WarnExplicitObject(category, msg, p->tok->filename,
91
2.63k
                                 lineno, NULL, NULL) < 0) {
92
0
        if (PyErr_ExceptionMatches(category)) {
93
            /* Replace the Syntax/DeprecationWarning exception with a SyntaxError
94
               to get a more accurate error report */
95
0
            PyErr_Clear();
96
97
            /* This is needed, in order for the SyntaxError to point to the token t,
98
               since _PyPegen_raise_error uses p->tokens[p->fill - 1] for the
99
               error location, if p->known_err_token is not set. */
100
0
            p->known_err_token = t;
101
0
            if (octal) {
102
0
                RAISE_ERROR_KNOWN_LOCATION(p, PyExc_SyntaxError, lineno, col_offset-1, lineno, col_offset+1,
103
0
                    "\"\\%.3s\" is an invalid octal escape sequence. "
104
0
                    "Did you mean \"\\\\%.3s\"? A raw string is also an option.",
105
0
                    first_invalid_escape, first_invalid_escape);
106
0
            }
107
0
            else {
108
0
                RAISE_ERROR_KNOWN_LOCATION(p, PyExc_SyntaxError, lineno, col_offset-1, lineno, col_offset+1,
109
0
                    "\"\\%c\" is an invalid escape sequence. "
110
0
                    "Did you mean \"\\\\%c\"? A raw string is also an option.",
111
0
                    c, c);
112
0
            }
113
0
        }
114
0
        Py_DECREF(msg);
115
0
        return -1;
116
0
    }
117
2.63k
    Py_DECREF(msg);
118
2.63k
    return 0;
119
2.63k
}
120
121
static PyObject *
122
decode_utf8(const char **sPtr, const char *end)
123
6.84k
{
124
6.84k
    const char *s;
125
6.84k
    const char *t;
126
6.84k
    t = s = *sPtr;
127
84.0k
    while (s < end && (*s & 0x80)) {
128
77.2k
        s++;
129
77.2k
    }
130
6.84k
    *sPtr = s;
131
6.84k
    return PyUnicode_DecodeUTF8(t, s - t, NULL);
132
6.84k
}
133
134
static PyObject *
135
decode_unicode_with_escapes(Parser *parser, const char *s, size_t len, Token *t)
136
31.3k
{
137
31.3k
    PyObject *v;
138
31.3k
    PyObject *u;
139
31.3k
    char *buf;
140
31.3k
    char *p;
141
31.3k
    const char *end;
142
143
    /* check for integer overflow */
144
31.3k
    if (len > (size_t)PY_SSIZE_T_MAX / 6) {
145
0
        return NULL;
146
0
    }
147
    /* "ä" (2 bytes) may become "\U000000E4" (10 bytes), or 1:5
148
       "\ä" (3 bytes) may become "\u005c\U000000E4" (16 bytes), or ~1:6 */
149
31.3k
    u = PyBytes_FromStringAndSize((char *)NULL, (Py_ssize_t)len * 6);
150
31.3k
    if (u == NULL) {
151
0
        return NULL;
152
0
    }
153
31.3k
    p = buf = PyBytes_AsString(u);
154
31.3k
    if (p == NULL) {
155
0
        return NULL;
156
0
    }
157
31.3k
    end = s + len;
158
256k
    while (s < end) {
159
226k
        if (*s == '\\') {
160
40.8k
            *p++ = *s++;
161
40.8k
            if (s >= end || *s & 0x80) {
162
2.13k
                strcpy(p, "u005c");
163
2.13k
                p += 5;
164
2.13k
                if (s >= end) {
165
678
                    break;
166
678
                }
167
2.13k
            }
168
40.8k
        }
169
225k
        if (*s & 0x80) {
170
6.84k
            PyObject *w;
171
6.84k
            int kind;
172
6.84k
            const void *data;
173
6.84k
            Py_ssize_t w_len;
174
6.84k
            Py_ssize_t i;
175
6.84k
            w = decode_utf8(&s, end);
176
6.84k
            if (w == NULL) {
177
35
                Py_DECREF(u);
178
35
                return NULL;
179
35
            }
180
6.81k
            kind = PyUnicode_KIND(w);
181
6.81k
            data = PyUnicode_DATA(w);
182
6.81k
            w_len = PyUnicode_GET_LENGTH(w);
183
33.5k
            for (i = 0; i < w_len; i++) {
184
26.7k
                Py_UCS4 chr = PyUnicode_READ(kind, data, i);
185
26.7k
                sprintf(p, "\\U%08x", chr);
186
26.7k
                p += 10;
187
26.7k
            }
188
            /* Should be impossible to overflow */
189
6.81k
            assert(p - buf <= PyBytes_GET_SIZE(u));
190
6.81k
            Py_DECREF(w);
191
6.81k
        }
192
218k
        else {
193
218k
            *p++ = *s++;
194
218k
        }
195
225k
    }
196
31.2k
    len = (size_t)(p - buf);
197
31.2k
    s = buf;
198
199
31.2k
    int first_invalid_escape_char;
200
31.2k
    const char *first_invalid_escape_ptr;
201
31.2k
    v = _PyUnicode_DecodeUnicodeEscapeInternal2(s, (Py_ssize_t)len, NULL, NULL,
202
31.2k
                                                &first_invalid_escape_char,
203
31.2k
                                                &first_invalid_escape_ptr);
204
205
    // HACK: later we can simply pass the line no, since we don't preserve the tokens
206
    // when we are decoding the string but we preserve the line numbers.
207
31.2k
    if (v != NULL && first_invalid_escape_ptr != NULL && t != NULL) {
208
4.60k
        if (warn_invalid_escape_sequence(parser, s, first_invalid_escape_ptr, t) < 0) {
209
            /* We have not decref u before because first_invalid_escape_ptr
210
               points inside u. */
211
0
            Py_XDECREF(u);
212
0
            Py_DECREF(v);
213
0
            return NULL;
214
0
        }
215
4.60k
    }
216
31.2k
    Py_XDECREF(u);
217
31.2k
    return v;
218
31.2k
}
219
220
static PyObject *
221
decode_bytes_with_escapes(Parser *p, const char *s, Py_ssize_t len, Token *t)
222
2.89k
{
223
2.89k
    int first_invalid_escape_char;
224
2.89k
    const char *first_invalid_escape_ptr;
225
2.89k
    PyObject *result = _PyBytes_DecodeEscape2(s, len, NULL,
226
2.89k
                                              &first_invalid_escape_char,
227
2.89k
                                              &first_invalid_escape_ptr);
228
2.89k
    if (result == NULL) {
229
4
        return NULL;
230
4
    }
231
232
2.89k
    if (first_invalid_escape_ptr != NULL) {
233
816
        if (warn_invalid_escape_sequence(p, s, first_invalid_escape_ptr, t) < 0) {
234
0
            Py_DECREF(result);
235
0
            return NULL;
236
0
        }
237
816
    }
238
2.89k
    return result;
239
2.89k
}
240
241
PyObject *
242
_PyPegen_decode_string(Parser *p, int raw, const char *s, size_t len, Token *t)
243
98.6k
{
244
98.6k
    if (raw) {
245
67.3k
        return PyUnicode_DecodeUTF8Stateful(s, (Py_ssize_t)len, NULL, NULL);
246
67.3k
    }
247
31.3k
    return decode_unicode_with_escapes(p, s, len, t);
248
98.6k
}
249
250
/* s must include the bracketing quote characters, and r, b &/or f prefixes
251
    (if any), and embedded escape sequences (if any). (f-strings are handled by the parser)
252
   _PyPegen_parse_string parses it, and returns the decoded Python string object. */
253
PyObject *
254
_PyPegen_parse_string(Parser *p, Token *t)
255
72.8k
{
256
72.8k
    const char *s = PyBytes_AsString(t->bytes);
257
72.8k
    if (s == NULL) {
258
0
        return NULL;
259
0
    }
260
261
72.8k
    size_t len;
262
72.8k
    int quote = Py_CHARMASK(*s);
263
72.8k
    int bytesmode = 0;
264
72.8k
    int rawmode = 0;
265
266
72.8k
    if (Py_ISALPHA(quote)) {
267
19.3k
        while (!bytesmode || !rawmode) {
268
18.8k
            if (quote == 'b' || quote == 'B') {
269
7.86k
                quote =(unsigned char)*++s;
270
7.86k
                bytesmode = 1;
271
7.86k
            }
272
10.9k
            else if (quote == 'u' || quote == 'U') {
273
1.03k
                quote = (unsigned char)*++s;
274
1.03k
            }
275
9.91k
            else if (quote == 'r' || quote == 'R') {
276
1.07k
                quote = (unsigned char)*++s;
277
1.07k
                rawmode = 1;
278
1.07k
            }
279
8.84k
            else {
280
8.84k
                break;
281
8.84k
            }
282
18.8k
        }
283
9.41k
    }
284
285
72.8k
    if (quote != '\'' && quote != '\"') {
286
1
        PyErr_BadInternalCall();
287
1
        return NULL;
288
1
    }
289
290
    /* Skip the leading quote char. */
291
72.8k
    s++;
292
72.8k
    len = strlen(s);
293
    // gh-120155: 's' contains at least the trailing quote,
294
    // so the code '--len' below is safe.
295
72.8k
    assert(len >= 1);
296
297
72.8k
    if (len > INT_MAX) {
298
0
        PyErr_SetString(PyExc_OverflowError, "string to parse is too long");
299
0
        return NULL;
300
0
    }
301
72.8k
    if (s[--len] != quote) {
302
        /* Last quote char must match the first. */
303
0
        PyErr_BadInternalCall();
304
0
        return NULL;
305
0
    }
306
72.8k
    if (len >= 4 && s[0] == quote && s[1] == quote) {
307
        /* A triple quoted string. We've already skipped one quote at
308
           the start and one at the end of the string. Now skip the
309
           two at the start. */
310
2.81k
        s += 2;
311
2.81k
        len -= 2;
312
        /* And check that the last two match. */
313
2.81k
        if (s[--len] != quote || s[--len] != quote) {
314
0
            PyErr_BadInternalCall();
315
0
            return NULL;
316
0
        }
317
2.81k
    }
318
319
    /* Avoid invoking escape decoding routines if possible. */
320
72.8k
    rawmode = rawmode || strchr(s, '\\') == NULL;
321
72.8k
    if (bytesmode) {
322
        /* Disallow non-ASCII characters. */
323
7.86k
        const char *ch;
324
103k
        for (ch = s; *ch; ch++) {
325
95.9k
            if (Py_CHARMASK(*ch) >= 0x80) {
326
9
                RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
327
9
                                   t,
328
9
                                   "bytes can only contain ASCII "
329
9
                                   "literal characters");
330
9
                return NULL;
331
9
            }
332
95.9k
        }
333
7.85k
        if (rawmode) {
334
4.96k
            return PyBytes_FromStringAndSize(s, (Py_ssize_t)len);
335
4.96k
        }
336
2.89k
        return decode_bytes_with_escapes(p, s, (Py_ssize_t)len, t);
337
7.85k
    }
338
64.9k
    return _PyPegen_decode_string(p, rawmode, s, len, t);
339
72.8k
}