cpython/Objects/tupleobject.c at structseq_tracking · eendebakpt/cpython · GitHub

Repository navigation

History

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

184

185

186

187

188

189

190

191

192

193

194

195

196

197

198

199

200

201

202

203

204

205

206

207

208

209

210

211

212

213

214

215

216

217

218

219

220

221

222

223

224

225

226

227

228

229

230

231

232

233

234

235

236

237

238

239

240

241

242

243

244

245

246

247

248

249

250

251

252

253

254

255

256

257

258

259

260

261

262

263

264

265

266

267

268

269

270

271

272

273

274

275

276

277

278

279

280

281

282

283

284

285

286

287

288

289

290

291

292

293

294

295

296

297

298

299

300

301

302

303

304

305

306

307

308

309

310

311

312

313

314

315

316

317

318

319

320

321

322

323

324

325

326

327

328

329

330

331

332

333

334

335

336

337

338

339

340

341

342

343

344

345

346

347

348

349

350

351

352

353

354

355

356

357

358

359

360

361

362

363

364

365

366

367

368

369

370

371

372

373

374

375

376

377

378

379

380

381

382

383

384

385

386

387

388

389

390

391

392

393

394

395

396

397

398

399

400

401

402

403

404

405

406

407

408

409

410

411

412

413

414

415

416

417

418

419

420

421

422

423

424

425

426

427

428

429

430

431

432

433

434

435

436

437

438

439

440

441

442

443

444

445

446

447

448

449

450

451

452

453

454

455

456

457

458

459

460

461

462

463

464

465

466

467

468

469

470

471

472

473

474

475

476

477

478

479

480

481

482

483

484

485

486

487

488

489

490

491

492

493

494

495

496

497

498

499

500

501

502

503

504

505

506

507

508

509

510

511

512

513

514

515

516

517

518

519

520

521

522

523

524

525

526

527

528

529

530

531

532

533

534

535

536

537

538

539

540

541

542

543

544

545

546

547

548

549

550

551

552

553

554

555

556

557

558

559

560

561

562

563

564

565

566

567

568

569

570

571

572

573

574

575

576

577

578

579

580

581

582

583

584

585

586

587

588

589

590

591

592

593

594

595

596

597

598

599

600

601

602

603

604

605

606

607

608

609

610

611

612

613

614

615

616

617

618

619

620

621

622

623

624

625

626

627

628

629

630

631

632

633

634

635

636

637

638

639

640

641

642

643

644

645

646

647

648

649

650

651

652

653

654

655

656

657

658

659

660

661

662

663

664

665

666

667

668

669

670

671

672

673

674

675

676

677

678

679

680

681

682

683

684

685

686

687

688

689

690

691

692

693

694

695

696

697

698

699

700

701

702

703

704

705

706

707

708

709

710

711

712

713

714

715

716

717

718

719

720

721

722

723

724

725

726

727

728

729

730

731

732

733

734

735

736

737

738

739

740

741

742

743

744

745

746

747

748

749

750

751

752

753

754

755

756

757

758

759

760

761

762

763

764

765

766

767

768

769

770

771

772

773

774

775

776

777

778

779

780

781

782

783

784

785

786

787

788

789

790

791

792

793

794

795

796

797

798

799

800

801

802

803

804

805

806

807

808

809

810

811

812

813

814

815

816

817

818

819

820

821

822

823

824

825

826

827

828

829

830

831

832

833

834

835

836

837

838

839

840

841

842

843

844

845

846

847

848

849

850

851

852

853

854

855

856

857

858

859

860

861

862

863

864

865

866

867

868

869

870

871

872

873

874

875

876

877

878

879

880

881

882

883

884

885

886

887

888

889

890

891

892

893

894

895

896

897

898

899

900

901

902

903

904

905

906

907

908

909

910

911

912

913

914

915

916

917

918

919

920

921

922

923

924

925

926

927

928

929

930

931

932

933

934

935

936

937

938

939

940

941

942

943

944

945

946

947

948

949

950

951

952

953

954

955

956

957

958

959

960

961

962

963

964

965

966

967

968

969

970

971

972

973

974

975

976

977

978

979

980

981

982

983

984

985

986

987

988

989

990

991

992

993

994

995

996

997

998

999

1000

/* Tuple object implementation */

#include "Python.h"

#include "pycore_abstract.h" // _PyIndex_Check()

