Coverage Report

Created: 2026-10-17 06:15

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/cpython/Objects/structseq.c
Line
Count
Source
1
/* Implementation helper: a struct that looks like a tuple.
2
   See timemodule and posixmodule for example uses.
3
4
   The structseq helper is considered an internal CPython implementation
5
   detail.  Docs for modules using structseqs should call them
6
   "named tuples" (be sure to include a space between the two
7
   words and add a link back to the term in Docs/glossary.rst).
8
*/
9
10
#include "Python.h"
11
#include "pycore_initconfig.h"    // _PyStatus_OK()
12
#include "pycore_modsupport.h"    // _PyArg_NoPositional()
13
#include "pycore_object.h"        // _PyObject_GC_TRACK()
14
#include "pycore_structseq.h"     // PyStructSequence_InitType()
15
#include "pycore_tuple.h"         // _PyTuple_RESET_HASH_CACHE()
16
#include "pycore_typeobject.h"    // _PyStaticType_FiniBuiltin()
17
18
static const char visible_length_key[] = "n_sequence_fields";
19
static const char real_length_key[] = "n_fields";
20
static const char unnamed_fields_key[] = "n_unnamed_fields";
21
static const char match_args_key[] = "__match_args__";
22
23
/* Fields with this name have only a field index, not a field name.
24
   They are only allowed for indices < n_visible_fields. */
25
const char * const PyStructSequence_UnnamedField = "unnamed field";
26
27
static Py_ssize_t
28
get_type_attr_as_size(PyTypeObject *tp, PyObject *name)
29
529k
{
30
529k
    PyObject *v = PyDict_GetItemWithError(_PyType_GetDict(tp), name);
31
32
529k
    if (v == NULL) {
33
0
        if (PyErr_Occurred()) {
34
0
            return -1;
35
0
        }
36
0
        PyErr_Format(PyExc_TypeError,
37
0
                     "Missed attribute '%U' of type %s",
38
0
                     name, tp->tp_name);
39
0
        return -1;
40
0
    }
41
529k
    return PyLong_AsSsize_t(v);
42
529k
}
43
44
0
#define VISIBLE_SIZE(op) Py_SIZE(op)
45
#define VISIBLE_SIZE_TP(tp) \
46
260k
    get_type_attr_as_size(tp, &_Py_ID(n_sequence_fields))
47
#define REAL_SIZE_TP(tp) \
48
260k
    get_type_attr_as_size(tp, &_Py_ID(n_fields))
49
251k
#define REAL_SIZE(op) get_real_size((PyObject *)op)
50
51
#define UNNAMED_FIELDS_TP(tp) \
52
8.74k
    get_type_attr_as_size(tp, &_Py_ID(n_unnamed_fields))
