Coverage Report

Created: 2026-02-09 07:07

next uncovered line (L), next uncovered region (R), next uncovered branch (B)
/src/cpython/Objects/clinic/listobject.c.h
Line
Count
Source
1
/*[clinic input]
2
preserve
3
[clinic start generated code]*/
4
5
#if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
6
#  include "pycore_gc.h"          // PyGC_Head
7
#  include "pycore_runtime.h"     // _Py_ID()
8
#endif
9
#include "pycore_abstract.h"      // _PyNumber_Index()
10
#include "pycore_critical_section.h"// Py_BEGIN_CRITICAL_SECTION()
11
#include "pycore_modsupport.h"    // _PyArg_CheckPositional()
12
13
PyDoc_STRVAR(list_insert__doc__,
14
"insert($self, index, object, /)\n"
15
"--\n"
16
"\n"
17
"Insert object before index.");
18
19
#define LIST_INSERT_METHODDEF    \
20
    {"insert", _PyCFunction_CAST(list_insert), METH_FASTCALL, list_insert__doc__},
21
22
static PyObject *
23
list_insert_impl(PyListObject *self, Py_ssize_t index, PyObject *object);
24
25
static PyObject *
26
list_insert(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
27
1.35k
{
28
1.35k
    PyObject *return_value = NULL;
29
1.35k
    Py_ssize_t index;
30
1.35k
    PyObject *object;
31
32
1.35k
    if (!_PyArg_CheckPositional("insert", nargs, 2, 2)) {
33
0
        goto exit;
34
0
    }
35
1.35k
    {
36
1.35k
        Py_ssize_t ival = -1;
37
1.35k
        PyObject *iobj = _PyNumber_Index(args[0]);
38
1.35k
        if (iobj != NULL) {
39
1.35k
            ival = PyLong_AsSsize_t(iobj);
40
1.35k
            Py_DECREF(iobj);
41
1.35k
        }
42
1.35k
        if (ival == -1 && PyErr_Occurred()) {
43
0
            goto exit;
44
0
        }
45
1.35k
        index = ival;
46
1.35k
    }
47
0
    object = args[1];
48
1.35k
    Py_BEGIN_CRITICAL_SECTION(self);
49
1.35k
    return_value = list_insert_impl((PyListObject *)self, index, object);
50
1.35k
    Py_END_CRITICAL_SECTION();
51
52
1.35k
exit:
53
1.35k
    return return_value;
54
1.35k
}
55
56
PyDoc_STRVAR(py_list_clear__doc__,
57
"clear($self, /)\n"
58
"--\n"
59
"\n"
60
"Remove all items from list.");
61
62
#define PY_LIST_CLEAR_METHODDEF    \
63
    {"clear", (PyCFunction)py_list_clear, METH_NOARGS, py_list_clear__doc__},
64
65
static PyObject *
66
py_list_clear_impl(PyListObject *self);
67
68
static PyObject *
69
py_list_clear(PyObject *self, PyObject *Py_UNUSED(ignored))
70
122
{
71
122
    PyObject *return_value = NULL;
72
73
122
    Py_BEGIN_CRITICAL_SECTION(self);
74
122
    return_value = py_list_clear_impl((PyListObject *)self);
75
122
    Py_END_CRITICAL_SECTION();
76
77
122
    return return_value;
78
122
}
79
80
PyDoc_STRVAR(list_copy__doc__,
81
"copy($self, /)\n"
82
"--\n"
83
"\n"
84
"Return a shallow copy of the list.");
85
86
#define LIST_COPY_METHODDEF    \
87
    {"copy", (PyCFunction)list_copy, METH_NOARGS, list_copy__doc__},
88
89
static PyObject *
90
list_copy_impl(PyListObject *self);
91
92
static PyObject *
93
list_copy(PyObject *self, PyObject *Py_UNUSED(ignored))
94
0
{
95
0
    PyObject *return_value = NULL;
96
97
0
    Py_BEGIN_CRITICAL_SECTION(self);
98
0
    return_value = list_copy_impl((PyListObject *)self);
99
0
    Py_END_CRITICAL_SECTION();
100
101
0
    return return_value;
102
0
}
103
104
PyDoc_STRVAR(list_append__doc__,
105
"append($self, object, /)\n"
106
"--\n"
107
"\n"
108
"Append object to the end of the list.");
109
110
#define LIST_APPEND_METHODDEF    \
111
    {"append", (PyCFunction)list_append, METH_O, list_append__doc__},
112
113
static PyObject *
114
list_append_impl(PyListObject *self, PyObject *object);
115
116
static PyObject *
117
list_append(PyObject *self, PyObject *object)
118
82.3M
{
119
82.3M
    PyObject *return_value = NULL;
120
121
82.3M
    Py_BEGIN_CRITICAL_SECTION(self);
122
82.3M
    return_value = list_append_impl((PyListObject *)self, object);
123
82.3M
    Py_END_CRITICAL_SECTION();
124
125
82.3M
    return return_value;
126
82.3M
}
127
128
PyDoc_STRVAR(list_extend__doc__,
129
"extend($self, iterable, /)\n"
130
"--\n"
131
"\n"
132
"Extend list by appending elements from the iterable.");
133
134
#define LIST_EXTEND_METHODDEF    \
135
    {"extend", (PyCFunction)list_extend, METH_O, list_extend__doc__},
136
137
static PyObject *
138
list_extend_impl(PyListObject *self, PyObject *iterable);
139
140
static PyObject *
141
list_extend(PyObject *self, PyObject *iterable)
142
11.6M
{
143
11.6M
    PyObject *return_value = NULL;
144
145
11.6M
    return_value = list_extend_impl((PyListObject *)self, iterable);
146
147
11.6M
    return return_value;
148
11.6M
}
149
150
PyDoc_STRVAR(list_pop__doc__,
151
"pop($self, index=-1, /)\n"
152
"--\n"
153
"\n"
154
"Remove and return item at index (default last).\n"
155
"\n"
156
"Raises IndexError if list is empty or index is out of range.");
157
158
#define LIST_POP_METHODDEF    \
159
    {"pop", _PyCFunction_CAST(list_pop), METH_FASTCALL, list_pop__doc__},
160
161
static PyObject *
162
list_pop_impl(PyListObject *self, Py_ssize_t index);
163
164
static PyObject *
165
list_pop(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
166
24.0M
{
167
24.0M
    PyObject *return_value = NULL;
168
24.0M
    Py_ssize_t index = -1;
169
170
24.0M
    if (!_PyArg_CheckPositional("pop", nargs, 0, 1)) {
171
0
        goto exit;
172
0
    }
173
24.0M
    if (nargs < 1) {
174
14.2M
        goto skip_optional;
175
14.2M
    }
176
9.86M
    {
177
9.86M
        Py_ssize_t ival = -1;
178
9.86M
        PyObject *iobj = _PyNumber_Index(args[0]);
179
9.86M
        if (iobj != NULL) {
180
9.86M
            ival = PyLong_AsSsize_t(iobj);
181
9.86M
            Py_DECREF(iobj);
182
9.86M
        }
183
9.86M
        if (ival == -1 && PyErr_Occurred()) {
184
0
            goto exit;
185
0
        }
186
9.86M
        index = ival;
187
9.86M
    }
188
24.0M
skip_optional:
189
24.0M
    Py_BEGIN_CRITICAL_SECTION(self);
190
24.0M
    return_value = list_pop_impl((PyListObject *)self, index);
191
24.0M
    Py_END_CRITICAL_SECTION();
192
193
24.0M
exit:
194
24.0M
    return return_value;
195
24.0M
}
196
197
PyDoc_STRVAR(list_sort__doc__,
198
"sort($self, /, *, key=None, reverse=False)\n"
199
"--\n"
200
"\n"
201
"Sort the list in ascending order and return None.\n"
202
"\n"
203
"The sort is in-place (i.e. the list itself is modified) and stable (i.e. the\n"
204
"order of two equal elements is maintained).\n"
205
"\n"
206
"If a key function is given, apply it once to each list item and sort them,\n"
207
"ascending or descending, according to their function values.\n"
208
"\n"
209
"The reverse flag can be set to sort in descending order.");
210
211
#define LIST_SORT_METHODDEF    \
212
    {"sort", _PyCFunction_CAST(list_sort), METH_FASTCALL|METH_KEYWORDS, list_sort__doc__},
213
214
static PyObject *
215
list_sort_impl(PyListObject *self, PyObject *keyfunc, int reverse);
216
217
static PyObject *
218
list_sort(PyObject *self, PyObject *const *args, Py_ssize_t nargs, PyObject *kwnames)
219
670k
{
220
670k
    PyObject *return_value = NULL;
221
670k
    #if defined(Py_BUILD_CORE) && !defined(Py_BUILD_CORE_MODULE)
222
223
670k
    #define NUM_KEYWORDS 2
224
670k
    static struct {
225
670k
        PyGC_Head _this_is_not_used;
226
670k
        PyObject_VAR_HEAD
227
670k
        Py_hash_t ob_hash;
228
670k
        PyObject *ob_item[NUM_KEYWORDS];
229
670k
    } _kwtuple = {
230
670k
        .ob_base = PyVarObject_HEAD_INIT(&PyTuple_Type, NUM_KEYWORDS)
231
670k
        .ob_hash = -1,
232
670k
        .ob_item = { &_Py_ID(key), &_Py_ID(reverse), },
233
670k
    };
234
670k
    #undef NUM_KEYWORDS
235
670k
    #define KWTUPLE (&_kwtuple.ob_base.ob_base)
236
237
    #else  // !Py_BUILD_CORE
238
    #  define KWTUPLE NULL
239
    #endif  // !Py_BUILD_CORE
240
241
670k
    static const char * const _keywords[] = {"key", "reverse", NULL};
242
670k
    static _PyArg_Parser _parser = {
243
670k
        .keywords = _keywords,
244
670k
        .fname = "sort",
245
670k
        .kwtuple = KWTUPLE,
246
670k
    };
247
670k
    #undef KWTUPLE
248
670k
    PyObject *argsbuf[2];
249
670k
    Py_ssize_t noptargs = nargs + (kwnames ? PyTuple_GET_SIZE(kwnames) : 0) - 0;
250
670k
    PyObject *keyfunc = Py_None;
251
670k
    int reverse = 0;
252
253
670k
    args = _PyArg_UnpackKeywords(args, nargs, NULL, kwnames, &_parser,
254
670k
            /*minpos*/ 0, /*maxpos*/ 0, /*minkw*/ 0, /*varpos*/ 0, argsbuf);
255
670k
    if (!args) {
256
0
        goto exit;
257
0
    }
258
670k
    if (!noptargs) {
259
128k
        goto skip_optional_kwonly;
260
128k
    }
261
542k
    if (args[0]) {
262
542k
        keyfunc = args[0];
263
542k
        if (!--noptargs) {
264
541k
            goto skip_optional_kwonly;
265
541k
        }
266
542k
    }
267
781
    reverse = PyObject_IsTrue(args[1]);
268
781
    if (reverse < 0) {
269
0
        goto exit;
270
0
    }
271
670k
skip_optional_kwonly:
272
670k
    Py_BEGIN_CRITICAL_SECTION(self);
273
670k
    return_value = list_sort_impl((PyListObject *)self, keyfunc, reverse);
274
670k
    Py_END_CRITICAL_SECTION();
275
276
670k
exit:
277
670k
    return return_value;
278
670k
}
279
280
PyDoc_STRVAR(list_reverse__doc__,
281
"reverse($self, /)\n"
282
"--\n"
283
"\n"
284
"Reverse *IN PLACE*.");
285
286
#define LIST_REVERSE_METHODDEF    \
287
    {"reverse", (PyCFunction)list_reverse, METH_NOARGS, list_reverse__doc__},
288
289
static PyObject *
290
list_reverse_impl(PyListObject *self);
291
292
static PyObject *
293
list_reverse(PyObject *self, PyObject *Py_UNUSED(ignored))
294
0
{
295
0
    PyObject *return_value = NULL;
296
297
0
    Py_BEGIN_CRITICAL_SECTION(self);
298
0
    return_value = list_reverse_impl((PyListObject *)self);
299
0
    Py_END_CRITICAL_SECTION();
300
301
0
    return return_value;
302
0
}
303
304
PyDoc_STRVAR(list_index__doc__,
305
"index($self, value, start=0, stop=sys.maxsize, /)\n"
306
"--\n"
307
"\n"
308
"Return first index of value.\n"
309
"\n"
310
"Raises ValueError if the value is not present.");
311
312
#define LIST_INDEX_METHODDEF    \
313
    {"index", _PyCFunction_CAST(list_index), METH_FASTCALL, list_index__doc__},
314
315
static PyObject *
316
list_index_impl(PyListObject *self, PyObject *value, Py_ssize_t start,
317
                Py_ssize_t stop);
318
319
static PyObject *
320
list_index(PyObject *self, PyObject *const *args, Py_ssize_t nargs)
321
0
{
322
0
    PyObject *return_value = NULL;
323
0
    PyObject *value;
324
0
    Py_ssize_t start = 0;
325
0
    Py_ssize_t stop = PY_SSIZE_T_MAX;
326
327
0
    if (!_PyArg_CheckPositional("index", nargs, 1, 3)) {
328
0
        goto exit;
329
0
    }
330
0
    value = args[0];
331
0
    if (nargs < 2) {
332
0
        goto skip_optional;
333
0
    }
334
0
    if (!_PyEval_SliceIndexNotNone(args[1], &start)) {
335
0
        goto exit;
336
0
    }
337
0
    if (nargs < 3) {
338
0
        goto skip_optional;
339
0
    }
340
0
    if (!_PyEval_SliceIndexNotNone(args[2], &stop)) {
341
0
        goto exit;
342
0
    }
343
0
skip_optional:
344
0
    return_value = list_index_impl((PyListObject *)self, value, start, stop);
345
346
0
exit:
347
0
    return return_value;
348
0
}
349
350
PyDoc_STRVAR(list_count__doc__,
351
"count($self, value, /)\n"
352
"--\n"
353
"\n"
354
"Return number of occurrences of value.");
355
356
#define LIST_COUNT_METHODDEF    \
357
    {"count", (PyCFunction)list_count, METH_O, list_count__doc__},
358
359
static PyObject *
360
list_count_impl(PyListObject *self, PyObject *value);
361
362
static PyObject *
363
list_count(PyObject *self, PyObject *value)
364
12
{
365
12
    PyObject *return_value = NULL;
366
367
12
    return_value = list_count_impl((PyListObject *)self, value);
368
369
12
    return return_value;
370
12
}
371
372
PyDoc_STRVAR(list_remove__doc__,
373
"remove($self, value, /)\n"
374
"--\n"
375
"\n"
376
"Remove first occurrence of value.\n"
377
"\n"
378
"Raises ValueError if the value is not present.");
379
380
#define LIST_REMOVE_METHODDEF    \
381
    {"remove", (PyCFunction)list_remove, METH_O, list_remove__doc__},
382
383
static PyObject *
384
list_remove_impl(PyListObject *self, PyObject *value);
385
386
static PyObject *
387
list_remove(PyObject *self, PyObject *value)
388
9.89k
{
389
9.89k
    PyObject *return_value = NULL;
390
391
9.89k
    Py_BEGIN_CRITICAL_SECTION(self);
392
9.89k
    return_value = list_remove_impl((PyListObject *)self, value);
393
9.89k
    Py_END_CRITICAL_SECTION();
394
395
9.89k
    return return_value;
396
9.89k
}
397
398
PyDoc_STRVAR(list___init____doc__,
399
"list(iterable=(), /)\n"
400
"--\n"
401
"\n"
402
"Built-in mutable sequence.\n"
403
"\n"
404
"If no argument is given, the constructor creates a new empty list.\n"
405
"The argument must be an iterable if specified.");
406
407
static int
408
list___init___impl(PyListObject *self, PyObject *iterable);
409
410
static int
411
list___init__(PyObject *self, PyObject *args, PyObject *kwargs)
412
7.55M
{
413
7.55M
    int return_value = -1;
414
7.55M
    PyTypeObject *base_tp = &PyList_Type;
415
7.55M
    PyObject *iterable = NULL;
416
417
7.55M
    if ((Py_IS_TYPE(self, base_tp) ||
418
7.55M
         Py_TYPE(self)->tp_new == base_tp->tp_new) &&
419
7.55M
        !_PyArg_NoKeywords("list", kwargs)) {
420
0
        goto exit;
421
0
    }
422
7.55M
    if (!_PyArg_CheckPositional("list", PyTuple_GET_SIZE(args), 0, 1)) {
423
0
        goto exit;
424
0
    }
425
7.55M
    if (PyTuple_GET_SIZE(args) < 1) {
426
7.55M
        goto skip_optional;
427
7.55M
    }
428
0
    iterable = PyTuple_GET_ITEM(args, 0);
429
7.55M
skip_optional:
430
7.55M
    return_value = list___init___impl((PyListObject *)self, iterable);
431
432
7.55M
exit:
433
7.55M
    return return_value;
434
7.55M
}
435
436
PyDoc_STRVAR(list___sizeof____doc__,
437
"__sizeof__($self, /)\n"
438
"--\n"
439
"\n"
440
"Return the size of the list in memory, in bytes.");
441
442
#define LIST___SIZEOF___METHODDEF    \
443
    {"__sizeof__", (PyCFunction)list___sizeof__, METH_NOARGS, list___sizeof____doc__},
444
445
static PyObject *
446
list___sizeof___impl(PyListObject *self);
447
448
static PyObject *
449
list___sizeof__(PyObject *self, PyObject *Py_UNUSED(ignored))
450
0
{
451
0
    return list___sizeof___impl((PyListObject *)self);
452
0
}
453
454
PyDoc_STRVAR(list___reversed____doc__,
455
"__reversed__($self, /)\n"
456
"--\n"
457
"\n"
458
"Return a reverse iterator over the list.");
459
460
#define LIST___REVERSED___METHODDEF    \
461
    {"__reversed__", (PyCFunction)list___reversed__, METH_NOARGS, list___reversed____doc__},
462
463
static PyObject *
464
list___reversed___impl(PyListObject *self);
465
466
static PyObject *
467
list___reversed__(PyObject *self, PyObject *Py_UNUSED(ignored))
468
36.6M
{
469
36.6M
    return list___reversed___impl((PyListObject *)self);
470
36.6M
}
471
/*[clinic end generated code: output=ae13fc2b56dc27c2 input=a9049054013a1b77]*/