#include "pycore_ceval.h" // _PyEval_GetBuiltin()

#include "pycore_freelist.h" // _Py_FREELIST_PUSH()

#include "pycore_gc.h" // _PyObject_GC_IS_TRACKED()

#include "pycore_list.h" // _Py_memory_repeat()

#include "pycore_modsupport.h" // _PyArg_NoKwnames()

#include "pycore_object.h" // _PyObject_GC_TRACK()

#include "pycore_stackref.h" // PyStackRef_AsPyObjectSteal()

#include "pycore_tuple.h" // _PyTupleIterObject

/*[clinic input]

class tuple "PyTupleObject *" "&PyTuple_Type"

[clinic start generated code]*/

/*[clinic end generated code: output=da39a3ee5e6b4b0d input=f051ba3cfdf9a189]*/

#include "clinic/tupleobject.c.h"

static inline int maybe_freelist_push(PyTupleObject *);

/* Allocate an uninitialized tuple object. Before making it public, following

steps must be done:

- Initialize its items.

- Call _PyObject_GC_TRACK() on it.

Because the empty tuple is always reused and it's already tracked by GC,

this function must not be called with size == 0 (unless from PyTuple_New()

which wraps this function).

static PyTupleObject *

tuple_alloc(Py_ssize_t size)

{

if (size < 0) {

PyErr_BadInternalCall();

return NULL;

}

assert(size != 0); // The empty tuple is statically allocated.

Py_ssize_t index = size - 1;

if (index < PyTuple_MAXSAVESIZE) {

PyTupleObject *op = _Py_FREELIST_POP(PyTupleObject, tuples[index]);

if (op != NULL) {

_PyTuple_RESET_HASH_CACHE(op);

return op;

}

/* Check for overflow */

if ((size_t)size > ((size_t)PY_SSIZE_T_MAX - (sizeof(PyTupleObject) -

sizeof(PyObject *))) / sizeof(PyObject *)) {

return (PyTupleObject *)PyErr_NoMemory();

}

PyTupleObject *result = PyObject_GC_NewVar(PyTupleObject, &PyTuple_Type, size);

if (result != NULL) {

_PyTuple_RESET_HASH_CACHE(result);

}

return result;

}

// The empty tuple singleton is not tracked by the GC.

// It does not contain any Python object.

// Note that tuple subclasses have their own empty instances.

static inline PyObject *

tuple_get_empty(void)

{

return (PyObject *)&_Py_SINGLETON(tuple_empty);

}

PyObject *

PyTuple_New(Py_ssize_t size)

{

PyTupleObject *op;

if (size == 0) {

return tuple_get_empty();

}

op = tuple_alloc(size);

if (op == NULL) {

return NULL;

}

for (Py_ssize_t i = 0; i < size; i++) {

op->ob_item[i] = NULL;

}

_PyObject_GC_TRACK(op);

return (PyObject *) op;

}

Py_ssize_t

PyTuple_Size(PyObject *op)

{

if (!PyTuple_Check(op)) {

PyErr_BadInternalCall();

return -1;

}

else

return Py_SIZE(op);

}

PyObject *

PyTuple_GetItem(PyObject *op, Py_ssize_t i)

{

if (!PyTuple_Check(op)) {

PyErr_BadInternalCall();

return NULL;

}

if (i < 0 || i >= Py_SIZE(op)) {

PyErr_SetString(PyExc_IndexError, "tuple index out of range");

return NULL;

}

return ((PyTupleObject *)op) -> ob_item[i];

}

int

PyTuple_SetItem(PyObject *op, Py_ssize_t i, PyObject *newitem)

{

PyObject **p;

if (!PyTuple_Check(op) || !_PyObject_IsUniquelyReferenced(op)) {

Py_XDECREF(newitem);

PyErr_BadInternalCall();

return -1;

}

if (i < 0 || i >= Py_SIZE(op)) {

Py_XDECREF(newitem);

PyErr_SetString(PyExc_IndexError,

"tuple assignment index out of range");

return -1;

}

p = ((PyTupleObject *)op) -> ob_item + i;

Py_XSETREF(*p, newitem);

return 0;

}

void

_PyTuple_MaybeUntrack(PyObject *op)