53
0
#define UNNAMED_FIELDS(op) UNNAMED_FIELDS_TP(Py_TYPE(op))
54
55
static Py_ssize_t
56
get_real_size(PyObject *op)
57
251k
{
58
    // Compute the real size from the visible size (i.e., Py_SIZE()) and the
59
    // number of non-sequence fields accounted for in tp_basicsize.
60
251k
    Py_ssize_t hidden = Py_TYPE(op)->tp_basicsize - offsetof(PyStructSequence, ob_item);
61
251k
    return Py_SIZE(op) + hidden / sizeof(PyObject *);
62
251k
}
63
64
PyObject *
65
PyStructSequence_New(PyTypeObject *type)
66
251k
{
67
251k
    PyStructSequence *obj;
68
251k
    Py_ssize_t size = REAL_SIZE_TP(type), i;
69
251k
    if (size < 0) {
70
0
        return NULL;
71
0
    }
72
251k
    Py_ssize_t vsize = VISIBLE_SIZE_TP(type);
73
251k
    if (vsize < 0) {
74
0
        return NULL;
75
0
    }
76
77
251k
    obj = PyObject_GC_NewVar(PyStructSequence, type, size);
78
251k
    if (obj == NULL)
79
0
        return NULL;
80
251k
    _PyTuple_RESET_HASH_CACHE(obj);
81
    /* Hack the size of the variable object, so invisible fields don't appear
82
     to Python code. */
83
251k
    Py_SET_SIZE(obj, vsize);
84
4.96M
    for (i = 0; i < size; i++)
85
4.70M
        obj->ob_item[i] = NULL;
86
87
251k
    return (PyObject*)obj;
88
251k
}
89
90
void
91
PyStructSequence_SetItem(PyObject *op, Py_ssize_t index, PyObject *value)
92
4.61M
{
93
4.61M
    PyTupleObject *tuple = _PyTuple_CAST(op);
94
4.61M
    assert(0 <= index);
95
#ifndef NDEBUG
96
    Py_ssize_t n_fields = REAL_SIZE(op);
97
    assert(n_fields >= 0);
98
    assert(index < n_fields);
99
#endif
100
4.61M
    tuple->ob_item[index] = value;
101
4.61M
}
102
103
PyObject*
104
PyStructSequence_GetItem(PyObject *op, Py_ssize_t index)
105
1.62k
{
106
1.62k
    assert(0 <= index);
107
#ifndef NDEBUG
108
    Py_ssize_t n_fields = REAL_SIZE(op);
109
    assert(n_fields >= 0);
110
    assert(index < n_fields);
111
#endif
112
1.62k
    return PyTuple_GET_ITEM(op, index);
113
1.62k
}
114
115
116
static int
117
structseq_traverse(PyObject *op, visitproc visit, void *arg)
118
0
{
119
0
    PyStructSequence *obj = (PyStructSequence *)op;
120
0
    if (Py_TYPE(obj)->tp_flags & Py_TPFLAGS_HEAPTYPE) {
121
0
        Py_VISIT(Py_TYPE(obj));
122
0
    }
123
0
    Py_ssize_t i, size;
124
0
    size = REAL_SIZE(obj);
125
0
    for (i = 0; i < size; ++i) {
126
0
        Py_VISIT(obj->ob_item[i]);
127
0
    }
128
0
    return 0;
129
0
}
130
131
static void
132
structseq_dealloc(PyObject *op)
133
251k
{
134
251k
    PyStructSequence *obj = (PyStructSequence *)op;
135
251k
    Py_ssize_t i, size;
136
251k
    PyObject_GC_UnTrack(obj);
137
138
251k
    PyTypeObject *tp = Py_TYPE(obj);
139
    // gh-122527: We can't use REAL_SIZE_TP() or any macros that access the
140
    // type's dictionary here, because the dictionary may have already been
141
    // cleared by the garbage collector.
142
251k
    size = REAL_SIZE(obj);
143
4.95M
    for (i = 0; i < size; ++i) {
144
4.70M
        Py_XDECREF(obj->ob_item[i]);
145
4.70M
    }
146
251k
    PyObject_GC_Del(obj);
147
251k
    if (_PyType_HasFeature(tp, Py_TPFLAGS_HEAPTYPE)) {
148
251k
        Py_DECREF(tp);
149
251k
    }
150
251k
}
151
152
/*[clinic input]
153
class structseq "PyStructSequence *" "NULL"
154
[clinic start generated code]*/
155
/*[clinic end generated code: output=da39a3ee5e6b4b0d input=9d781c6922c77752]*/
156
157
#include "clinic/structseq.c.h"
158
159
/*[clinic input]
160
@classmethod
161
structseq.__new__ as structseq_new
162
    sequence as arg: object
163
    dict: object(c_default="NULL") = {}
164
[clinic start generated code]*/
165
166
static PyObject *
167
structseq_new_impl(PyTypeObject *type, PyObject *arg, PyObject *dict)
168
/*[clinic end generated code: output=baa082e788b171da input=90532511101aa3fb]*/
169
8.74k
{
170
8.74k
    PyStructSequence *res = NULL;
171
8.74k
    Py_ssize_t len, min_len, max_len, i, n_unnamed_fields;
172
173
8.74k
    min_len = VISIBLE_SIZE_TP(type);
174
8.74k
    if (min_len < 0) {
175
0
        return NULL;
176
0
    }
177
8.74k
    max_len = REAL_SIZE_TP(type);
178
8.74k
    if (max_len < 0) {
179
0
        return NULL;
180
0
    }
181
8.74k
    n_unnamed_fields = UNNAMED_FIELDS_TP(type);
182
8.74k
    if (n_unnamed_fields < 0) {
183
0
        return NULL;
184
0
    }
185
186
8.74k
    arg = PySequence_Fast(arg, "constructor requires a sequence");
187
188
8.74k
    if (!arg) {
189
0
        return NULL;
190
0
    }
191
192
8.74k
    if (dict && !PyDict_Check(dict)) {
193
0
        PyErr_Format(PyExc_TypeError,
194
0
                     "%.500s() takes a dict as second arg, if any",
195
0
                     type->tp_name);
196
0
        Py_DECREF(arg);
197
0
        return NULL;
198
0
    }
199
200
8.74k
    len = PySequence_Fast_GET_SIZE(arg);
201
8.74k
    if (min_len != max_len) {
202
8.74k
        if (len < min_len) {
203
0
            PyErr_Format(PyExc_TypeError,
204
0
                "%.500s() takes an at least %zd-sequence (%zd-sequence given)",
205
0
                type->tp_name, min_len, len);
206
0
            Py_DECREF(arg);
207
0
            return NULL;
208
0
        }
209
210
8.74k
        if (len > max_len) {
211
0
            PyErr_Format(PyExc_TypeError,
212
0
                "%.500s() takes an at most %zd-sequence (%zd-sequence given)",
213
0
                type->tp_name, max_len, len);
214
0
            Py_DECREF(arg);
215
0
            return NULL;
216
0
        }
217
8.74k
    }
218
0
    else {
219
0
        if (len != min_len) {
220
0
            PyErr_Format(PyExc_TypeError,
221
0
                         "%.500s() takes a %zd-sequence (%zd-sequence given)",
222
0
                         type->tp_name, min_len, len);
223
0
            Py_DECREF(arg);
224
0
            return NULL;
225
0
        }
226
0
    }
227
228
8.74k
    res = (PyStructSequence*) PyStructSequence_New(type);
229
8.74k
    if (res == NULL) {
230
0
        Py_DECREF(arg);
231
0
        return NULL;
232
0
    }
233
87.4k
    for (i = 0; i < len; ++i) {
234
78.7k
        PyObject *v = PySequence_Fast_GET_ITEM(arg, i);
235
78.7k
        res->ob_item[i] = Py_NewRef(v);
236
78.7k
    }
237
8.74k
    Py_DECREF(arg);
238
8.74k
    if (dict != NULL && PyDict_GET_SIZE(dict) > 0) {
239
0
        Py_ssize_t n_found_keys = 0;
240
0
        for (i = len; i < max_len; ++i) {
241
0
            PyObject *ob = NULL;
242
0
            const char *name = type->tp_members[i - n_unnamed_fields].name;
243
0
            if (PyDict_GetItemStringRef(dict, name, &ob) < 0) {
244
0
                Py_DECREF(res);
245
0
                return NULL;
246
0
            }
247
0
            if (ob == NULL) {
248
0
                ob = Py_NewRef(Py_None);
249
0
            }
250
0
            else {
251
0
                ++n_found_keys;
252
0
            }
253
0
            res->ob_item[i] = ob;
254
0
        }
255
0
        if (PyDict_GET_SIZE(dict) > n_found_keys) {
256
0
            PyErr_Format(PyExc_TypeError,
257
0
                         "%.500s() got duplicate or unexpected field name(s)",
258
0
                         type->tp_name);
259
0
            Py_DECREF(res);
260
0
            return NULL;
261
0
        }
262
8.74k
    } else {
263
26.2k
        for (i = len; i < max_len; ++i) {
264
17.4k
            res->ob_item[i] = Py_NewRef(Py_None);
265
17.4k
        }
266
8.74k
    }
267
268
8.74k
    _PyObject_GC_TRACK(res);
269
8.74k
    return (PyObject*) res;
270
8.74k
}
271
272
273
static PyObject *
274
structseq_repr(PyObject *op)
275
0
{
276
0
    PyStructSequence *obj = (PyStructSequence *)op;
277
0
    PyTypeObject *typ = Py_TYPE(obj);
278
279
    // count 5 characters per item: "x=1, "
280
0
    Py_ssize_t type_name_len = strlen(typ->tp_name);
281
0
    Py_ssize_t prealloc = (type_name_len + 1
282
0
                           + VISIBLE_SIZE(obj) * 5 + 1);
283
0
    PyUnicodeWriter *writer = PyUnicodeWriter_Create(prealloc);
284
0
    if (writer == NULL) {
285
0
        return NULL;
286
0
    }
287
288
    // Write "typename("
289
0
    if (PyUnicodeWriter_WriteUTF8(writer, typ->tp_name, type_name_len) < 0) {
290
0
        goto error;
291
0
    }
292
0
    if (PyUnicodeWriter_WriteChar(writer, '(') < 0) {
293
0
        goto error;
294
0
    }
295
296
0
    for (Py_ssize_t i=0; i < VISIBLE_SIZE(obj); i++) {
297
0
        if (i > 0) {
298
            // Write ", "
299
0
            if (PyUnicodeWriter_WriteChar(writer, ',') < 0) {
300
0
                goto error;
301
0
            }
302
0
            if (PyUnicodeWriter_WriteChar(writer, ' ') < 0) {
303
0
                goto error;
304
0
            }
305
0
        }
306
307
        // Write name
308
0
        const char *name_utf8 = typ->tp_members[i].name;
309
0
        if (name_utf8 == NULL) {
310
0
            PyErr_Format(PyExc_SystemError,
311
0
                         "In structseq_repr(), member %zd name is NULL"
312
0
                         " for type %.500s", i, typ->tp_name);
313
0
            goto error;
314
0
        }
315
0
        if (PyUnicodeWriter_WriteUTF8(writer, name_utf8, -1) < 0) {
316
0
            goto error;
317
0
        }
318
319
        // Write "=" + repr(value)
320
0
        if (PyUnicodeWriter_WriteChar(writer, '=') < 0) {
321
0
            goto error;
322
0
        }
323
0
        PyObject *value = PyStructSequence_GetItem((PyObject*)obj, i);
324
0
        assert(value != NULL);
325
0
        if (PyUnicodeWriter_WriteRepr(writer, value) < 0) {
326
0
            goto error;
327
0
        }
328
0
    }
329
330
0
    if (PyUnicodeWriter_WriteChar(writer, ')') < 0) {
331
0
        goto error;
332
0
    }
333
334
0
    return PyUnicodeWriter_Finish(writer);
335
336
0
error:
337
0
    PyUnicodeWriter_Discard(writer);
338
0
    return NULL;
339
0
}
340
341
342
static PyObject *
343
structseq_reduce(PyObject *op, PyObject *Py_UNUSED(ignored))
344
0
{
345
0
    PyStructSequence *self = (PyStructSequence*)op;
346
0
    PyObject* tup = NULL;
347
0
    PyObject* dict = NULL;
348
0
    PyObject* result;
349
0
    Py_ssize_t n_fields, n_visible_fields, n_unnamed_fields, i;
350
351
0
    n_fields = REAL_SIZE(self);
352
0
    if (n_fields < 0) {
353
0
        return NULL;
354
0
    }
355
0
    n_visible_fields = VISIBLE_SIZE(self);
356
0
    n_unnamed_fields = UNNAMED_FIELDS(self);
357
0
    if (n_unnamed_fields < 0) {
358
0
        return NULL;
359
0
    }
360
0
    tup = PyTuple_FromArray(self->ob_item, n_visible_fields);
361
0
    if (!tup)
362
0
        goto error;
363
364
0
    dict = PyDict_New();
365
0
    if (!dict)
366
0
        goto error;
367
368
0
    for (i = n_visible_fields; i < n_fields; i++) {
369
0
        const char *n = Py_TYPE(self)->tp_members[i-n_unnamed_fields].name;
370
0
        if (PyDict_SetItemString(dict, n, self->ob_item[i]) < 0)
371
0
            goto error;
372
0
    }
373
374
0
    result = Py_BuildValue("(O(OO))", Py_TYPE(self), tup, dict);
375
376
0
    Py_DECREF(tup);
377
0
    Py_DECREF(dict);
378
379
0
    return result;
380
381
0
error:
382
0
    Py_XDECREF(tup);
383
0
    Py_XDECREF(dict);
384
0
    return NULL;
385
0
}
386
387
388
/*[clinic input]
389
structseq.__replace__
390
391
    **changes: dict
392
393
Return a copy with new values for the specified fields.
394
[clinic start generated code]*/
395
396
static PyObject *
397
structseq___replace___impl(PyStructSequence *self, PyObject *changes)
398
/*[clinic end generated code: output=d90566015d93695f input=bf709d26db77afd6]*/
399
0
{
400
0
    PyStructSequence *result = NULL;
401
0
    Py_ssize_t n_fields, n_unnamed_fields, i;
402
403
0
    n_fields = REAL_SIZE(self);
404
0
    if (n_fields < 0) {
405
0
        return NULL;
406
0
    }
407
0
    n_unnamed_fields = UNNAMED_FIELDS(self);
408
0
    if (n_unnamed_fields < 0) {
409
0
        return NULL;
410
0
    }
411
0
    if (n_unnamed_fields > 0) {
412
0
        PyErr_Format(PyExc_TypeError,
413
0
                     "__replace__() is not supported for %.500s "
414
0
                     "because it has unnamed field(s)",
415
0
                     Py_TYPE(self)->tp_name);
416
0
        return NULL;
417
0
    }
418
419
0
    result = (PyStructSequence *) PyStructSequence_New(Py_TYPE(self));
420
0
    if (!result) {
421
0
        return NULL;
422
0
    }
423
424
    // We do not support types with unnamed fields, so we can iterate over
425
    // i >= n_visible_fields case without slicing with (i - n_unnamed_fields).
426
0
    for (i = 0; i < n_fields; ++i) {
427
0
        PyObject *ob;
428
0
        if (PyDict_PopString(changes, Py_TYPE(self)->tp_members[i].name,
429
0
                             &ob) < 0) {
430
0
            goto error;
431
0
        }
432
0
        if (ob == NULL) {
433
0
            ob = Py_NewRef(self->ob_item[i]);
434
0
        }
435
0
        result->ob_item[i] = ob;
436
0
    }
437
    // Check if there are any unexpected fields.
438
0
    if (PyDict_GET_SIZE(changes) > 0) {
439
0
        PyObject *names = PyDict_Keys(changes);
440
0
        if (names) {
441
0
            PyErr_Format(PyExc_TypeError, "Got unexpected field name(s): %R", names);
442
0
            Py_DECREF(names);
443
0
        }
444
0
        goto error;
445
0
    }
446
447
0
    _PyObject_GC_TRACK(result);
448
0
    return (PyObject *)result;
449
450
0
error:
451
0
    Py_DECREF(result);
452
0
    return NULL;
453
0
}
454
455
static PyMethodDef structseq_methods[] = {
456
    {"__reduce__", structseq_reduce, METH_NOARGS, NULL},
457
    STRUCTSEQ___REPLACE___METHODDEF
458
    {NULL, NULL}  // sentinel
459
};
460
461
static Py_ssize_t
462
722
count_members(PyStructSequence_Desc *desc, Py_ssize_t *n_unnamed_members) {
463
722
    Py_ssize_t i;
464
465
722
    *n_unnamed_members = 0;
466
5.80k
    for (i = 0; desc->fields[i].name != NULL; ++i) {
467
5.08k
        if (desc->fields[i].name == PyStructSequence_UnnamedField) {
468
111
            (*n_unnamed_members)++;
469
111
        }
470
5.08k
    }
471
722
    return i;
472
722
}
473
474
static int
475
initialize_structseq_dict(PyStructSequence_Desc *desc, PyObject* dict,
476
722
                          Py_ssize_t n_members, Py_ssize_t n_unnamed_members) {
477
722
    PyObject *v;
478
479
722
#define SET_DICT_FROM_SIZE(key, value)                                         \
480
2.16k
    do {                                                                       \
481
2.16k
        v = PyLong_FromSsize_t(value);                                         \
482
2.16k
        if (v == NULL) {                                                       \
483
0
            return -1;                                                         \
484
0
        }                                                                      \
485
2.16k
        if (PyDict_SetItemString(dict, key, v) < 0) {                          \
486
0
            Py_DECREF(v);                                                      \
487
0
            return -1;                                                         \
488
0
        }                                                                      \
489
2.16k
        Py_DECREF(v);                                                          \
490
2.16k
    } while (0)
491
492
722
    SET_DICT_FROM_SIZE(visible_length_key, desc->n_in_sequence);
493
722
    SET_DICT_FROM_SIZE(real_length_key, n_members);
494
722
    SET_DICT_FROM_SIZE(unnamed_fields_key, n_unnamed_members);
495
496
    // Prepare and set __match_args__
497
722
    Py_ssize_t i, k;
498
722
    PyObject* keys = PyTuple_New(desc->n_in_sequence);
499
722
    if (keys == NULL) {
500
0
        return -1;
501
0
    }
502
503
5.21k
    for (i = k = 0; i < desc->n_in_sequence; ++i) {
504
4.49k
        if (desc->fields[i].name == PyStructSequence_UnnamedField) {
505
111
            continue;
506
111
        }
507
4.38k
        PyObject* new_member = PyUnicode_FromString(desc->fields[i].name);
508
4.38k
        if (new_member == NULL) {
509
0
            goto error;
510
0
        }
511
4.38k
        PyTuple_SET_ITEM(keys, k, new_member);
512
4.38k
        k++;
513
4.38k
    }
514
515
722
    if (_PyTuple_Resize(&keys, k) == -1) {
516
0
        assert(keys == NULL);
517
0
        return -1;
518
0
    }
519
520
722
    if (PyDict_SetItemString(dict, match_args_key, keys) < 0) {
521
0
        goto error;
522
0
    }
523
524
722
    Py_DECREF(keys);
525
722
    return 0;
526
527
0
error:
528
0
    Py_DECREF(keys);
529
0
    return -1;
530
722
}
531
532
static PyMemberDef *
533
initialize_members(PyStructSequence_Desc *desc,
534
                   Py_ssize_t n_members, Py_ssize_t n_unnamed_members)
