python-docs-fa/c-api/type.html at gh-pages · python/python-docs-fa

History

1088 lines (994 loc) · 111 KB

Raw

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

<!DOCTYPE html>

<head>

<title>Type Objects — مستندات Python3.14.6</title><meta name="viewport" content="width=device-width, initial-scale=1.0">

title="جستجو در مستندات Python3.14.6"

href="../_static/opensearch.xml"/>

<style>

@media only screen {

table.full-width-table {

width: 100%;

}

</style>

</head>

<body>

<input type="checkbox" id="menuToggler" class="toggler__input" aria-controls="navigation"

aria-pressed="false" aria-expanded="false" role="button" aria-label="Menu">

</label>

</a>

</svg>

</form>

</nav>

Theme

<option value="light">Light</option>

</select>

</label>

<div>

<h3><a href="../contents.html">فهرست عناوین</a></h3>

<ul>

<li><a class="reference internal" href="#">Type Objects</a><ul>

<li><a class="reference internal" href="#creating-heap-allocated-types">Creating Heap-Allocated Types</a></li>

</ul>

</li>

</ul>

</div>

<div>

<h4>موضوع قبلی</h4>

<a href="concrete.html"

title="فصل قبلی">Concrete Objects Layer</a>

</div>

<div>

<h4>موضوع بعدی</h4>

<a href="none.html"

title="فصل بعدی">The <code class="docutils literal notranslate">None</code> Object</a>

</div>

document.addEventListener('DOMContentLoaded', () => {

const title = document.querySelector('meta[property="og:title"]').content;

const elements = document.querySelectorAll('.improvepage');

const pageurl = window.location.href.split('?')[0];

elements.forEach(element => {

const url = new URL(element.href.split('?')[0].replace("-nojs", ""));

url.searchParams.set('pagetitle', title);

url.searchParams.set('pageurl', pageurl);

url.searchParams.set('pagesource', "c-api/type.rst");

element.href = url.toString();

});

</script>

<li><a href="../bugs.html">گزارش یک اشکال</a></li>

<li><a class="improvepage" href="../improve-page-nojs.html">بهبود این صفحه</a></li>

<li>

<a href="https://github.com/python/cpython/blob/main/Doc/c-api/type.rst?plain=1"

rel="nofollow">نمایش منبع

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/c-api/type.po?plain=1"

rel="nofollow">نمایش منبع ترجمه</a>

</li>

</ul>

</div>

</nav>

</div>

<h3>ناوبری</h3>

<ul>

<a href="../genindex.html" title="فهرست کلی"

accesskey="I">فهرست</a></li>

<a href="../py-modindex.html" title="نمایه ی ماژول های پایتون"

>ماژول ها</a> |</li>

<a href="none.html" title="The None Object"

accesskey="N">بعدی</a> |</li>

<a href="concrete.html" title="Concrete Objects Layer"

accesskey="P">قبلی</a> |</li>

<li><a href="https://www.python.org/">Python</a> »</li>

</li>

<li>

</li>

<a href="../index.html">3.14.6 Documentation</a> »

</li>

<li class="nav-item nav-item-1"><a href="index.html" >Python/C API reference manual</a> »</li>

<li class="nav-item nav-item-2"><a href="concrete.html" accesskey="U">Concrete Objects Layer</a> »</li>

<li class="nav-item nav-item-this"><a href="">Type Objects</a></li>

</form>

</div>

</li>

Theme

<option value="light">Light</option>

</select>

</label> |</li>

</ul>

</div>

<h1>Type Objects<a class="headerlink" href="#type-objects" title="Link to this heading">¶</a></h1>

type PyTypeObject<a class="headerlink" href="#c.PyTypeObject" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">API محدود</a> (به‌عنوان یک ساختار مبهم).The C structure of the objects used to describe built-in types.

</dd></dl>

<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> PyType_Type<a class="headerlink" href="#c.PyType_Type" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.This is the type object for type objects; it is the same object as

<a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> in the Python layer.

</dd></dl>

int PyType_Check(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyType_Check" title="Link to this definition">¶</a> </dt>

<dd>Return non-zero if the object o is a type object, including instances of

types derived from the standard type object. Return 0 in all other cases.

This function always succeeds.

</dd></dl>

int PyType_CheckExact(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *o)<a class="headerlink" href="#c.PyType_CheckExact" title="Link to this definition">¶</a> </dt>

<dd>Return non-zero if the object o is a type object, but not a subtype of

the standard type object. Return 0 in all other cases. This function

always succeeds.

</dd></dl>

unsigned int PyType_ClearCache()<a class="headerlink" href="#c.PyType_ClearCache" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Clear the internal lookup cache. Return the current version tag.

</dd></dl>

unsigned long PyType_GetFlags(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_GetFlags" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return the <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_flags" title="PyTypeObject.tp_flags"><code class="xref c c-member docutils literal notranslate">tp_flags</code></a> member of type. This function is primarily

meant for use with <code class="docutils literal notranslate">Py_LIMITED_API</code>; the individual flag bits are

guaranteed to be stable across Python releases, but access to

<code class="xref c c-member docutils literal notranslate">tp_flags</code> itself is not part of the <a class="reference internal" href="stable.html#limited-c-api">limited API</a>.

Added in version 3.2.

</div>

تغییر داده شده در نسخه 3.4: The return type is now <code class="docutils literal notranslate">unsigned long</code> rather than <code class="docutils literal notranslate">long</code>.

</div>

</dd></dl>

<dd>Return the type object's internal namespace, which is otherwise only

exposed via a read-only proxy (<a class="reference internal" href="../reference/datamodel.html#type.__dict__" title="type.__dict__"><code class="xref py py-attr docutils literal notranslate">cls.__dict__</code></a>).

This is a

replacement for accessing <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dict" title="PyTypeObject.tp_dict"><code class="xref c c-member docutils literal notranslate">tp_dict</code></a> directly.

The returned dictionary must be treated as read-only.

This function is meant for specific embedding and language-binding cases,

where direct access to the dict is necessary and indirect access

(e.g. via the proxy or <a class="reference internal" href="object.html#c.PyObject_GetAttr" title="PyObject_GetAttr"><code class="xref c c-func docutils literal notranslate">PyObject_GetAttr()</code></a>) isn't adequate.

Extension modules should continue to use <code class="docutils literal notranslate">tp_dict</code>,

directly or indirectly, when setting up their own types.

Added in version 3.12.

</div>

</dd></dl>

void PyType_Modified(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_Modified" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Invalidate the internal lookup cache for the type and all of its

subtypes. This function must be called after any manual

modification of the attributes or base classes of the type.

</dd></dl>

int PyType_AddWatcher(<a class="reference internal" href="#c.PyType_WatchCallback" title="PyType_WatchCallback">PyType_WatchCallback</a> callback)<a class="headerlink" href="#c.PyType_AddWatcher" title="Link to this definition">¶</a> </dt>

<dd>Register callback as a type watcher. Return a non-negative integer ID

which must be passed to future calls to <a class="reference internal" href="#c.PyType_Watch" title="PyType_Watch"><code class="xref c c-func docutils literal notranslate">PyType_Watch()</code></a>. In case of

error (e.g. no more watcher IDs available), return <code class="docutils literal notranslate">-1</code> and set an

exception.

In free-threaded builds, <a class="reference internal" href="#c.PyType_AddWatcher" title="PyType_AddWatcher"><code class="xref c c-func docutils literal notranslate">PyType_AddWatcher()</code></a> is not thread-safe,

so it must be called at start up (before spawning the first thread).

Added in version 3.12.

</div>

</dd></dl>

int PyType_ClearWatcher(int watcher_id)<a class="headerlink" href="#c.PyType_ClearWatcher" title="Link to this definition">¶</a> </dt>

<dd>Clear watcher identified by watcher_id (previously returned from

<a class="reference internal" href="#c.PyType_AddWatcher" title="PyType_AddWatcher"><code class="xref c c-func docutils literal notranslate">PyType_AddWatcher()</code></a>). Return <code class="docutils literal notranslate">0</code> on success, <code class="docutils literal notranslate">-1</code> on error (e.g.

if watcher_id was never registered.)

An extension should never call <code class="docutils literal notranslate">PyType_ClearWatcher</code> with a watcher_id

that was not returned to it by a previous call to

Added in version 3.12.

</div>

</dd></dl>

int PyType_Watch(int watcher_id, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *type)<a class="headerlink" href="#c.PyType_Watch" title="Link to this definition">¶</a> </dt>

<dd>Mark type as watched. The callback granted watcher_id by

<a class="reference internal" href="#c.PyType_Modified" title="PyType_Modified"><code class="xref c c-func docutils literal notranslate">PyType_Modified()</code></a> reports a change to type. (The callback may be

called only once for a series of consecutive modifications to type, if

<code class="xref c c-func docutils literal notranslate">_PyType_Lookup()</code> is not called on type between the modifications;

this is an implementation detail and subject to change.)

An extension should never call <code class="docutils literal notranslate">PyType_Watch</code> with a watcher_id that was

not returned to it by a previous call to <a class="reference internal" href="#c.PyType_AddWatcher" title="PyType_AddWatcher"><code class="xref c c-func docutils literal notranslate">PyType_AddWatcher()</code></a>.

Added in version 3.12.

</div>

</dd></dl>

int PyType_Unwatch(int watcher_id, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *type)<a class="headerlink" href="#c.PyType_Unwatch" title="Link to this definition">¶</a> </dt>

<dd>Mark type as not watched. This undoes a previous call to

<a class="reference internal" href="#c.PyType_Watch" title="PyType_Watch"><code class="xref c c-func docutils literal notranslate">PyType_Watch()</code></a>. type must not be <code class="docutils literal notranslate">NULL</code>.

An extension should never call this function with a watcher_id that was

On success, this function returns <code class="docutils literal notranslate">0</code>. On failure, this function returns

<code class="docutils literal notranslate">-1</code> with an exception set.

Added in version 3.12.

</div>

</dd></dl>

typedef int (*PyType_WatchCallback)(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *type)<a class="headerlink" href="#c.PyType_WatchCallback" title="Link to this definition">¶</a> </dt>

<dd>Type of a type-watcher callback function.

The callback must not modify type or cause <a class="reference internal" href="#c.PyType_Modified" title="PyType_Modified"><code class="xref c c-func docutils literal notranslate">PyType_Modified()</code></a> to be

called on type or any type in its MRO; violating this rule could cause

infinite recursion.

Added in version 3.12.

</div>

</dd></dl>

int PyType_HasFeature(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *o, int feature)<a class="headerlink" href="#c.PyType_HasFeature" title="Link to this definition">¶</a> </dt>

<dd>Return non-zero if the type object o sets the feature feature.

Type features are denoted by single bit flags.

</dd></dl>

int PyType_FastSubclass(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, int flag)<a class="headerlink" href="#c.PyType_FastSubclass" title="Link to this definition">¶</a> </dt>

<dd>Return non-zero if the type object type sets the subclass flag flag.

Subclass flags are denoted by

<a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_LONG_SUBCLASS" title="Py_TPFLAGS_LONG_SUBCLASS"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_*_SUBCLASS</code></a>.

This function is used by many <code class="docutils literal notranslate">_Check</code> functions for common types.

همچنین ملاحظه نمائید

<a class="reference internal" href="object.html#c.PyObject_TypeCheck" title="PyObject_TypeCheck"><code class="xref c c-func docutils literal notranslate">PyObject_TypeCheck()</code></a>, which is used as a slower alternative in

<code class="docutils literal notranslate">_Check</code> functions for types that don't come with subclass flags.

</div>

</dd></dl>

int PyType_IS_GC(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *o)<a class="headerlink" href="#c.PyType_IS_GC" title="Link to this definition">¶</a> </dt>

<dd>Return true if the type object includes support for the cycle detector; this

tests the type flag <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_HAVE_GC" title="Py_TPFLAGS_HAVE_GC"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HAVE_GC</code></a>.

</dd></dl>

int PyType_IsSubtype(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *a, <a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *b)<a class="headerlink" href="#c.PyType_IsSubtype" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Return true if a is a subtype of b.

This function only checks for actual subtypes, which means that

<a class="reference internal" href="../reference/datamodel.html#type.__subclasscheck__" title="type.__subclasscheck__"><code class="xref py py-meth docutils literal notranslate">__subclasscheck__()</code></a> is not called on b. Call

<a class="reference internal" href="object.html#c.PyObject_IsSubclass" title="PyObject_IsSubclass"><code class="xref c c-func docutils literal notranslate">PyObject_IsSubclass()</code></a> to do the same check that <a class="reference internal" href="../library/functions.html#issubclass" title="issubclass"><code class="xref py py-func docutils literal notranslate">issubclass()</code></a>

would do.

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Generic handler for the <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_alloc" title="PyTypeObject.tp_alloc"><code class="xref c c-member docutils literal notranslate">tp_alloc</code></a> slot of a type

object. Uses Python's default memory allocation mechanism to allocate memory

for a new instance, zeros the memory, then initializes the memory as if by

calling <a class="reference internal" href="allocation.html#c.PyObject_Init" title="PyObject_Init"><code class="xref c c-func docutils literal notranslate">PyObject_Init()</code></a> or <a class="reference internal" href="allocation.html#c.PyObject_InitVar" title="PyObject_InitVar"><code class="xref c c-func docutils literal notranslate">PyObject_InitVar()</code></a>.

Do not call this directly to allocate memory for an object; call the type's

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_alloc" title="PyTypeObject.tp_alloc"><code class="xref c c-member docutils literal notranslate">tp_alloc</code></a> slot instead.

For types that support garbage collection (i.e., the

<a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_HAVE_GC" title="Py_TPFLAGS_HAVE_GC"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HAVE_GC</code></a> flag is set), this function behaves like

<a class="reference internal" href="gcsupport.html#c.PyObject_GC_New" title="PyObject_GC_New"><code class="xref c c-macro docutils literal notranslate">PyObject_GC_New</code></a> or <a class="reference internal" href="gcsupport.html#c.PyObject_GC_NewVar" title="PyObject_GC_NewVar"><code class="xref c c-macro docutils literal notranslate">PyObject_GC_NewVar</code></a> (except the

memory is guaranteed to be zeroed before initialization), and should be

paired with <a class="reference internal" href="gcsupport.html#c.PyObject_GC_Del" title="PyObject_GC_Del"><code class="xref c c-func docutils literal notranslate">PyObject_GC_Del()</code></a> in <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_free" title="PyTypeObject.tp_free"><code class="xref c c-member docutils literal notranslate">tp_free</code></a>.

Otherwise, it behaves like <a class="reference internal" href="allocation.html#c.PyObject_New" title="PyObject_New"><code class="xref c c-macro docutils literal notranslate">PyObject_New</code></a> or

<a class="reference internal" href="allocation.html#c.PyObject_NewVar" title="PyObject_NewVar"><code class="xref c c-macro docutils literal notranslate">PyObject_NewVar</code></a> (except the memory is guaranteed to be zeroed

before initialization) and should be paired with <a class="reference internal" href="memory.html#c.PyObject_Free" title="PyObject_Free"><code class="xref c c-func docutils literal notranslate">PyObject_Free()</code></a> in

<code class="xref c c-member docutils literal notranslate">tp_free</code>.

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GenericNew(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *args, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *kwds)<a class="headerlink" href="#c.PyType_GenericNew" title="Link to this definition">¶</a> </dt>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Generic handler for the <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> slot of a type

object. Creates a new instance using the type's

</dd></dl>

int PyType_Ready(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_Ready" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Finalize a type object. This should be called on all type objects to finish

their initialization. This function is responsible for adding inherited slots

from a type's base class. Return <code class="docutils literal notranslate">0</code> on success, or return <code class="docutils literal notranslate">-1</code> and sets an

exception on error.

توجه

If some of the base classes implements the GC protocol and the provided

type does not include the <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_HAVE_GC" title="Py_TPFLAGS_HAVE_GC"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HAVE_GC</code></a> in its flags, then

the GC protocol will be automatically implemented from its parents. On

the contrary, if the type being created does include

<code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HAVE_GC</code> in its flags then it must implement the

GC protocol itself by at least implementing the

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_traverse" title="PyTypeObject.tp_traverse"><code class="xref c c-member docutils literal notranslate">tp_traverse</code></a> handle.

</div>

</dd></dl>

<a class="reference internal" href="../reference/datamodel.html#type.__name__" title="type.__name__"><code class="xref py py-attr docutils literal notranslate">__name__</code></a> attribute.

Added in version 3.11.

</div>

</dd></dl>

type's <a class="reference internal" href="../reference/datamodel.html#type.__qualname__" title="type.__qualname__"><code class="xref py py-attr docutils literal notranslate">__qualname__</code></a> attribute.

Added in version 3.11.

</div>

</dd></dl>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.13.Return the type's fully qualified name. Equivalent to

<code class="docutils literal notranslate">f"{type.__module__}.{type.__qualname__}"</code>, or <a class="reference internal" href="../reference/datamodel.html#type.__qualname__" title="type.__qualname__"><code class="xref py py-attr docutils literal notranslate">type.__qualname__</code></a>

if <a class="reference internal" href="../reference/datamodel.html#type.__module__" title="type.__module__"><code class="xref py py-attr docutils literal notranslate">type.__module__</code></a> is not a string or is equal to <code class="docutils literal notranslate">"builtins"</code>.

Added in version 3.13.

</div>

</dd></dl>

<a class="reference internal" href="../reference/datamodel.html#type.__module__" title="type.__module__"><code class="xref py py-attr docutils literal notranslate">type.__module__</code></a> attribute.

Added in version 3.13.

</div>

</dd></dl>

void *PyType_GetSlot(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, int slot)<a class="headerlink" href="#c.PyType_GetSlot" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.4.Return the function pointer stored in the given slot. If the

result is <code class="docutils literal notranslate">NULL</code>, this indicates that either the slot is <code class="docutils literal notranslate">NULL</code>,

or that the function was called with invalid parameters.

Callers will typically cast the result pointer into the appropriate

function type.

See <a class="reference internal" href="#c.PyType_Slot.slot" title="PyType_Slot.slot"><code class="xref c c-member docutils literal notranslate">PyType_Slot.slot</code></a> for possible values of the slot argument.

Added in version 3.4.

</div>

تغییر داده شده در نسخه 3.10: <a class="reference internal" href="#c.PyType_GetSlot" title="PyType_GetSlot"><code class="xref c c-func docutils literal notranslate">PyType_GetSlot()</code></a> can now accept all types.

Previously, it was limited to <a class="reference internal" href="typeobj.html#heap-types">heap types</a>.

</div>

</dd></dl>

<dd>مقدار بازگشتی: مرجع قرضی. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.10.Return the module object associated with the given type when the type was

created using <a class="reference internal" href="#c.PyType_FromModuleAndSpec" title="PyType_FromModuleAndSpec"><code class="xref c c-func docutils literal notranslate">PyType_FromModuleAndSpec()</code></a>.

The returned reference is <a class="reference internal" href="../glossary.html#term-borrowed-reference">borrowed</a> from type,

and will be valid as long as you hold a reference to type.

Do not release it with <a class="reference internal" href="refcounting.html#c.Py_DECREF" title="Py_DECREF"><code class="xref c c-func docutils literal notranslate">Py_DECREF()</code></a> or similar.

If no module is associated with the given type, sets <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-class docutils literal notranslate">TypeError</code></a>

and returns <code class="docutils literal notranslate">NULL</code>.

This function is usually used to get the module in which a method is defined.

Note that in such a method, <code class="docutils literal notranslate">PyType_GetModule(Py_TYPE(self))</code>

may not return the intended result.

<code class="docutils literal notranslate">Py_TYPE(self)</code> may be a subclass of the intended class, and subclasses

are not necessarily defined in the same module as their superclass.

See <a class="reference internal" href="structures.html#c.PyCMethod" title="PyCMethod"><code class="xref c c-type docutils literal notranslate">PyCMethod</code></a> to get the class that defines the method.

See <a class="reference internal" href="#c.PyType_GetModuleByDef" title="PyType_GetModuleByDef"><code class="xref c c-func docutils literal notranslate">PyType_GetModuleByDef()</code></a> for cases when <code class="xref c c-type docutils literal notranslate">PyCMethod</code> cannot

be used.

Added in version 3.9.

</div>

</dd></dl>

void *PyType_GetModuleState(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_GetModuleState" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.10.Return the state of the module object associated with the given type.

This is a shortcut for calling <a class="reference internal" href="module.html#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate">PyModule_GetState()</code></a> on the result

of <a class="reference internal" href="#c.PyType_GetModule" title="PyType_GetModule"><code class="xref c c-func docutils literal notranslate">PyType_GetModule()</code></a>.

and returns <code class="docutils literal notranslate">NULL</code>.

If the type has an associated module but its state is <code class="docutils literal notranslate">NULL</code>,

returns <code class="docutils literal notranslate">NULL</code> without setting an exception.

Added in version 3.9.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_GetModuleByDef(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, struct <a class="reference internal" href="module.html#c.PyModuleDef" title="PyModuleDef">PyModuleDef</a> *def)<a class="headerlink" href="#c.PyType_GetModuleByDef" title="Link to this definition">¶</a> </dt>

<dd>مقدار بازگشتی: مرجع قرضی. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.13.Find the first superclass whose module was created from

the given <a class="reference internal" href="module.html#c.PyModuleDef" title="PyModuleDef"><code class="xref c c-type docutils literal notranslate">PyModuleDef</code></a> def, and return that module.

If no module is found, raises a <a class="reference internal" href="../library/exceptions.html#TypeError" title="TypeError"><code class="xref py py-class docutils literal notranslate">TypeError</code></a> and returns <code class="docutils literal notranslate">NULL</code>.

This function is intended to be used together with

<a class="reference internal" href="module.html#c.PyModule_GetState" title="PyModule_GetState"><code class="xref c c-func docutils literal notranslate">PyModule_GetState()</code></a> to get module state from slot methods (such as

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_init" title="PyTypeObject.tp_init"><code class="xref c c-member docutils literal notranslate">tp_init</code></a> or <a class="reference internal" href="typeobj.html#c.PyNumberMethods.nb_add" title="PyNumberMethods.nb_add"><code class="xref c c-member docutils literal notranslate">nb_add</code></a>)

and other places where a method's defining class cannot be passed using the

<a class="reference internal" href="structures.html#c.PyCMethod" title="PyCMethod"><code class="xref c c-type docutils literal notranslate">PyCMethod</code></a> calling convention.

The returned reference is <a class="reference internal" href="../glossary.html#term-borrowed-reference">borrowed</a> from type,

and will be valid as long as you hold a reference to type.

Added in version 3.11.

</div>

</dd></dl>

int PyType_GetBaseByToken(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type, void *token, <a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> **result)<a class="headerlink" href="#c.PyType_GetBaseByToken" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.14.Find the first superclass in type's <a class="reference internal" href="../glossary.html#term-method-resolution-order">method resolution order</a> whose

<a class="reference internal" href="#c.Py_tp_token" title="Py_tp_token"><code class="xref c c-macro docutils literal notranslate">Py_tp_token</code></a> token is equal to the given one.

<li>If found, set *result to a new <a class="reference internal" href="../glossary.html#term-strong-reference">strong reference</a>

to it and return <code class="docutils literal notranslate">1</code>.</li>

<li>If not found, set *result to <code class="docutils literal notranslate">NULL</code> and return <code class="docutils literal notranslate">0</code>.</li>

<li>On error, set *result to <code class="docutils literal notranslate">NULL</code> and return <code class="docutils literal notranslate">-1</code> with an

exception set.</li>

</ul>

The result argument may be <code class="docutils literal notranslate">NULL</code>, in which case *result is not set.

Use this if you need only the return value.

The token argument may not be <code class="docutils literal notranslate">NULL</code>.

Added in version 3.14.

</div>

</dd></dl>

int PyUnstable_Type_AssignVersionTag(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyUnstable_Type_AssignVersionTag" title="Link to this definition">¶</a> </dt>

این است <a class="reference internal" href="stable.html#unstable-c-api">API ناپایدار</a>این ممکن است بدون هشدار در نسخه‌های جزئی تغییر کند.</div>

Attempt to assign a version tag to the given type.

Returns 1 if the type already had a valid version tag or a new one was

assigned, or 0 if a new tag could not be assigned.

Added in version 3.12.

</div>

</dd></dl>

int PyType_SUPPORTS_WEAKREFS(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_SUPPORTS_WEAKREFS" title="Link to this definition">¶</a> </dt>

<dd>Return true if instances of type support creating weak references, false

otherwise. This function always succeeds. type must not be <code class="docutils literal notranslate">NULL</code>.

همچنین ملاحظه نمائید

<li><a class="reference internal" href="weakref.html#weakrefobjects">Weak Reference Objects</a></li>

<li><a class="reference internal" href="../library/weakref.html#module-weakref" title="weakref: Support for weak references and weak dictionaries."><code class="xref py py-mod docutils literal notranslate">weakref</code></a></li>

</ul>

</div>

</dd></dl>

<h2>Creating Heap-Allocated Types<a class="headerlink" href="#creating-heap-allocated-types" title="Link to this heading">¶</a></h2>

The following functions and structs are used to create

<a class="reference internal" href="typeobj.html#heap-types">heap types</a>.

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_FromMetaclass(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *metaclass, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, <a class="reference internal" href="#c.PyType_Spec" title="PyType_Spec">PyType_Spec</a> *spec, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *bases)<a class="headerlink" href="#c.PyType_FromMetaclass" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.12.Create and return a <a class="reference internal" href="typeobj.html#heap-types">heap type</a> from the spec

(see <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_HEAPTYPE" title="Py_TPFLAGS_HEAPTYPE"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_HEAPTYPE</code></a>).

The metaclass metaclass is used to construct the resulting type object.

When metaclass is <code class="docutils literal notranslate">NULL</code>, the metaclass is derived from bases

(or Py_tp_base[s] slots if bases is <code class="docutils literal notranslate">NULL</code>, see below).

Metaclasses that override <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> are not

supported, except if <code class="docutils literal notranslate">tp_new</code> is <code class="docutils literal notranslate">NULL</code>.

The bases argument can be used to specify base classes; it can either

be only one class or a tuple of classes.

If bases is <code class="docutils literal notranslate">NULL</code>, the <a class="reference internal" href="typeobj.html#c.Py_tp_bases" title="Py_tp_bases"><code class="xref c c-data docutils literal notranslate">Py_tp_bases</code></a> slot is used instead.

If that also is <code class="docutils literal notranslate">NULL</code>, the <a class="reference internal" href="typeobj.html#c.Py_tp_base" title="Py_tp_base"><code class="xref c c-data docutils literal notranslate">Py_tp_base</code></a> slot is used instead.

If that also is <code class="docutils literal notranslate">NULL</code>, the new type derives from <a class="reference internal" href="../library/functions.html#object" title="object"><code class="xref py py-class docutils literal notranslate">object</code></a>.

The module argument can be used to record the module in which the new

class is defined. It must be a module object or <code class="docutils literal notranslate">NULL</code>.

If not <code class="docutils literal notranslate">NULL</code>, the module is associated with the new type and can later be

retrieved with <a class="reference internal" href="#c.PyType_GetModule" title="PyType_GetModule"><code class="xref c c-func docutils literal notranslate">PyType_GetModule()</code></a>.

The associated module is not inherited by subclasses; it must be specified

for each class individually.

This function calls <a class="reference internal" href="#c.PyType_Ready" title="PyType_Ready"><code class="xref c c-func docutils literal notranslate">PyType_Ready()</code></a> on the new type.

Note that this function does not fully match the behavior of

calling <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type()</code></a> or using the <a class="reference internal" href="../reference/compound_stmts.html#class"><code class="xref std std-keyword docutils literal notranslate">class</code></a> statement.

With user-provided base types or metaclasses, prefer

<a class="reference internal" href="call.html#capi-call">calling</a> <code class="xref py py-class docutils literal notranslate">type</code> (or the metaclass)

over <code class="docutils literal notranslate">PyType_From*</code> functions.

Specifically:

<li><a class="reference internal" href="../reference/datamodel.html#object.__new__" title="object.__new__"><code class="xref py py-meth docutils literal notranslate">__new__()</code></a> is not called on the new class

(and it must be set to <code class="docutils literal notranslate">type.__new__</code>).</li>

<li><a class="reference internal" href="../reference/datamodel.html#object.__init__" title="object.__init__"><code class="xref py py-meth docutils literal notranslate">__init__()</code></a> is not called on the new class.</li>

<li><a class="reference internal" href="../reference/datamodel.html#object.__init_subclass__" title="object.__init_subclass__"><code class="xref py py-meth docutils literal notranslate">__init_subclass__()</code></a> is not called on any bases.</li>

<li><a class="reference internal" href="../reference/datamodel.html#object.__set_name__" title="object.__set_name__"><code class="xref py py-meth docutils literal notranslate">__set_name__()</code></a> is not called on new descriptors.</li>

</ul>

Added in version 3.12.

</div>

</dd></dl>

<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *PyType_FromModuleAndSpec(<a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *module, <a class="reference internal" href="#c.PyType_Spec" title="PyType_Spec">PyType_Spec</a> *spec, <a class="reference internal" href="structures.html#c.PyObject" title="PyObject">PyObject</a> *bases)<a class="headerlink" href="#c.PyType_FromModuleAndSpec" title="Link to this definition">¶</a> </dt>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.10.Equivalent to <code class="docutils literal notranslate">PyType_FromMetaclass(NULL, module, spec, bases)</code>.

Added in version 3.9.

</div>

تغییر داده شده در نسخه 3.10: The function now accepts a single class as the bases argument and

<code class="docutils literal notranslate">NULL</code> as the <code class="docutils literal notranslate">tp_doc</code> slot.

</div>

تغییر داده شده در نسخه 3.12: The function now finds and uses a metaclass corresponding to the provided

base classes. Previously, only <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> instances were returned.

The <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> of the metaclass is ignored.

which may result in incomplete initialization.

Creating classes whose metaclass overrides

<code class="xref c c-member docutils literal notranslate">tp_new</code> is deprecated.

</div>

تغییر داده شده در نسخه 3.14: Creating classes whose metaclass overrides

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_new" title="PyTypeObject.tp_new"><code class="xref c c-member docutils literal notranslate">tp_new</code></a> is no longer allowed.

</div>

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.3.Equivalent to <code class="docutils literal notranslate">PyType_FromMetaclass(NULL, NULL, spec, bases)</code>.

Added in version 3.3.

</div>

تغییر داده شده در نسخه 3.12: The function now finds and uses a metaclass corresponding to the provided

which may result in incomplete initialization.

Creating classes whose metaclass overrides

<code class="xref c c-member docutils literal notranslate">tp_new</code> is deprecated.

</div>

تغییر داده شده در نسخه 3.14: Creating classes whose metaclass overrides

</div>

</dd></dl>

<dd>مقدار بازگشتی: مرجع جدید. قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a>.Equivalent to <code class="docutils literal notranslate">PyType_FromMetaclass(NULL, NULL, spec, NULL)</code>.

تغییر داده شده در نسخه 3.12: The function now finds and uses a metaclass corresponding to the

base classes provided in Py_tp_base[s] slots.

Previously, only <a class="reference internal" href="../library/functions.html#type" title="type"><code class="xref py py-class docutils literal notranslate">type</code></a> instances were returned.

which may result in incomplete initialization.

Creating classes whose metaclass overrides

<code class="xref c c-member docutils literal notranslate">tp_new</code> is deprecated.

</div>

تغییر داده شده در نسخه 3.14: Creating classes whose metaclass overrides

</div>

</dd></dl>

int PyType_Freeze(<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject">PyTypeObject</a> *type)<a class="headerlink" href="#c.PyType_Freeze" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.14.Make a type immutable: set the <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_IMMUTABLETYPE" title="Py_TPFLAGS_IMMUTABLETYPE"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_IMMUTABLETYPE</code></a> flag.

All base classes of type must be immutable.

On success, return <code class="docutils literal notranslate">0</code>.

On error, set an exception and return <code class="docutils literal notranslate">-1</code>.

The type must not be used before it's made immutable. For example, type

instances must not be created before the type is made immutable.

Added in version 3.14.

</div>

</dd></dl>

type PyType_Spec<a class="headerlink" href="#c.PyType_Spec" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> شامل تمام اعضا.Structure defining a type's behavior.

const char *name<a class="headerlink" href="#c.PyType_Spec.name" title="Link to this definition">¶</a> </dt>

<dd>Name of the type, used to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_name" title="PyTypeObject.tp_name"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_name</code></a>.

</dd></dl>

int basicsize<a class="headerlink" href="#c.PyType_Spec.basicsize" title="Link to this definition">¶</a> </dt>

<dd>If positive, specifies the size of the instance in bytes.

It is used to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_basicsize" title="PyTypeObject.tp_basicsize"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_basicsize</code></a>.

If zero, specifies that <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_basicsize" title="PyTypeObject.tp_basicsize"><code class="xref c c-member docutils literal notranslate">tp_basicsize</code></a>

should be inherited.

If negative, the absolute value specifies how much space instances of the

class need in addition to the superclass.

Use <a class="reference internal" href="object.html#c.PyObject_GetTypeData" title="PyObject_GetTypeData"><code class="xref c c-func docutils literal notranslate">PyObject_GetTypeData()</code></a> to get a pointer to subclass-specific

memory reserved this way.

For negative <code class="xref c c-member docutils literal notranslate">basicsize</code>, Python will insert padding when

needed to meet <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_basicsize" title="PyTypeObject.tp_basicsize"><code class="xref c c-member docutils literal notranslate">tp_basicsize</code></a>'s alignment

requirements.

تغییر داده شده در نسخه 3.12: Previously, this field could not be negative.

</div>

</dd></dl>

int itemsize<a class="headerlink" href="#c.PyType_Spec.itemsize" title="Link to this definition">¶</a> </dt>

<dd>Size of one element of a variable-size type, in bytes.

Used to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_itemsize" title="PyTypeObject.tp_itemsize"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_itemsize</code></a>.

See <code class="docutils literal notranslate">tp_itemsize</code> documentation for caveats.

If zero, <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_itemsize" title="PyTypeObject.tp_itemsize"><code class="xref c c-member docutils literal notranslate">tp_itemsize</code></a> is inherited.

Extending arbitrary variable-sized classes is dangerous,

since some types use a fixed offset for variable-sized memory,

which can then overlap fixed-sized memory used by a subclass.

To help prevent mistakes, inheriting <code class="docutils literal notranslate">itemsize</code> is only possible

in the following situations:

<li>The base is not variable-sized (its

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_itemsize" title="PyTypeObject.tp_itemsize"><code class="xref c c-member docutils literal notranslate">tp_itemsize</code></a>).</li>

<li>The requested <a class="reference internal" href="#c.PyType_Spec.basicsize" title="PyType_Spec.basicsize"><code class="xref c c-member docutils literal notranslate">PyType_Spec.basicsize</code></a> is positive,

suggesting that the memory layout of the base class is known.</li>

suggesting that the subclass does not access the instance's memory

directly.</li>

<li>With the <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_ITEMS_AT_END" title="Py_TPFLAGS_ITEMS_AT_END"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_ITEMS_AT_END</code></a> flag.</li>

</ul>

</dd></dl>

unsigned int flags<a class="headerlink" href="#c.PyType_Spec.flags" title="Link to this definition">¶</a> </dt>

<dd>Type flags, used to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_flags" title="PyTypeObject.tp_flags"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_flags</code></a>.

If the <code class="docutils literal notranslate">Py_TPFLAGS_HEAPTYPE</code> flag is not set,

<a class="reference internal" href="#c.PyType_FromSpecWithBases" title="PyType_FromSpecWithBases"><code class="xref c c-func docutils literal notranslate">PyType_FromSpecWithBases()</code></a> sets it automatically.

</dd></dl>

<a class="reference internal" href="#c.PyType_Slot" title="PyType_Slot">PyType_Slot</a> *slots<a class="headerlink" href="#c.PyType_Spec.slots" title="Link to this definition">¶</a> </dt>

<dd>Array of <a class="reference internal" href="#c.PyType_Slot" title="PyType_Slot"><code class="xref c c-type docutils literal notranslate">PyType_Slot</code></a> structures.

Terminated by the special slot value <code class="docutils literal notranslate">{0, NULL}</code>.

Each slot ID should be specified at most once.

</dd></dl>

type PyType_Slot<a class="headerlink" href="#c.PyType_Slot" title="Link to this definition">¶</a> </dt>

and a value pointer.

int slot<a class="headerlink" href="#c.PyType_Slot.slot" title="Link to this definition">¶</a> </dt>

<dd>A slot ID.

Slot IDs are named like the field names of the structures

<a class="reference internal" href="#c.PyTypeObject" title="PyTypeObject"><code class="xref c c-type docutils literal notranslate">PyTypeObject</code></a>, <a class="reference internal" href="typeobj.html#c.PyNumberMethods" title="PyNumberMethods"><code class="xref c c-type docutils literal notranslate">PyNumberMethods</code></a>,

<a class="reference internal" href="typeobj.html#c.PySequenceMethods" title="PySequenceMethods"><code class="xref c c-type docutils literal notranslate">PySequenceMethods</code></a>, <a class="reference internal" href="typeobj.html#c.PyMappingMethods" title="PyMappingMethods"><code class="xref c c-type docutils literal notranslate">PyMappingMethods</code></a> and

<a class="reference internal" href="typeobj.html#c.PyAsyncMethods" title="PyAsyncMethods"><code class="xref c c-type docutils literal notranslate">PyAsyncMethods</code></a> with an added <code class="docutils literal notranslate">Py_</code> prefix.

For example, use:

<li><a class="reference internal" href="typeobj.html#c.Py_tp_dealloc" title="Py_tp_dealloc"><code class="xref c c-data docutils literal notranslate">Py_tp_dealloc</code></a> to set <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dealloc" title="PyTypeObject.tp_dealloc"><code class="xref c c-member docutils literal notranslate">PyTypeObject.tp_dealloc</code></a></li>

<li><a class="reference internal" href="typeobj.html#c.Py_nb_add" title="Py_nb_add"><code class="xref c c-data docutils literal notranslate">Py_nb_add</code></a> to set <a class="reference internal" href="typeobj.html#c.PyNumberMethods.nb_add" title="PyNumberMethods.nb_add"><code class="xref c c-member docutils literal notranslate">PyNumberMethods.nb_add</code></a></li>

<li><a class="reference internal" href="typeobj.html#c.Py_sq_length" title="Py_sq_length"><code class="xref c c-data docutils literal notranslate">Py_sq_length</code></a> to set <a class="reference internal" href="typeobj.html#c.PySequenceMethods.sq_length" title="PySequenceMethods.sq_length"><code class="xref c c-member docutils literal notranslate">PySequenceMethods.sq_length</code></a></li>

</ul>

An additional slot is supported that does not correspond to a

<code class="xref c c-type docutils literal notranslate">PyTypeObject</code> struct field:

<li><a class="reference internal" href="#c.Py_tp_token" title="Py_tp_token"><code class="xref c c-data docutils literal notranslate">Py_tp_token</code></a></li>

</ul>

The following “offset” fields cannot be set using <a class="reference internal" href="#c.PyType_Slot" title="PyType_Slot"><code class="xref c c-type docutils literal notranslate">PyType_Slot</code></a>:

<li><a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_weaklistoffset" title="PyTypeObject.tp_weaklistoffset"><code class="xref c c-member docutils literal notranslate">tp_weaklistoffset</code></a>

(use <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_MANAGED_WEAKREF" title="Py_TPFLAGS_MANAGED_WEAKREF"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_MANAGED_WEAKREF</code></a> instead if possible)</li>

<li><a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dictoffset" title="PyTypeObject.tp_dictoffset"><code class="xref c c-member docutils literal notranslate">tp_dictoffset</code></a>

(use <a class="reference internal" href="typeobj.html#c.Py_TPFLAGS_MANAGED_DICT" title="Py_TPFLAGS_MANAGED_DICT"><code class="xref c c-macro docutils literal notranslate">Py_TPFLAGS_MANAGED_DICT</code></a> instead if possible)</li>

<li><a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_vectorcall_offset" title="PyTypeObject.tp_vectorcall_offset"><code class="xref c c-member docutils literal notranslate">tp_vectorcall_offset</code></a>

(use <code class="docutils literal notranslate">"__vectorcalloffset__"</code> in

<a class="reference internal" href="structures.html#pymemberdef-offsets">PyMemberDef</a>)</li>

</ul>

If it is not possible to switch to a <code class="docutils literal notranslate">MANAGED</code> flag (for example,

for vectorcall or to support Python older than 3.12), specify the

offset in <a class="reference internal" href="typeobj.html#c.Py_tp_members" title="Py_tp_members"><code class="xref c c-data docutils literal notranslate">Py_tp_members</code></a>.

See <a class="reference internal" href="structures.html#pymemberdef-offsets">PyMemberDef documentation</a>

for details.

The following internal fields cannot be set at all when creating a heap

type:

<li><a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_dict" title="PyTypeObject.tp_dict"><code class="xref c c-member docutils literal notranslate">tp_dict</code></a>,

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_mro" title="PyTypeObject.tp_mro"><code class="xref c c-member docutils literal notranslate">tp_mro</code></a>,

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_cache" title="PyTypeObject.tp_cache"><code class="xref c c-member docutils literal notranslate">tp_cache</code></a>,

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_subclasses" title="PyTypeObject.tp_subclasses"><code class="xref c c-member docutils literal notranslate">tp_subclasses</code></a>, and

<a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_weaklist" title="PyTypeObject.tp_weaklist"><code class="xref c c-member docutils literal notranslate">tp_weaklist</code></a>.</li>

</ul>

Setting <a class="reference internal" href="typeobj.html#c.Py_tp_bases" title="Py_tp_bases"><code class="xref c c-data docutils literal notranslate">Py_tp_bases</code></a> or <a class="reference internal" href="typeobj.html#c.Py_tp_base" title="Py_tp_base"><code class="xref c c-data docutils literal notranslate">Py_tp_base</code></a> may be

problematic on some platforms.

To avoid issues, use the bases argument of

تغییر داده شده در نسخه 3.9: Slots in <a class="reference internal" href="typeobj.html#c.PyBufferProcs" title="PyBufferProcs"><code class="xref c c-type docutils literal notranslate">PyBufferProcs</code></a> may be set in the unlimited API.

</div>

تغییر داده شده در نسخه 3.11: <a class="reference internal" href="typeobj.html#c.PyBufferProcs.bf_getbuffer" title="PyBufferProcs.bf_getbuffer"><code class="xref c c-member docutils literal notranslate">bf_getbuffer</code></a> and

<a class="reference internal" href="typeobj.html#c.PyBufferProcs.bf_releasebuffer" title="PyBufferProcs.bf_releasebuffer"><code class="xref c c-member docutils literal notranslate">bf_releasebuffer</code></a> are now available

under the <a class="reference internal" href="stable.html#limited-c-api">limited API</a>.

</div>

تغییر داده شده در نسخه 3.14: The field <a class="reference internal" href="typeobj.html#c.PyTypeObject.tp_vectorcall" title="PyTypeObject.tp_vectorcall"><code class="xref c c-member docutils literal notranslate">tp_vectorcall</code></a> can now be set

using <a class="reference internal" href="typeobj.html#c.Py_tp_vectorcall" title="Py_tp_vectorcall"><code class="xref c c-data docutils literal notranslate">Py_tp_vectorcall</code></a>. See the field's documentation

for details.

</div>

</dd></dl>

void *pfunc<a class="headerlink" href="#c.PyType_Slot.pfunc" title="Link to this definition">¶</a> </dt>

<dd>The desired value of the slot. In most cases, this is a pointer

to a function.

pfunc values may not be <code class="docutils literal notranslate">NULL</code>, except for the following slots:

<li><a class="reference internal" href="#c.Py_tp_token" title="Py_tp_token"><code class="xref c c-data docutils literal notranslate">Py_tp_token</code></a> (for clarity, prefer <a class="reference internal" href="#c.Py_TP_USE_SPEC" title="Py_TP_USE_SPEC"><code class="xref c c-data docutils literal notranslate">Py_TP_USE_SPEC</code></a>

rather than <code class="docutils literal notranslate">NULL</code>)</li>

</ul>

</dd></dl>

Py_tp_token<a class="headerlink" href="#c.Py_tp_token" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.14.A <a class="reference internal" href="#c.PyType_Slot.slot" title="PyType_Slot.slot"><code class="xref c c-member docutils literal notranslate">slot</code></a> that records a static memory layout ID

for a class.

If the <a class="reference internal" href="#c.PyType_Spec" title="PyType_Spec"><code class="xref c c-type docutils literal notranslate">PyType_Spec</code></a> of the class is statically

allocated, the token can be set to the spec using the special value

<a class="reference internal" href="#c.Py_TP_USE_SPEC" title="Py_TP_USE_SPEC"><code class="xref c c-data docutils literal notranslate">Py_TP_USE_SPEC</code></a>:

<div class="highlight-c notranslate"><div class="highlight"><pre>static PyType_Slot foo_slots[] = {

{Py_tp_token, Py_TP_USE_SPEC},

</pre></div>

</div>

It can also be set to an arbitrary pointer, but you must ensure that:

<li>The pointer outlives the class, so it's not reused for something else

while the class exists.</li>

<li>It "belongs" to the extension module where the class lives, so it will not

clash with other extensions.</li>

</ul>

Use <a class="reference internal" href="#c.PyType_GetBaseByToken" title="PyType_GetBaseByToken"><code class="xref c c-func docutils literal notranslate">PyType_GetBaseByToken()</code></a> to check if a class's superclass has

a given token -- that is, check whether the memory layout is compatible.

To get the token for a given class (without considering superclasses),

use <a class="reference internal" href="#c.PyType_GetSlot" title="PyType_GetSlot"><code class="xref c c-func docutils literal notranslate">PyType_GetSlot()</code></a> with <code class="docutils literal notranslate">Py_tp_token</code>.

Added in version 3.14.

</div>

Py_TP_USE_SPEC<a class="headerlink" href="#c.Py_TP_USE_SPEC" title="Link to this definition">¶</a> </dt>

<dd> قسمتی از <a class="reference internal" href="stable.html#stable">ABI پایدار</a> از نسخه‌ی 3.14.Used as a value with <a class="reference internal" href="#c.Py_tp_token" title="Py_tp_token"><code class="xref c c-data docutils literal notranslate">Py_tp_token</code></a> to set the token to the

class's <a class="reference internal" href="#c.PyType_Spec" title="PyType_Spec"><code class="xref c c-type docutils literal notranslate">PyType_Spec</code></a>.

Expands to <code class="docutils literal notranslate">NULL</code>.

Added in version 3.14.

</div>

</dd></dl>

</section>

</div>

<div>

<h3><a href="../contents.html">فهرست عناوین</a></h3>

<ul>

<li><a class="reference internal" href="#">Type Objects</a><ul>

<li><a class="reference internal" href="#creating-heap-allocated-types">Creating Heap-Allocated Types</a></li>

</ul>

</li>

</ul>

</div>

<div>

<h4>موضوع قبلی</h4>

<a href="concrete.html"

title="فصل قبلی">Concrete Objects Layer</a>

</div>

<div>

<h4>موضوع بعدی</h4>

<a href="none.html"

title="فصل بعدی">The <code class="docutils literal notranslate">None</code> Object</a>

</div>

document.addEventListener('DOMContentLoaded', () => {

const title = document.querySelector('meta[property="og:title"]').content;

const elements = document.querySelectorAll('.improvepage');

const pageurl = window.location.href.split('?')[0];

elements.forEach(element => {

const url = new URL(element.href.split('?')[0].replace("-nojs", ""));

url.searchParams.set('pagetitle', title);

url.searchParams.set('pageurl', pageurl);

url.searchParams.set('pagesource', "c-api/type.rst");

element.href = url.toString();

});

</script>

<li><a href="../bugs.html">گزارش یک اشکال</a></li>

<li><a class="improvepage" href="../improve-page-nojs.html">بهبود این صفحه</a></li>

<li>

<a href="https://github.com/python/cpython/blob/main/Doc/c-api/type.rst?plain=1"

rel="nofollow">نمایش منبع

</a>

</li>

<li>

<a href="https://github.com/python/python-docs-fa/blob/3.14/c-api/type.po?plain=1"

rel="nofollow">نمایش منبع ترجمه</a>

</li>

</ul>

</div>

«

View remainder of file in raw view

Navigation Menu

Uh oh!

Uh oh!

FilesExpand file tree

type.html

Latest commit

History

type.html

File metadata and controls