{

PyTupleObject *t;

Py_ssize_t i, n;

if (!PyTuple_CheckExact(op) || !_PyObject_GC_IS_TRACKED(op))

return;

t = (PyTupleObject *) op;

n = Py_SIZE(t);

for (i = 0; i < n; i++) {

PyObject *elt = PyTuple_GET_ITEM(t, i);

/* Tuple with NULL elements aren't

fully constructed, don't untrack

them yet. */

if (!elt ||

_PyObject_GC_MAY_BE_TRACKED(elt))

return;

}

_PyObject_GC_UNTRACK(op);

}

/* Fast, but conservative check if an object maybe tracked

May return true for an object that is not tracked,

Will always return true for an object that is tracked.

This is a temporary workaround until _PyObject_GC_IS_TRACKED

becomes fast and safe to call on non-GC objects.

static bool

maybe_tracked(PyObject *ob)

{

return _PyType_IS_GC(Py_TYPE(ob));

}

PyObject *

PyTuple_Pack(Py_ssize_t n, ...)

{

Py_ssize_t i;

PyObject *o;

PyObject **items;

va_list vargs;

bool track = false;

if (n == 0) {

return tuple_get_empty();

}

va_start(vargs, n);

PyTupleObject *result = tuple_alloc(n);

if (result == NULL) {

va_end(vargs);

return NULL;

}

items = result->ob_item;

for (i = 0; i < n; i++) {

o = va_arg(vargs, PyObject *);

if (!track && maybe_tracked(o)) {

track = true;

}

items[i] = Py_NewRef(o);

}

va_end(vargs);

if (track) {

_PyObject_GC_TRACK(result);

}

return (PyObject *)result;

}

PyObject *

_PyTuple_FromPair(PyObject *first, PyObject *second)

{

assert(first != NULL);

assert(second != NULL);

return _PyTuple_FromPairSteal(Py_NewRef(first), Py_NewRef(second));

}

PyObject *

_PyTuple_FromPairSteal(PyObject *first, PyObject *second)

{

assert(first != NULL);

assert(second != NULL);

PyTupleObject *op = tuple_alloc(2);

if (op == NULL) {

Py_DECREF(first);

Py_DECREF(second);

return NULL;

}

PyObject **items = op->ob_item;

items[0] = first;

items[1] = second;

if (maybe_tracked(first) || maybe_tracked(second)) {

_PyObject_GC_TRACK(op);

}

return (PyObject *)op;

}

/* Methods */

static void

tuple_dealloc(PyObject *self)