535
722
{
536
722
    PyMemberDef *members;
537
538
722
    members = PyMem_NEW(PyMemberDef, n_members - n_unnamed_members + 1);
539
722
    if (members == NULL) {
540
0
        PyErr_NoMemory();
541
0
        return NULL;
542
0
    }
543
544
722
    Py_ssize_t i, k;
545
5.80k
    for (i = k = 0; i < n_members; ++i) {
546
5.08k
        if (desc->fields[i].name == PyStructSequence_UnnamedField) {
547
111
            continue;
548
111
        }
549
550
        /* The names and docstrings in these MemberDefs are statically */
551
        /* allocated so it is expected that they'll outlive the MemberDef */
552
4.97k
        members[k].name = desc->fields[i].name;
553
4.97k
        members[k].type = _Py_T_OBJECT;
554
4.97k
        members[k].offset = offsetof(PyStructSequence, ob_item)
555
4.97k
          + i * sizeof(PyObject*);
556
4.97k
        members[k].flags = Py_READONLY;
557
4.97k
        members[k].doc = desc->fields[i].doc;
558
4.97k
        k++;
559
4.97k
    }
560
722
    members[k].name = NULL;
561
562
722
    return members;
563
722
}
564
565
566
static void
567
initialize_static_fields(PyTypeObject *type, PyStructSequence_Desc *desc,
568
                         PyMemberDef *tp_members, Py_ssize_t n_members,
569
                         unsigned long tp_flags)
