Coverage Report

Created: 2026-02-09 07:07

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/cpython/Parser/string_parser.c
Line
Count
Source
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
3.60k
{
16
3.60k
    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
1.63k
        return 0;
20
1.63k
    }
21
1.97k
    unsigned char c = (unsigned char)*first_invalid_escape;
22
1.97k
    if ((t->type == FSTRING_MIDDLE || t->type == FSTRING_END || t->type == TSTRING_MIDDLE || t->type == TSTRING_END)
23
1.25k
            && (c == '{' || c == '}')) {
24
        // in this case the tokenizer has already emitted a warning,
25
        // see Parser/tokenizer/helpers.c:warn_invalid_escape_sequence
26
352
        return 0;
27
352
    }
28
29
1.62k
    int octal = ('4' <= c && c <= '7');
30
1.62k
    PyObject *msg =
31
1.62k
        octal
32
1.62k
        ? PyUnicode_FromFormat(
33
244
              "\"\\%.3s\" is an invalid octal escape sequence. "
34
244
              "Such sequences will not work in the future. "
35
244
              "Did you mean \"\\\\%.3s\"? A raw string is also an option.",
36
244
              first_invalid_escape, first_invalid_escape)
37
1.62k
        : PyUnicode_FromFormat(
38
1.37k
              "\"\\%c\" is an invalid escape sequence. "
39
1.37k
              "Such sequences will not work in the future. "
40
1.37k
              "Did you mean \"\\\\%c\"? A raw string is also an option.",
41
1.37k
              c, c);
42
1.62k
    if (msg == NULL) {
43
0
        return -1;
44
0
    }
45
1.62k
    PyObject *category;
46
1.62k
    if (p->feature_version >= 12) {
47
1.62k
        category = PyExc_SyntaxWarning;
48
1.62k
    }
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
1.62k
    const char *start = buffer;
55
1.62k
    const char *end = first_invalid_escape;
56
1.62k
    int lineno = t->lineno;
57
1.62k
    int col_offset = t->col_offset;
58
21.5k
    while (start < end) {
59
19.9k
        if (*start == '\n') {
60
749
            lineno++;
61
749
            col_offset = 0;
62
749
        }
63
19.2k
        else {
64
19.2k
            col_offset++;
65
19.2k
        }
66
19.9k
        start++;
67
19.9k
    }
68
69
    // Count the number of quotes in the token
70
1.62k
    char first_quote = 0;
71
1.62k
    if (lineno == t->lineno) {
72
1.55k
        int quote_count = 0;
73
1.55k
        char* tok = PyBytes_AsString(t->bytes);
74
3.44k
        for (int i = 0; i < PyBytes_Size(t->bytes); i++) {
75
2.71k
            if (tok[i] == '\'' || tok[i] == '\"') {
76
1.89k
                if (quote_count == 0) {
77
1.21k
                    first_quote = tok[i];
78
1.21k
                }
79
1.89k
                if (tok[i] == first_quote) {
80
1.57k
                    quote_count++;
81
1.57k
                }
82
1.89k
            } else {
83
825
                break;
84
825
            }
85
2.71k
        }
86
87
1.55k
        col_offset += quote_count;
88
1.55k
    }