{

PyTupleObject *op = _PyTuple_CAST(self);

if (Py_SIZE(op) == 0) {

/* The empty tuple is statically allocated. */

if (op == &_Py_SINGLETON(tuple_empty)) {

#ifdef Py_DEBUG

_Py_FatalRefcountError("deallocating the empty tuple singleton");

#else

return;

#endif

}

#ifdef Py_DEBUG

/* tuple subclasses have their own empty instances. */

assert(!PyTuple_CheckExact(op));

#endif

}

PyObject_GC_UnTrack(op);

Py_ssize_t i = Py_SIZE(op);

while (--i >= 0) {

Py_XDECREF(op->ob_item[i]);

}

// This will abort on the empty singleton (if there is one).

if (!maybe_freelist_push(op)) {

Py_TYPE(op)->tp_free((PyObject *)op);

}

static PyObject *

tuple_repr(PyObject *self)

{

PyTupleObject *v = _PyTuple_CAST(self);

Py_ssize_t n = PyTuple_GET_SIZE(v);

if (n == 0) {

return PyUnicode_FromString("()");

}

/* While not mutable, it is still possible to end up with a cycle in a

tuple through an object that stores itself within a tuple (and thus

infinitely asks for the repr of itself). This should only be

possible within a type. */

int res = Py_ReprEnter((PyObject *)v);

if (res != 0) {

return res > 0 ? PyUnicode_FromString("(...)") : NULL;

}

Py_ssize_t prealloc;

if (n > 1) {

// "(" + "1" + ", 2" * (len - 1) + ")"

prealloc = 1 + 1 + (2 + 1) * (n - 1) + 1;

}

else {

// "(1,)"

prealloc = 4;

}

PyUnicodeWriter *writer = PyUnicodeWriter_Create(prealloc);

if (writer == NULL) {

goto error;

}

if (PyUnicodeWriter_WriteChar(writer, '(') < 0) {

goto error;

}

/* Do repr() on each element. */

for (Py_ssize_t i = 0; i < n; ++i) {

if (i > 0) {

if (PyUnicodeWriter_WriteChar(writer, ',') < 0) {

goto error;

}

if (PyUnicodeWriter_WriteChar(writer, ' ') < 0) {

goto error;

}

if (PyUnicodeWriter_WriteRepr(writer, v->ob_item[i]) < 0) {

goto error;

}

if (n == 1) {

if (PyUnicodeWriter_WriteChar(writer, ',') < 0) {

goto error;

}

if (PyUnicodeWriter_WriteChar(writer, ')') < 0) {

goto error;

}

Py_ReprLeave((PyObject *)v);

return PyUnicodeWriter_Finish(writer);

error:

PyUnicodeWriter_Discard(writer);

Py_ReprLeave((PyObject *)v);

return NULL;

}

/* Hash for tuples. This is a slightly simplified version of the xxHash

non-cryptographic hash:

- we do not use any parallelism, there is only 1 accumulator.

- we drop the final mixing since this is just a permutation of the

output space: it does not help against collisions.

- at the end, we mangle the length with a single constant.

For the xxHash specification, see

https://github.com/Cyan4973/xxHash/blob/master/doc/xxhash_spec.md

The constants for the hash function are defined in pycore_tuple.h.

static Py_hash_t

tuple_hash(PyObject *op)

{

PyTupleObject *v = _PyTuple_CAST(op);

Py_uhash_t acc = FT_ATOMIC_LOAD_SSIZE_RELAXED(v->ob_hash);

if (acc != (Py_uhash_t)-1) {

return acc;

}

Py_ssize_t len = Py_SIZE(v);

PyObject **item = v->ob_item;

acc = _PyTuple_HASH_XXPRIME_5;

for (Py_ssize_t i = 0; i < len; i++) {

Py_uhash_t lane = PyObject_Hash(item[i]);

if (lane == (Py_uhash_t)-1) {

return -1;

}

acc += lane * _PyTuple_HASH_XXPRIME_2;

acc = _PyTuple_HASH_XXROTATE(acc);

acc *= _PyTuple_HASH_XXPRIME_1;

}

/* Add input length, mangled to keep the historical value of hash(()). */

acc += len ^ (_PyTuple_HASH_XXPRIME_5 ^ 3527539UL);

if (acc == (Py_uhash_t)-1) {

acc = 1546275796;

}

FT_ATOMIC_STORE_SSIZE_RELAXED(v->ob_hash, acc);

return acc;

}

static Py_ssize_t

tuple_length(PyObject *self)

{

PyTupleObject *a = _PyTuple_CAST(self);

return Py_SIZE(a);

}

static int

tuple_contains(PyObject *self, PyObject *el)

{

PyTupleObject *a = _PyTuple_CAST(self);

int cmp = 0;

for (Py_ssize_t i = 0; cmp == 0 && i < Py_SIZE(a); ++i) {

cmp = PyObject_RichCompareBool(PyTuple_GET_ITEM(a, i), el, Py_EQ);

}

return cmp;

}

static PyObject *

tuple_item(PyObject *op, Py_ssize_t i)

{

PyTupleObject *a = _PyTuple_CAST(op);

if (i < 0 || i >= Py_SIZE(a)) {

PyErr_SetString(PyExc_IndexError, "tuple index out of range");

return NULL;

}

return Py_NewRef(a->ob_item[i]);

}

PyObject *

PyTuple_FromArray(PyObject *const *src, Py_ssize_t n)

{

if (n == 0) {

return tuple_get_empty();

}

PyTupleObject *tuple = tuple_alloc(n);

if (tuple == NULL) {

return NULL;

}

PyObject **dst = tuple->ob_item;

bool track = false;

for (Py_ssize_t i = 0; i < n; i++) {

PyObject *item = src[i];

if (!track && maybe_tracked(item)) {

track = true;

}

dst[i] = Py_NewRef(item);

}

if (track) {

_PyObject_GC_TRACK(tuple);

}

return (PyObject *)tuple;

}

PyObject *

_PyTuple_FromStackRefStealOnSuccess(const _PyStackRef *src, Py_ssize_t n)

{

if (n == 0) {

return tuple_get_empty();

}

PyTupleObject *tuple = tuple_alloc(n);

if (tuple == NULL) {

return NULL;

}

PyObject **dst = tuple->ob_item;

bool track = false;

for (Py_ssize_t i = 0; i < n; i++) {

PyObject *item = PyStackRef_AsPyObjectSteal(src[i]);

if (!track && maybe_tracked(item)) {

track = true;

}

dst[i] = item;

}

if (track) {

_PyObject_GC_TRACK(tuple);

}

return (PyObject *)tuple;

}

PyObject *

_PyTuple_FromArraySteal(PyObject *const *src, Py_ssize_t n)

{

if (n == 0) {

return tuple_get_empty();

}

PyTupleObject *tuple = tuple_alloc(n);

if (tuple == NULL) {

for (Py_ssize_t i = 0; i < n; i++) {

Py_DECREF(src[i]);

}

return NULL;

}

PyObject **dst = tuple->ob_item;

for (Py_ssize_t i = 0; i < n; i++) {

PyObject *item = src[i];

dst[i] = item;

}

_PyObject_GC_TRACK(tuple);

return (PyObject *)tuple;

}

static PyObject *

tuple_slice(PyTupleObject *a, Py_ssize_t ilow,

Py_ssize_t ihigh)

{

if (ilow < 0)

ilow = 0;

if (ihigh > Py_SIZE(a))

ihigh = Py_SIZE(a);

if (ihigh < ilow)

ihigh = ilow;

if (ilow == 0 && ihigh == Py_SIZE(a) && PyTuple_CheckExact(a)) {

return Py_NewRef(a);

}

return PyTuple_FromArray(a->ob_item + ilow, ihigh - ilow);

}

PyObject *

_PyTuple_BinarySlice(PyObject *container, PyObject *start, PyObject *stop)

{

assert(PyTuple_CheckExact(container));

Py_ssize_t len = Py_SIZE(container);

Py_ssize_t istart, istop;

if (!_PyEval_UnpackIndices(start, stop, len, &istart, &istop)) {

return NULL;

}

if (istart == 0 && istop == len) {

return Py_NewRef(container);

}

if (istop < istart) {

istop = istart;

}

return PyTuple_FromArray(((PyTupleObject *)container)->ob_item + istart,

istop - istart);

}

PyObject *

PyTuple_GetSlice(PyObject *op, Py_ssize_t i, Py_ssize_t j)

{

if (op == NULL || !PyTuple_Check(op)) {

PyErr_BadInternalCall();

return NULL;

}

return tuple_slice((PyTupleObject *)op, i, j);

}

static PyObject *

tuple_concat(PyObject *aa, PyObject *bb)

{

PyTupleObject *a = _PyTuple_CAST(aa);

if (Py_SIZE(a) == 0 && PyTuple_CheckExact(bb)) {

return Py_NewRef(bb);

}

if (!PyTuple_Check(bb)) {

PyErr_Format(PyExc_TypeError,

"can only concatenate tuple (not \"%.200s\") to tuple",

Py_TYPE(bb)->tp_name);

return NULL;

}

PyTupleObject *b = (PyTupleObject *)bb;

if (Py_SIZE(b) == 0 && PyTuple_CheckExact(a)) {

return Py_NewRef(a);

}

assert((size_t)Py_SIZE(a) + (size_t)Py_SIZE(b) < PY_SSIZE_T_MAX);

Py_ssize_t size = Py_SIZE(a) + Py_SIZE(b);

if (size == 0) {

return tuple_get_empty();

}

PyTupleObject *np = tuple_alloc(size);

if (np == NULL) {

return NULL;

}

PyObject **src = a->ob_item;

PyObject **dest = np->ob_item;

for (Py_ssize_t i = 0; i < Py_SIZE(a); i++) {

PyObject *v = src[i];

dest[i] = Py_NewRef(v);

}

src = b->ob_item;

dest = np->ob_item + Py_SIZE(a);

for (Py_ssize_t i = 0; i < Py_SIZE(b); i++) {

PyObject *v = src[i];

dest[i] = Py_NewRef(v);

}

_PyObject_GC_TRACK(np);

return (PyObject *)np;

}

static PyObject *

tuple_repeat(PyObject *self, Py_ssize_t n)

{

PyTupleObject *a = _PyTuple_CAST(self);

const Py_ssize_t input_size = Py_SIZE(a);

if (input_size == 0 || n == 1) {

if (PyTuple_CheckExact(a)) {

/* Since tuples are immutable, we can return a shared

copy in this case */

return Py_NewRef(a);

}

if (input_size == 0 || n <= 0) {

return tuple_get_empty();

}

assert(n>0);

if (input_size > PY_SSIZE_T_MAX / n)

return PyErr_NoMemory();

Py_ssize_t output_size = input_size * n;

PyTupleObject *np = tuple_alloc(output_size);

if (np == NULL)

return NULL;

PyObject **dest = np->ob_item;

if (input_size == 1) {

PyObject *elem = a->ob_item[0];

_Py_RefcntAdd(elem, n);

PyObject **dest_end = dest + output_size;

while (dest < dest_end) {

*dest++ = elem;

}

else {

PyObject **src = a->ob_item;

PyObject **src_end = src + input_size;

while (src < src_end) {

_Py_RefcntAdd(*src, n);

*dest++ = *src++;

}

_Py_memory_repeat((char *)np->ob_item, sizeof(PyObject *)*output_size,

sizeof(PyObject *)*input_size);

}

_PyObject_GC_TRACK(np);

return (PyObject *) np;

}

/*[clinic input]

tuple.index

value: object

start: slice_index(accept={int}) = 0

stop: slice_index(accept={int}, c_default="PY_SSIZE_T_MAX") = sys.maxsize

Return first index of value.

Raises ValueError if the value is not present.

[clinic start generated code]*/

static PyObject *

tuple_index_impl(PyTupleObject *self, PyObject *value, Py_ssize_t start,

Py_ssize_t stop)

/*[clinic end generated code: output=07b6f9f3cb5c33eb input=fb39e9874a21fe3f]*/

{

Py_ssize_t i;

if (start < 0) {

start += Py_SIZE(self);

if (start < 0)

start = 0;

}

if (stop < 0) {

stop += Py_SIZE(self);

}

else if (stop > Py_SIZE(self)) {

stop = Py_SIZE(self);

}

for (i = start; i < stop; i++) {

int cmp = PyObject_RichCompareBool(self->ob_item[i], value, Py_EQ);

if (cmp > 0)

return PyLong_FromSsize_t(i);

else if (cmp < 0)

return NULL;

}

PyErr_SetString(PyExc_ValueError, "tuple.index(x): x not in tuple");

return NULL;

}

/*[clinic input]

tuple.count

value: object

Return number of occurrences of value.

[clinic start generated code]*/

static PyObject *

tuple_count_impl(PyTupleObject *self, PyObject *value)

/*[clinic end generated code: output=cf02888d4bc15d7a input=531721aff65bd772]*/

{

Py_ssize_t count = 0;

Py_ssize_t i;

for (i = 0; i < Py_SIZE(self); i++) {

int cmp = PyObject_RichCompareBool(self->ob_item[i], value, Py_EQ);

if (cmp > 0)

count++;

else if (cmp < 0)

return NULL;

}

return PyLong_FromSsize_t(count);

}

static int

tuple_traverse(PyObject *self, visitproc visit, void *arg)

{

PyTupleObject *o = _PyTuple_CAST(self);

for (Py_ssize_t i = Py_SIZE(o); --i >= 0; ) {

Py_VISIT(o->ob_item[i]);

}

return 0;

}

static PyObject *

tuple_richcompare(PyObject *v, PyObject *w, int op)

{

PyTupleObject *vt, *wt;

Py_ssize_t i;

Py_ssize_t vlen, wlen;

if (!PyTuple_Check(v) || !PyTuple_Check(w))

Py_RETURN_NOTIMPLEMENTED;

vt = (PyTupleObject *)v;

wt = (PyTupleObject *)w;

vlen = Py_SIZE(vt);

wlen = Py_SIZE(wt);

/* Note: the corresponding code for lists has an "early out" test

* here when op is EQ or NE and the lengths differ. That pays there,

* but Tim was unable to find any real code where EQ/NE tuple

* compares don't have the same length, so testing for it here would

* have cost without benefit.

/* Search for the first index where items are different.

* Note that because tuples are immutable, it's safe to reuse

* vlen and wlen across the comparison calls.

for (i = 0; i < vlen && i < wlen; i++) {

int k = PyObject_RichCompareBool(vt->ob_item[i],

wt->ob_item[i], Py_EQ);

if (k < 0)

return NULL;

if (!k)

break;

}

if (i >= vlen || i >= wlen) {

/* No more items to compare -- compare sizes */

Py_RETURN_RICHCOMPARE(vlen, wlen, op);

}

/* We have an item that differs -- shortcuts for EQ/NE */

if (op == Py_EQ) {

Py_RETURN_FALSE;

}

if (op == Py_NE) {

Py_RETURN_TRUE;

}

/* Compare the final item again using the proper operator */

return PyObject_RichCompare(vt->ob_item[i], wt->ob_item[i], op);

}

static PyObject *

tuple_subtype_new(PyTypeObject *type, PyObject *iterable);

/*[clinic input]

@classmethod

tuple.__new__ as tuple_new

iterable: object(c_default="NULL") = ()

Built-in immutable sequence.

If no argument is given, the constructor returns an empty tuple.

If iterable is specified the tuple is initialized from iterable's items.

If the argument is a tuple, the return value is the same object.

[clinic start generated code]*/

static PyObject *

tuple_new_impl(PyTypeObject *type, PyObject *iterable)

/*[clinic end generated code: output=4546d9f0d469bce7 input=86963bcde633b5a2]*/

{

if (type != &PyTuple_Type)

return tuple_subtype_new(type, iterable);

if (iterable == NULL) {

return tuple_get_empty();

}

else {

return PySequence_Tuple(iterable);

}

static PyObject *

tuple_vectorcall(PyObject *type, PyObject * const*args,

size_t nargsf, PyObject *kwnames)

{

if (!_PyArg_NoKwnames("tuple", kwnames)) {

return NULL;

}

Py_ssize_t nargs = PyVectorcall_NARGS(nargsf);

if (!_PyArg_CheckPositional("tuple", nargs, 0, 1)) {

return NULL;

}

if (nargs) {

return tuple_new_impl(_PyType_CAST(type), args[0]);

}

else {

return tuple_get_empty();

}

static PyObject *

tuple_subtype_new(PyTypeObject *type, PyObject *iterable)

{

PyObject *tmp, *newobj, *item;

Py_ssize_t i, n;

assert(PyType_IsSubtype(type, &PyTuple_Type));

// tuple subclasses must implement the GC protocol

assert(_PyType_IS_GC(type));

tmp = tuple_new_impl(&PyTuple_Type, iterable);

if (tmp == NULL)

return NULL;

assert(PyTuple_Check(tmp));

/* This may allocate an empty tuple that is not the global one. */

newobj = type->tp_alloc(type, n = PyTuple_GET_SIZE(tmp));

if (newobj == NULL) {

Py_DECREF(tmp);

return NULL;

}

for (i = 0; i < n; i++) {

item = PyTuple_GET_ITEM(tmp, i);

PyTuple_SET_ITEM(newobj, i, Py_NewRef(item));

}

Py_DECREF(tmp);

_PyTuple_RESET_HASH_CACHE(newobj);

// Don't track if a subclass tp_alloc is PyType_GenericAlloc()

if (!_PyObject_GC_IS_TRACKED(newobj)) {

_PyObject_GC_TRACK(newobj);

}

return newobj;

}

static PySequenceMethods tuple_as_sequence = {

tuple_length, /* sq_length */

tuple_concat, /* sq_concat */

tuple_repeat, /* sq_repeat */

tuple_item, /* sq_item */

0, /* sq_slice */

0, /* sq_ass_item */

0, /* sq_ass_slice */

tuple_contains, /* sq_contains */

};

static PyObject*

tuple_subscript(PyObject *op, PyObject* item)

{

PyTupleObject *self = _PyTuple_CAST(op);

if (_PyIndex_Check(item)) {

Py_ssize_t i = PyNumber_AsSsize_t(item, PyExc_IndexError);

if (i == -1 && PyErr_Occurred())

return NULL;

if (i < 0)

i += PyTuple_GET_SIZE(self);

return tuple_item(op, i);

}

else if (PySlice_Check(item)) {

Py_ssize_t start, stop, step, slicelength, i;

size_t cur;

PyObject* it;

PyObject **src, **dest;

if (PySlice_Unpack(item, &start, &stop, &step) < 0) {

return NULL;

}

slicelength = PySlice_AdjustIndices(PyTuple_GET_SIZE(self), &start,

&stop, step);

if (slicelength <= 0) {

return tuple_get_empty();

}

else if (start == 0 && step == 1 &&

slicelength == PyTuple_GET_SIZE(self) &&

PyTuple_CheckExact(self)) {

return Py_NewRef(self);

}

else {

PyTupleObject* result = tuple_alloc(slicelength);

if (!result) return NULL;

src = self->ob_item;

dest = result->ob_item;

for (cur = start, i = 0; i < slicelength;

cur += step, i++) {

it = Py_NewRef(src[cur]);

dest[i] = it;

}

_PyObject_GC_TRACK(result);

return (PyObject *)result;

}

else {

PyErr_Format(PyExc_TypeError,

"tuple indices must be integers or slices, not %.200s",

Py_TYPE(item)->tp_name);

return NULL;

}

/*[clinic input]

tuple.__getnewargs__

[clinic start generated code]*/

static PyObject *

tuple___getnewargs___impl(PyTupleObject *self)

/*[clinic end generated code: output=25e06e3ee56027e2 input=1aeb4b286a21639a]*/

{

return Py_BuildValue("(N)", tuple_slice(self, 0, Py_SIZE(self)));

}

static PyMethodDef tuple_methods[] = {

TUPLE___GETNEWARGS___METHODDEF

TUPLE_INDEX_METHODDEF

TUPLE_COUNT_METHODDEF

{"__class_getitem__", Py_GenericAlias, METH_O|METH_CLASS, PyDoc_STR("See PEP 585")},

{NULL, NULL} /* sentinel */

};

static PyMappingMethods tuple_as_mapping = {

tuple_length,

tuple_subscript,

};

static PyObject *tuple_iter(PyObject *seq);

PyTypeObject PyTuple_Type = {

PyVarObject_HEAD_INIT(&PyType_Type, 0)

"tuple",

sizeof(PyTupleObject) - sizeof(PyObject *),

sizeof(PyObject *),

tuple_dealloc, /* tp_dealloc */

0, /* tp_vectorcall_offset */

0, /* tp_getattr */

0, /* tp_setattr */

0, /* tp_as_async */

tuple_repr, /* tp_repr */

0, /* tp_as_number */

&tuple_as_sequence, /* tp_as_sequence */

&tuple_as_mapping, /* tp_as_mapping */

tuple_hash, /* tp_hash */

0, /* tp_call */

0, /* tp_str */

PyObject_GenericGetAttr, /* tp_getattro */

0, /* tp_setattro */

0, /* tp_as_buffer */

Py_TPFLAGS_DEFAULT | Py_TPFLAGS_HAVE_GC |

Py_TPFLAGS_BASETYPE | Py_TPFLAGS_TUPLE_SUBCLASS |

_Py_TPFLAGS_MATCH_SELF | Py_TPFLAGS_SEQUENCE, /* tp_flags */

tuple_new__doc__, /* tp_doc */

tuple_traverse, /* tp_traverse */

0, /* tp_clear */

tuple_richcompare, /* tp_richcompare */

0, /* tp_weaklistoffset */

tuple_iter, /* tp_iter */

0, /* tp_iternext */

tuple_methods, /* tp_methods */

0, /* tp_members */

0, /* tp_getset */

0, /* tp_base */

0, /* tp_dict */

0, /* tp_descr_get */

0, /* tp_descr_set */

0, /* tp_dictoffset */

0, /* tp_init */

0, /* tp_alloc */

tuple_new, /* tp_new */

PyObject_GC_Del, /* tp_free */

.tp_vectorcall = tuple_vectorcall,

.tp_version_tag = _Py_TYPE_VERSION_TUPLE,

};

/* The following function breaks the notion that tuples are immutable:

it changes the size of a tuple. We get away with this only if there

is only one module referencing the object. You can also think of it

as creating a new tuple object and destroying the old one, only more

efficiently. In any case, don't use this if the tuple may already be

known to some other part of the code. */

int

_PyTuple_Resize(PyObject **pv, Py_ssize_t newsize)

{

PyTupleObject *v;

PyTupleObject *sv;

Py_ssize_t i;

View remainder of file in raw view

cpython/Objects/tupleobject.c at structseq_tracking · eendebakpt/cpython · GitHub

Repository navigation

Expand file tree

Breadcrumbs

tupleobject.c

Latest commit

History

Breadcrumbs

tupleobject.c

File metadata and controls