570
296
{
571
296
    type->tp_name = desc->name;
572
    // Account for hidden members in tp_basicsize because they are not
573
    // included in the variable size.
574
296
    Py_ssize_t n_hidden = n_members - desc->n_in_sequence;
575
296
    type->tp_basicsize = sizeof(PyStructSequence) + (n_hidden - 1) * sizeof(PyObject *);
576
296
    type->tp_itemsize = sizeof(PyObject *);
577
296
    type->tp_dealloc = structseq_dealloc;
578
296
    type->tp_repr = structseq_repr;
579
296
    type->tp_doc = desc->doc;
580
296
    type->tp_base = &PyTuple_Type;
581
296
    type->tp_methods = structseq_methods;
582
296
    type->tp_new = structseq_new;
583
296
    type->tp_flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC | tp_flags;
584
296
    type->tp_traverse = structseq_traverse;
585
296
    type->tp_members = tp_members;
586
296
}
587
588
static int
589
initialize_static_type(PyTypeObject *type, PyStructSequence_Desc *desc,
590
0
                       Py_ssize_t n_members, Py_ssize_t n_unnamed_members) {
591
    /* initialize_static_fields() should have been called already. */
592
0
    if (PyType_Ready(type) < 0) {
593
0
        return -1;
594
0
    }
595
0
    Py_INCREF(type);
596
597
0
    if (initialize_structseq_dict(
598
0
            desc, _PyType_GetDict(type), n_members, n_unnamed_members) < 0) {
599
0
        Py_DECREF(type);
600
0
        return -1;
601
0
    }
602
603
0
    return 0;
604
0
}
605
606
int
607
_PyStructSequence_InitBuiltinWithFlags(PyInterpreterState *interp,
608
                                       PyTypeObject *type,
609
                                       PyStructSequence_Desc *desc,
610
                                       unsigned long tp_flags)