89
90
1.62k
    if (PyErr_WarnExplicitObject(category, msg, p->tok->filename,
91
1.62k
                                 lineno, p->tok->module, 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
1.62k
    Py_DECREF(msg);
118
1.62k
    return 0;
119
1.62k
}
120
121
static PyObject *
122
decode_utf8(const char **sPtr, const char *end)
123
4.96k
{
124
4.96k
    const char *s;
125
4.96k
    const char *t;
126
4.96k
    t = s = *sPtr;
127
33.5k
    while (s < end && (*s & 0x80)) {
128
28.5k
        s++;
129
28.5k
    }
130
4.96k
    *sPtr = s;
131
4.96k
    return PyUnicode_DecodeUTF8(t, s - t, NULL);
132
4.96k
}
133
134
static PyObject *
135
decode_unicode_with_escapes(Parser *parser, const char *s, size_t len, Token *t)
136
24.0k
{
137
24.0k
    PyObject *v;
138
24.0k
    PyObject *u;
139
24.0k
    char *buf;
140
24.0k
    char *p;
141
24.0k
    const char *end;
142
143
    /* check for integer overflow */
144
24.0k
    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
24.0k
    u = PyBytes_FromStringAndSize((char *)NULL, (Py_ssize_t)len * 6);
150
24.0k
    if (u == NULL) {
151
0
        return NULL;
152
0
    }
153
24.0k
    p = buf = PyBytes_AsString(u);
154
24.0k
    if (p == NULL) {
155
0
        return NULL;
156
0
    }
157
24.0k
    end = s + len;
158
198k
    while (s < end) {
159
174k
        if (*s == '\\') {
160
34.3k
            *p++ = *s++;
161
34.3k
            if (s >= end || *s & 0x80) {
162
1.79k
                strcpy(p, "u005c");
163
1.79k
                p += 5;
164
1.79k
                if (s >= end) {
165
771
                    break;
166
771
                }
167
1.79k
            }
168
34.3k
        }
169
173k
        if (*s & 0x80) {
170
4.96k
            PyObject *w;
171
4.96k
            int kind;
172
4.96k
            const void *data;
173
4.96k
            Py_ssize_t w_len;
174
4.96k
            Py_ssize_t i;
175
4.96k
            w = decode_utf8(&s, end);
176
4.96k
            if (w == NULL) {
177
0
                Py_DECREF(u);
178
0
                return NULL;
179
0
            }
180
4.96k
            kind = PyUnicode_KIND(w);
181
4.96k
            data = PyUnicode_DATA(w);
182
4.96k
            w_len = PyUnicode_GET_LENGTH(w);
183
14.8k
            for (i = 0; i < w_len; i++) {
184
9.85k
                Py_UCS4 chr = PyUnicode_READ(kind, data, i);
185
9.85k
                sprintf(p, "\\U%08x", chr);
186
9.85k
                p += 10;
187
9.85k
            }
188
            /* Should be impossible to overflow */
189
4.96k
            assert(p - buf <= PyBytes_GET_SIZE(u));
190
4.96k
            Py_DECREF(w);
191
4.96k
        }
192
169k
        else {
193
169k
            *p++ = *s++;
194
169k
        }
195
173k
    }
196
24.0k
    len = (size_t)(p - buf);
197
24.0k
    s = buf;
198
199
24.0k
    int first_invalid_escape_char;
200
24.0k
    const char *first_invalid_escape_ptr;
201
24.0k
    v = _PyUnicode_DecodeUnicodeEscapeInternal2(s, (Py_ssize_t)len, NULL, NULL,
202
24.0k
                                                &first_invalid_escape_char,
203
24.0k
                                                &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
24.0k
    if (v != NULL && first_invalid_escape_ptr != NULL && t != NULL) {
208
3.18k
        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
3.18k
    }
216
24.0k
    Py_XDECREF(u);
217
24.0k
    return v;
218
24.0k
}
219
220
static PyObject *
221
decode_bytes_with_escapes(Parser *p, const char *s, Py_ssize_t len, Token *t)
222
1.34k
{
223
1.34k
    int first_invalid_escape_char;
224
1.34k
    const char *first_invalid_escape_ptr;
225
1.34k
    PyObject *result = _PyBytes_DecodeEscape2(s, len, NULL,
226
1.34k
                                              &first_invalid_escape_char,
227
1.34k
                                              &first_invalid_escape_ptr);
228
1.34k
    if (result == NULL) {
229
4
        return NULL;
230
4
    }
231
232
1.34k
    if (first_invalid_escape_ptr != NULL) {
233
427
        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
427
    }
238
1.34k
    return result;
239
1.34k
}
240
241
PyObject *
242
_PyPegen_decode_string(Parser *p, int raw, const char *s, size_t len, Token *t)
243
70.0k
{
244
70.0k
    if (raw) {
245
45.9k
        return PyUnicode_DecodeUTF8Stateful(s, (Py_ssize_t)len, NULL, NULL);
246
45.9k
    }
247
24.0k
    return decode_unicode_with_escapes(p, s, len, t);
248
70.0k
}
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
47.0k
{
256
47.0k
    const char *s = PyBytes_AsString(t->bytes);
257
47.0k
    if (s == NULL) {
258
0
        return NULL;
259
0
    }
260
261
47.0k
    size_t len;
262
47.0k
    int quote = Py_CHARMASK(*s);
263
47.0k
    int bytesmode = 0;
264
47.0k
    int rawmode = 0;
265
266
47.0k
    if (Py_ISALPHA(quote)) {
267
16.4k
        while (!bytesmode || !rawmode) {
268
15.8k
            if (quote == 'b' || quote == 'B') {
269
5.04k
                quote =(unsigned char)*++s;
270
5.04k
                bytesmode = 1;
271
5.04k
            }
272
10.8k
            else if (quote == 'u' || quote == 'U') {
273
2.55k
                quote = (unsigned char)*++s;
274
2.55k
            }
275
8.27k
            else if (quote == 'r' || quote == 'R') {
276
911
                quote = (unsigned char)*++s;
277
911
                rawmode = 1;
278
911
            }
279
7.36k
            else {
280
7.36k
                break;
281
7.36k
            }
282
15.8k
        }
283
7.93k
    }
284
285
47.0k
    if (quote != '\'' && quote != '\"') {
286
1
        PyErr_BadInternalCall();
287
1
        return NULL;
288
1
    }
289
290
    /* Skip the leading quote char. */
291
47.0k
    s++;
292
47.0k
    len = strlen(s);
293
    // gh-120155: 's' contains at least the trailing quote,
294
    // so the code '--len' below is safe.
295
47.0k
    assert(len >= 1);
296
297
47.0k
    if (len > INT_MAX) {
298
0
        PyErr_SetString(PyExc_OverflowError, "string to parse is too long");
299
0
        return NULL;
300
0
    }
301
47.0k
    if (s[--len] != quote) {
302
        /* Last quote char must match the first. */
303
0
        PyErr_BadInternalCall();
304
0
        return NULL;
305
0
    }
306
47.0k
    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
1.30k
        s += 2;
311
1.30k
        len -= 2;
312
        /* And check that the last two match. */
313
1.30k
        if (s[--len] != quote || s[--len] != quote) {
314
0
            PyErr_BadInternalCall();
315
0
            return NULL;
316
0
        }
317
1.30k
    }
318
319
    /* Avoid invoking escape decoding routines if possible. */
320
47.0k
    rawmode = rawmode || strchr(s, '\\') == NULL;
321
47.0k
    if (bytesmode) {
322
        /* Disallow non-ASCII characters. */
323
5.04k
        const char *ch;
324
53.8k
        for (ch = s; *ch; ch++) {
325
48.8k
            if (Py_CHARMASK(*ch) >= 0x80) {
326
2
                RAISE_SYNTAX_ERROR_KNOWN_LOCATION(
327
2
                                   t,
328
2
                                   "bytes can only contain ASCII "
329
2
                                   "literal characters");
330
2
                return NULL;
331
2
            }
332
48.8k
        }
333
5.04k
        if (rawmode) {
334
3.69k
            return PyBytes_FromStringAndSize(s, (Py_ssize_t)len);
335
3.69k
        }
336
1.34k
        return decode_bytes_with_escapes(p, s, (Py_ssize_t)len, t);
337
5.04k
    }
338
42.0k
    return _PyPegen_decode_string(p, rawmode, s, len, t);
339
47.0k
}