611
296
{
612
296
    if (Py_TYPE(type) == NULL) {
613
296
        Py_SET_TYPE(type, &PyType_Type);
614
296
    }
615
296
    Py_ssize_t n_unnamed_members;
616
296
    Py_ssize_t n_members = count_members(desc, &n_unnamed_members);
617
296
    PyMemberDef *members = NULL;
618
619
296
    if ((type->tp_flags & Py_TPFLAGS_READY) == 0) {
620
296
        assert(type->tp_name == NULL);
621
296
        assert(type->tp_members == NULL);
622
296
        assert(type->tp_base == NULL);
623
624
296
        members = initialize_members(desc, n_members, n_unnamed_members);
625
296
        if (members == NULL) {
626
0
            goto error;
627
0
        }
628
296
        initialize_static_fields(type, desc, members, n_members, tp_flags);
629
630
296
        _Py_SetImmortal((PyObject *)type);
631
296
    }
632
#ifndef NDEBUG
633
    else {
634
        // Ensure that the type was initialized.
635
        assert(type->tp_name != NULL);
636
        assert(type->tp_members != NULL);
637
        assert(type->tp_base == &PyTuple_Type);
638
        assert((type->tp_flags & _Py_TPFLAGS_STATIC_BUILTIN));
639
        assert(_Py_IsImmortal(type));
640
    }
641
#endif
642
643
296
    if (_PyStaticType_InitBuiltin(interp, type) < 0) {
644
0
        PyErr_Format(PyExc_RuntimeError,
645
0
                     "Can't initialize builtin type %s",
646
0
                     desc->name);
647
0
        goto error;
648
0
    }
649
650
296
    if (initialize_structseq_dict(
651
296
            desc, _PyType_GetDict(type), n_members, n_unnamed_members) < 0)
652
0
    {
653
0
        goto error;
654
0
    }
655
656
296
    return 0;
657
658
0
error:
659
0
    if (members != NULL) {
660
0
        PyMem_Free(members);
661
0
    }
662
0
    return -1;
663
296
}
664
665
int
666
PyStructSequence_InitType2(PyTypeObject *type, PyStructSequence_Desc *desc)
667
0
{
668
0
    PyMemberDef *members;
669
0
    Py_ssize_t n_members, n_unnamed_members;
670
671
#ifdef Py_TRACE_REFS
672
    /* if the type object was traced, remove it first
673
       before overwriting its storage */
674
    PyInterpreterState *interp = _PyInterpreterState_GET();
675
    if (_PyRefchain_IsTraced(interp, (PyObject *)type)) {
676
        _Py_ForgetReference((PyObject *)type);
677
    }
678
#endif
679
680
    /* PyTypeObject has already been initialized */
681
0
    if (Py_REFCNT(type) != 0) {
682
0
        PyErr_BadInternalCall();
683
0
        return -1;
684
0
    }
685
686
0
    n_members = count_members(desc, &n_unnamed_members);
687
0
    members = initialize_members(desc, n_members, n_unnamed_members);
688
0
    if (members == NULL) {
689
0
        return -1;
690
0
    }
691
0
    initialize_static_fields(type, desc, members, n_members, 0);
692
0
    if (initialize_static_type(type, desc, n_members, n_unnamed_members) < 0) {
693
0
        PyMem_Free(members);
694
0
        return -1;
695
0
    }
696
0
    return 0;
697
0
}
698
699
void
700
PyStructSequence_InitType(PyTypeObject *type, PyStructSequence_Desc *desc)
701
0
{
702
0
    (void)PyStructSequence_InitType2(type, desc);
703
0
}
704
705
706
/* This is exposed in the internal API, not the public API.
707
   It is only called on builtin static types, which are all
708
   initialized via _PyStructSequence_InitBuiltinWithFlags(). */
709
710
void
711
_PyStructSequence_FiniBuiltin(PyInterpreterState *interp, PyTypeObject *type)
712
0
{
713
    // Ensure that the type is initialized
714
0
    assert(type->tp_name != NULL);
715
0
    assert(type->tp_base == &PyTuple_Type);
716
0
    assert((type->tp_flags & _Py_TPFLAGS_STATIC_BUILTIN));
717
0
    assert(_Py_IsImmortal(type));
718
719
    // Cannot delete a type if it still has subclasses
720
0
    if (_PyType_HasSubclasses(type)) {
721
        // XXX Shouldn't this be an error?
722
0
        return;
723
0
    }
724
725
0
    _PyStaticType_FiniBuiltin(interp, type);
726
727
0
    if (_Py_IsMainInterpreter(interp)) {
728
        // Undo _PyStructSequence_InitBuiltinWithFlags().
729
0
        type->tp_name = NULL;
730
0
        PyMem_Free(type->tp_members);
731
0
        type->tp_members = NULL;
732
0
        type->tp_base = NULL;
733
0
    }
734
0
}
735
736
737
PyTypeObject *
738
_PyStructSequence_NewType(PyStructSequence_Desc *desc, unsigned long tp_flags)
739
426
{
740
426
    PyMemberDef *members;
741
426
    PyTypeObject *type;
742
426
    PyType_Slot slots[8];
743
426
    PyType_Spec spec;
744
426
    Py_ssize_t n_members, n_unnamed_members;
745
746
    /* Initialize MemberDefs */
747
426
    n_members = count_members(desc, &n_unnamed_members);
748
426
    members = initialize_members(desc, n_members, n_unnamed_members);
749
426
    if (members == NULL) {
750
0
        return NULL;
751
0
    }
752
753
    /* Initialize Slots */
754
426
    slots[0] = (PyType_Slot){Py_tp_dealloc, structseq_dealloc};
755
426
    slots[1] = (PyType_Slot){Py_tp_repr, structseq_repr};
756
426
    slots[2] = (PyType_Slot){Py_tp_doc, (void *)desc->doc};
757
426
    slots[3] = (PyType_Slot){Py_tp_methods, structseq_methods};
758
426
    slots[4] = (PyType_Slot){Py_tp_new, structseq_new};
759
426
    slots[5] = (PyType_Slot){Py_tp_members, members};
760
426
    slots[6] = (PyType_Slot){Py_tp_traverse, structseq_traverse};
761
426
    slots[7] = (PyType_Slot){0, 0};
762
763
    /* Initialize Spec */
764
    /* The name in this PyType_Spec is statically allocated so it is */
765
    /* expected that it'll outlive the PyType_Spec */
766
426
    spec.name = desc->name;
767
426
    Py_ssize_t hidden = n_members - desc->n_in_sequence;
768
426
    spec.basicsize = (int)(sizeof(PyStructSequence) + (hidden - 1) * sizeof(PyObject *));
769
426
    spec.itemsize = sizeof(PyObject *);
770
426
    spec.flags = Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC | tp_flags;
771
426
    spec.slots = slots;
772
773
426
    type = (PyTypeObject *)PyType_FromSpecWithBases(&spec, (PyObject *)&PyTuple_Type);
774
426
    PyMem_Free(members);
775
426
    if (type == NULL) {
776
0
        return NULL;
777
0
    }
778
779
426
    if (initialize_structseq_dict(
780
426
            desc, _PyType_GetDict(type), n_members, n_unnamed_members) < 0) {
781
0
        Py_DECREF(type);
782
0
        return NULL;
783
0
    }
784
785
426
    return type;
786
426
}
787
788
789
PyTypeObject *
790
PyStructSequence_NewType(PyStructSequence_Desc *desc)
791
389
{
792
389
    return _PyStructSequence_NewType(desc, 0);
793
389
}